API reference - Class RdbCellNotation used in Ruby API documentation Description: A cell inside the report database This class represents a cell in the report database. There is not necessarily a 1:1 correspondence of RDB cells and layout database cells. Cells have an ID, a name, optionally a variant name and a set of references which describe at least one example instantiation in some parent cell. The references do not necessarily map to references or cover all references in the layout database. Public methods
Detailed descriptionvoid add_reference(const RdbReference ref)Description: Adds a reference to the references of this cell
void clear_referencesDescription: Removes all references from this cell void 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. 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 cell This method has been introduced in version 0.23. [const,iter] RdbReference each_referenceDescription: Iterates over all references [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 cell name
The cell name is an string that identifies the category in the database. Additionally, a cell may carry a variant identifier which is a string that uniquely identifies a cell in the context of it's variants. The "qualified name" contains both the cell name and the variant name. Cell names are also used to identify report database cell's with layout cells. [const] unsigned int num_itemsDescription: Gets the number of items for this cell [const] unsigned int num_items_visitedDescription: Gets the number of visited items for this cell [const] string qnameDescription: Gets the cell's qualified name
The qualified name is a combination of the cell name and optionally the variant name. It is used to identify the cell by name in a unique way. [const] unsigned int rdb_idDescription: Gets the cell ID
The cell ID is an integer that uniquely identifies the cell. It is used for referring to a cell in RdbItem for example. [const] string variantDescription: Gets the cell variant name
A variant name additionally identifies the cell when multiple cells with the same name are present. A variant name is either assigned automatically or set when creating a cell. |