Class RdbCell (version 0.20)

Description: A report database cell representation

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.

Class overview

Index

Method Overview

[const] unsigned int rdb_id	Gets the cell ID
[const] string name	Gets the cell name
[const] string variant	Gets the cell variant name
[const] string qname	Gets the cell's qualified name
[const] unsigned int num_items	Gets the number of items for this cell
[const] unsigned int num_items_visited	Gets the number of visited items for this cell
add_reference( RdbReference ref )	Adds a reference to the references of this cell
clear_references	Removes all references from this cell
yield ref RdbReference each_reference	Iterates over all references
destroy	Explicitly destroy the object
[const] bool destroyed	Tell, if the object was destroyed

add_reference( RdbReference ref )

Description: Adds a reference to the references of this cell

ref:	The reference to add.

clear_references

Description: Removes all references from this cell

destroy

Description: 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: 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 RdbReference each_reference

Description: Iterates over all references

[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 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.

returns:

The cell name

[const] unsigned int num_items

Description: Gets the number of items for this cell

[const] unsigned int num_items_visited

Description: Gets the number of visited items for this cell

[const] string qname

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

returns:

The qualified name

[const] unsigned int 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.

returns:

The cell ID

[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.

returns:

The cell variant name