Notation used in Ruby API documentation
Module: pex
Description: Describes a conductor layer for the network extraction.
This class is used to describe a conductor layer in the context of the RExtractorTech class.
This class has been introduced in version 0.30.2.
| new RExtractorTechConductor ptr | new | Creates a new object of this class |
| [const] | RExtractorTechConductor 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. | ||
| [const] | Algorithm | algorithm | Gets the algorithm to use | |
| void | algorithm= | (Algorithm d) | Sets the algorithm to use | |
| void | assign | (const RExtractorTechConductor other) | Assigns another object to self | |
| [const] | new RExtractorTechConductor ptr | dup | Creates a copy of self | |
| [const] | unsigned int | layer | Gets the layer index | |
| void | layer= | (unsigned int l) | Sets the layer index | |
| [const] | double | resistance | Gets the sheet resistance value of the conductor layer | |
| void | resistance= | (double r) | Sets the sheet resistance value of the conductor layer | |
| [const] | string | to_s | Returns a string describing this object | |
| [const] | double | triangulation_max_area | Gets the triangulation 'max_area' parameter | |
| void | triangulation_max_area= | (double max_area) | Sets the triangulation 'max_area' parameter | |
| [const] | double | triangulation_min_b | Gets the triangulation 'min_b' parameter | |
| void | triangulation_min_b= | (double min_b) | Sets the triangulation 'min_b' parameter |
| [static,const] | Algorithm | SquareCounting | Specifies the square counting algorithm for RExtractorTechConductor#algorithm. | |
| [static,const] | Algorithm | Tesselation | Specifies the square counting algorithm for RExtractorTechConductor#algorithm. |
| 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 |
SquareCounting | Signature: [static,const] Algorithm SquareCounting Description: Specifies the square counting algorithm for RExtractorTechConductor#algorithm. See RExtractor#square_counting_extractor for more details. Python specific notes: |
Tesselation | Signature: [static,const] Algorithm Tesselation Description: Specifies the square counting algorithm for RExtractorTechConductor#algorithm. See RExtractor#tesselation_extractor for more details. Python specific notes: |
_const_cast | Signature: [const] RExtractorTechConductor 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. |
algorithm | Signature: [const] Algorithm algorithm Description: Gets the algorithm to use Specifies the algorithm to use. The default algorithm is 'SquareCounting'. Python specific notes: |
algorithm= | Signature: void algorithm= (Algorithm d) Description: Sets the algorithm to use See algorithm for a description of this attribute. Python specific notes: |
assign | Signature: void assign (const RExtractorTechConductor 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 RExtractorTechConductor 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. |
layer | Signature: [const] unsigned int layer Description: Gets the layer index The layer index is a generic identifier for the layer. It is the value used as key in the geometry and port arguments of RNetExtractor#extract. This attribute specifies the layer the conductor is on. Python specific notes: |
layer= | Signature: void layer= (unsigned int l) Description: Sets the layer index See layer for a description of this attribute. Python specific notes: |
new | Signature: [static] new RExtractorTechConductor ptr new Description: Creates a new object of this class Python specific notes: |
resistance | Signature: [const] double resistance Description: Gets the sheet resistance value of the conductor layer This value specifies the cond resistance in Ohm per square. The actual resistance is obtained by multiplying this value with the number of squares. Python specific notes: |
resistance= | Signature: void resistance= (double r) Description: Sets the sheet resistance value of the conductor layer See resistance for a description of this attribute. Python specific notes: |
to_s | Signature: [const] string to_s Description: Returns a string describing this object Python specific notes: |
triangulation_max_area | Signature: [const] double triangulation_max_area Description: Gets the triangulation 'max_area' parameter This parameter is used for the 'Tesselation' algorithm and specifies the maximum area of the triangles in square micrometers. Python specific notes: |
triangulation_max_area= | Signature: void triangulation_max_area= (double max_area) Description: Sets the triangulation 'max_area' parameter See triangulation_max_area for a description of this attribute. Python specific notes: |
triangulation_min_b | Signature: [const] double triangulation_min_b Description: Gets the triangulation 'min_b' parameter This parameter is used for the 'Tesselation' algorithm and specifies the shortest edge to circle radius ratio of the Delaunay triangulation. Python specific notes: |
triangulation_min_b= | Signature: void triangulation_min_b= (double min_b) Description: Sets the triangulation 'min_b' parameter See triangulation_min_b for a description of this attribute. Python specific notes: |