API reference - Class RdbCategoryNotation used in Ruby API documentation Description: A category inside the report database Every item in the report database is assigned to a category. A category is a DRC rule check for example. Categories can be organised hierarchically, i.e. a category may have sub-categories. Item counts are summarized for categories and items belonging to sub-categories of one category can be browsed together for example. As a general rule, categories not being leaf categories (having child categories) may not have items. Public methods
Detailed descriptionvoid createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. [const] const ReportDatabase ptr databaseDescription: Gets the database object that category is associated with This method has been introduced in version 0.23. [const] string descriptionDescription: Gets the category description
void description=(string description)Description: Sets the category description
void destroyDescription: Explicitly destroy the object Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing. [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. [const,iter] RdbItem each_itemDescription: Iterates over all iterms inside the database which are associated with this category This method has been introduced in version 0.23. [iter] RdbCategory each_sub_categoryDescription: Iterates over all sub-categories [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. [const] string nameDescription: Gets the category name
The category name is an string that identifies the category in the context of a parent category or inside the database when it is a top level category. The name is not the path name which is a path to a child category and incorporates all names of parent categories. [const] unsigned int num_itemsDescription: Gets the number of items in this category The number of items includes the items in sub-categories of this category. [const] unsigned int num_items_visitedDescription: Gets the number of visited items in this category The number of items includes the items in sub-categories of this category. RdbCategory ptr parentDescription: Gets the parent category of this category
[const] string pathDescription: Gets the category path
The category path is the category name for top level categories. For child categories, the path contains the names of all parent categories separated by a dot. [const] unsigned int rdb_idDescription: Gets the category ID
The category ID is an integer that uniquely identifies the category. It is used for referring to a category in RdbItem for example. void scan_layer(const Layout layout,unsigned int layer)Description: Scans a layer from a layout into this category Creates RDB items for each shape read from the each cell in the layout on the given layer and puts them into this category. New cells will be generated for every cell encountered in the layout. Other settings like database unit, description, top cell etc. are not made in the RDB. This method has been introduced in version 0.23. void scan_layer(const Layout layout,unsigned int layer,const Cell ptr cell)Description: Scans a layer from a layout into this category, starting with a given cell Creates RDB items for each shape read from the cell and it's children in the layout on the given layer and puts them into this category. New cells will be generated when required. Other settings like database unit, description, top cell etc. are not made in the RDB. This method has been introduced in version 0.23. void scan_layer(const Layout layout,unsigned int layer,const Cell ptr cell,int levels)Description: Scans a layer from a layout into this category, starting with a given cell and a depth specification Creates RDB items for each shape read from the cell and it's children in the layout on the given layer and puts them into this category. New cells will be generated when required. "levels" is the number of hierarchy levels to take the child cells from. 0 means to use only "cell" and don't descend, -1 means "all levels". Other settings like database unit, description, top cell etc. are not made in the RDB. This method has been introduced in version 0.23. void scan_shapes(const RecursiveShapeIterator iter)Description: Scans the shapes from the shape iterator into the category Creates RDB items for each shape read from the iterator and puts them into this category. This method has been introduced in version 0.23. |