Notation used in Ruby API documentation
Module: rdb
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.
| new RdbCell ptr | new | Creates a new object of this class |
| [const] | RdbCell ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | add_reference | (const RdbReference ref) | Adds a reference to the references of this cell | |
| void | clear_references | Removes all references from this cell | ||
| [const] | const ReportDatabase ptr | database | Gets the database object that category is associated with | |
| ReportDatabase ptr | database | Gets the database object that category is associated with (non-const version) | ||
| [const,iter] | RdbItem | each_item | Iterates over all items inside the database which are associated with this cell | |
| [iter] | RdbItem | each_item | Iterates over all items inside the database which are associated with this cell (non-const version) | |
| [const,iter] | RdbReference | each_reference | Iterates over all references | |
| [iter] | RdbReference | each_reference | Iterates over all references (non-const version) | |
| [const] | string | layout_name | Gets the name of the layout cell | |
| [const] | string | name | Gets the cell name | |
| [const] | unsigned long | num_items | Gets the number of items for this cell | |
| [const] | unsigned long | num_items_visited | Gets the number of visited items for this cell | |
| [const] | string | qname | Gets the qualified name of the cell | |
| [const] | unsigned long | rdb_id | Gets the cell ID | |
| [const] | string | variant | Gets the cell variant name |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_const_cast | Signature: [const] RdbCell ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. | ||
_create | Signature: void _create Description: 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. | ||
_destroy | Signature: void _destroy Description: 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. | ||
_destroyed? | Signature: [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. | ||
_is_const_object? | Signature: [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. | ||
_manage | Signature: void _manage Description: 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. | ||
_unmanage | Signature: void _unmanage Description: 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. | ||
add_reference | Signature: void add_reference (const RdbReference ref) Description: Adds a reference to the references of this cell
| ||
clear_references | Signature: void clear_references Description: Removes all references from this cell | ||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead 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. | ||
database | (1) Signature: [const] const ReportDatabase ptr database Description: Gets the database object that category is associated with This method has been introduced in version 0.23. | ||
(2) Signature: ReportDatabase ptr database Description: Gets the database object that category is associated with (non-const version) This method has been introduced in version 0.29. | |||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead 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. | ||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead 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. | ||
each_item | (1) Signature: [const,iter] RdbItem each_item Description: Iterates over all items inside the database which are associated with this cell This method has been introduced in version 0.23. | ||
(2) Signature: [iter] RdbItem each_item Description: Iterates over all items inside the database which are associated with this cell (non-const version) This method has been introduced in version 0.29. | |||
each_reference | (1) Signature: [const,iter] RdbReference each_reference Description: Iterates over all references | ||
(2) Signature: [iter] RdbReference each_reference Description: Iterates over all references (non-const version) This method has been introduced in version 0.23. | |||
is_const_object? | Signature: [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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||
layout_name | Signature: [const] string layout_name Description: Gets the name of the layout cell
For variants, this string is the name of the actual layout cell. If empty, the cell is assume to be called 'name'. This read-only attribute has been added in version 0.29.1. | ||
name | Signature: [const] string name Description: 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 its variants. The "qualified name" contains both the cell name and the variant name. Cell names are also used to identify report database cells with layout cells. For variants, the layout cell name can be specified explicitly with the layout_name attribute (see RdbDatabase#create_cell). The latter is available since version 0.29.1. | ||
new | Signature: [static] new RdbCell ptr new Description: Creates a new object of this class Python specific notes: | ||
num_items | Signature: [const] unsigned long num_items Description: Gets the number of items for this cell | ||
num_items_visited | Signature: [const] unsigned long num_items_visited Description: Gets the number of visited items for this cell | ||
qname | Signature: [const] string qname Description: Gets the qualified name of the cell
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. | ||
rdb_id | Signature: [const] unsigned long rdb_id Description: 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. | ||
variant | Signature: [const] string variant Description: 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. |