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 constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
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. void _destroyDescription: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, 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] 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. void _manageDescription: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. void _unmanageDescription: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. void 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 of this method is deprecated. Use _create instead [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 destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [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 Use of this method is deprecated. Use _is_const_object? instead [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. [static] new RdbCell ptr newDescription: Creates a new object of this class Python specific notes:This method is the default initializer of the object [const] unsigned long num_itemsDescription: Gets the number of items for this cell [const] unsigned long 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 long 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. |