Notation used in Ruby API documentation
Module: rdb
Description: A cell reference inside the report database
This class describes a cell reference. Such reference object can be attached to cells to describe instantiations of them in parent cells. Not necessarily all instantiations of a cell in the layout database are represented by references and in some cases there might even be no references at all. The references are merely a hint how a marker must be displayed in the context of any other, potentially parent, cell in the layout database.
| new RdbReference ptr | new | (const DCplxTrans trans, unsigned long parent_cell_id) | Creates a reference with a given transformation and parent cell ID |
| [const] | RdbReference 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 | assign | (const RdbReference other) | Assigns another object to self | |
| [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] | new RdbReference ptr | dup | Creates a copy of self | |
| [const] | unsigned long | parent_cell_id | Gets parent cell ID for this reference | |
| void | parent_cell_id= | (unsigned long id) | Sets the parent cell ID for this reference | |
| [const] | DCplxTrans | trans | Gets the transformation for this reference | |
| void | trans= | (const DCplxTrans trans) | Sets the transformation for this reference |
| 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] RdbReference 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. | ||
assign | Signature: void assign (const RdbReference other) Description: Assigns another object to self | ||
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. | ||
dup | Signature: [const] new RdbReference ptr dup Description: Creates a copy of self Python specific notes: | ||
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. | ||
new | Signature: [static] new RdbReference ptr new (const DCplxTrans trans, unsigned long parent_cell_id) Description: Creates a reference with a given transformation and parent cell ID Python specific notes: | ||
parent_cell_id | Signature: [const] unsigned long parent_cell_id Description: Gets parent cell ID for this reference
Python specific notes: | ||
parent_cell_id= | Signature: void parent_cell_id= (unsigned long id) Description: Sets the parent cell ID for this reference Python specific notes: | ||
trans | Signature: [const] DCplxTrans trans Description: Gets the transformation for this reference
The transformation describes the transformation of the child cell into the parent cell. In that sense that is the usual transformation of a cell reference. Python specific notes: | ||
trans= | Signature: void trans= (const DCplxTrans trans) Description: Sets the transformation for this reference Python specific notes: |