Class RdbCategory (version 0.20)Description: The report database category 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.
Method Overview
[const] string descriptionDescription: Gets the category description
description=( string description )Description: Sets the category description
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 destroyedDescription: Tell, if the object was 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.
yield ref RdbCategory each_sub_categoryDescription: Iterates over all sub-categories
[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.
ref RdbCategory 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.
|