Notation used in Ruby API documentation
Module: lay
Description: An object describing the instantiation of a single netlist object or a pair of those.
This class is basically a pair of netlist object paths (see NetlistObjectPath). When derived from a single netlist view, only the first path is valid and will point to the selected object (a net, a device or a circuit). The second path is null.
If the path is derived from a paired netlist view (a LVS report view), the first path corresponds to the object in the layout netlist, the second one to the object in the schematic netlist. If the selected object isn't a matched one, either the first or second path may be a null or a partial path without a final net or device object or a partial path.
To create a paired path from an existing object (net, device, circuit, subcircuit), use from_first and from_second. Use from_first, if the object belongs to the first netlist of the database ('netlist', layout netlist in the LVS context). Use from_second, if the object belongs to the second netlist of the database ('reference', schematic netlist in the LVS context).
It is also possible to create a paired path from a full path object (including root, a subcircuit path and a target object), either for the first or second side. Use from_first and from_second with a NetlistObjectPath argument in that case. A minimum requirement in that case is to set the root (the origin of the path). If no subcircuit path is given (see NetlistObjectPath#path), a suitable path leading from the target object (net or device) to the root will be constructed.
This class has been introduced in version 0.27 and has been extended in version 0.30.8.
| new NetlistObjectsPath ptr | new | Creates a new object of this class |
| [const] | NetlistObjectsPath 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 NetlistObjectsPath other) | Assigns another object to self | |
| [const] | new NetlistObjectsPath ptr | dup | Creates a copy of self | |
| [const] | NetlistObjectPath | first | Gets the first object's path. | |
| [const] | NetlistObjectPath | second | Gets the second object's path. |
| NetlistObjectsPath | from_first | (const NetlistObjectPath p) | Creates a path from given first coordinates. | |
| NetlistObjectsPath | from_first | (const Net ptr net) | Creates a path from a given net in the first netlist space. | |
| NetlistObjectsPath | from_first | (const Device ptr device) | Creates a path from a given device in the first netlist space. | |
| NetlistObjectsPath | from_first | (const Circuit ptr circuit) | Creates a path from a given circuit in the first netlist space. | |
| NetlistObjectsPath | from_first | (const SubCircuit ptr subcircuit) | Creates a path from a given subcircuit in the first netlist space. | |
| NetlistObjectsPath | from_second | (const NetlistObjectPath p) | Creates a path from given second coordinates. | |
| NetlistObjectsPath | from_second | (const Net ptr net) | Creates a path from a given net in the second netlist space. | |
| NetlistObjectsPath | from_second | (const Device ptr device) | Creates a path from a given device in the second netlist space. | |
| NetlistObjectsPath | from_second | (const Circuit ptr circuit) | Creates a path from a given circuit in the second netlist space. | |
| NetlistObjectsPath | from_second | (const SubCircuit ptr subcircuit) | Creates a path from a given subcircuit in the second netlist space. |
| 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] NetlistObjectsPath 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 NetlistObjectsPath 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. |
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 NetlistObjectsPath ptr dup Description: Creates a copy of self Python specific notes: |
first | Signature: [const] NetlistObjectPath first Description: Gets the first object's path. In cases of paired netlists (LVS database), the first path points to the layout netlist object. For the single netlist, the first path is the only path supplied. |
from_first | (1) Signature: [static] NetlistObjectsPath from_first (const NetlistObjectPath p) Description: Creates a path from given first coordinates. Use this constructor to create a paired path from a first set of coordinates (net, circuit, device). For single-sided databases (i.e. extracted netlist or schematic only), use the first coordinates. For two-sided database (i.e. LVS cross references), use the first coordinates when you refer to layout netlist objects. In this version, the minimum requirement for the path is to have a root. This constructor has been added in version 0.30.8. |
(2) Signature: [static] NetlistObjectsPath from_first (const Net ptr net) Description: Creates a path from a given net in the first netlist space. This constructor has been added in version 0.30.8. | |
(3) Signature: [static] NetlistObjectsPath from_first (const Device ptr device) Description: Creates a path from a given device in the first netlist space. This constructor has been added in version 0.30.8. | |
(4) Signature: [static] NetlistObjectsPath from_first (const Circuit ptr circuit) Description: Creates a path from a given circuit in the first netlist space. This constructor has been added in version 0.30.8. | |
(5) Signature: [static] NetlistObjectsPath from_first (const SubCircuit ptr subcircuit) Description: Creates a path from a given subcircuit in the first netlist space. This constructor has been added in version 0.30.8. | |
from_second | (1) Signature: [static] NetlistObjectsPath from_second (const NetlistObjectPath p) Description: Creates a path from given second coordinates. Use this constructor to create a paired path from a second set of coordinates (net, circuit, device). For two-sided database (i.e. LVS cross references), use the second coordinates when you refer to schematic netlist objects. In this version, the minimum requirement for the path is to have a root. This constructor has been added in version 0.30.8. |
(2) Signature: [static] NetlistObjectsPath from_second (const Net ptr net) Description: Creates a path from a given net in the second netlist space. This constructor has been added in version 0.30.8. | |
(3) Signature: [static] NetlistObjectsPath from_second (const Device ptr device) Description: Creates a path from a given device in the second netlist space. This constructor has been added in version 0.30.8. | |
(4) Signature: [static] NetlistObjectsPath from_second (const Circuit ptr circuit) Description: Creates a path from a given circuit in the second netlist space. This constructor has been added in version 0.30.8. | |
(5) Signature: [static] NetlistObjectsPath from_second (const SubCircuit ptr subcircuit) Description: Creates a path from a given subcircuit in the second netlist space. This constructor has been added in version 0.30.8. | |
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 NetlistObjectsPath ptr new Description: Creates a new object of this class Python specific notes: |
second | Signature: [const] NetlistObjectPath second Description: Gets the second object's path. In cases of paired netlists (LVS database), the first path points to the schematic netlist object. For the single netlist, the second path is always a null path. |