API reference - Class RdbCell

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.

Public constructors

new RdbCell ptrnewCreates a new object of this class

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidadd_reference(const RdbReference ref)Adds a reference to the references of this cell
voidclear_referencesRemoves all references from this cell
[const]const ReportDatabase ptrdatabaseGets the database object that category is associated with
[const,iter]RdbItemeach_itemIterates over all items inside the database which are associated with this cell
[const,iter]RdbReferenceeach_referenceIterates over all references
[const]stringnameGets the cell name
[const]unsigned longnum_itemsGets the number of items for this cell
[const]unsigned longnum_items_visitedGets the number of visited items for this cell
[const]stringqnameGets the cell's qualified name
[const]unsigned longrdb_idGets the cell ID
[const]stringvariantGets the cell variant name

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_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

ref:The reference to add.

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

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.

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

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.

each_reference

Signature: [const,iter] RdbReference each_reference

Description: Iterates over all references

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.

name

Signature: [const] string name

Description: Gets the cell name

Returns: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 cell's with layout cells.

new

Signature: [static] new RdbCell ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.

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 cell's qualified name

Returns:The 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.

rdb_id

Signature: [const] unsigned long rdb_id

Description: Gets the cell ID

Returns: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

Returns: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.