Notation used in Ruby API documentation
Module: db
Description: A geometrical device abstract
This class represents the geometrical model for the device. It links into the extracted layout to a cell which holds the terminal shapes for the device.
This class has been added in version 0.26.
new DeviceAbstract ptr | new | Creates a new object of this class |
[const] | DeviceAbstract 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 DeviceAbstract other) | Assigns another object to self | |
[const] | unsigned int | cell_index | Gets the cell index of the device abstract. | |
[const] | unsigned long | cluster_id_for_terminal | (unsigned long terminal_id) | Gets the cluster ID for the given terminal. |
[const] | const DeviceClass ptr | device_class | Gets the device class of the device. | |
[const] | new DeviceAbstract ptr | dup | Creates a copy of self | |
[const] | string | name | Gets the name of the device abstract. | |
void | name= | (string name) | Sets the name of the device abstract. | |
[const] | const Netlist ptr | netlist | Gets the netlist the device abstract lives in. | |
Netlist ptr | netlist | Gets the netlist the device abstract lives in (non-const version). |
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] DeviceAbstract 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 DeviceAbstract other) Description: Assigns another object to self |
cell_index | Signature: [const] unsigned int cell_index Description: Gets the cell index of the device abstract. This is the cell that represents the device. |
cluster_id_for_terminal | Signature: [const] unsigned long cluster_id_for_terminal (unsigned long terminal_id) Description: Gets the cluster ID for the given terminal. The cluster ID links the terminal to geometrical shapes within the clusters of the cell (see cell_index) |
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. |
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. |
device_class | Signature: [const] const DeviceClass ptr device_class Description: Gets the device class of the device. |
dup | Signature: [const] new DeviceAbstract 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. |
name | Signature: [const] string name Description: Gets the name of the device abstract. Python specific notes: |
name= | Signature: void name= (string name) Description: Sets the name of the device abstract. Device names are used to name a device abstract inside a netlist file. Device names should be unique within a netlist. Python specific notes: |
netlist | (1) Signature: [const] const Netlist ptr netlist Description: Gets the netlist the device abstract lives in. |
(2) Signature: Netlist ptr netlist Description: Gets the netlist the device abstract lives in (non-const version). This constness variant has been introduced in version 0.26.8 | |
new | Signature: [static] new DeviceAbstract ptr new Description: Creates a new object of this class Python specific notes: |