Notation used in Ruby API documentation
Module: pex
Description: Specifies the tech stack for the R extraction.
The tech stack is a collection of via and conductor definitions and some other attributes. It is used for the RNetExtractor#extract method.
This enum has been introduced in version 0.30.2.
| new RExtractorTech ptr | new | Creates a new object of this class |
| [const] | RExtractorTech 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 | add_conductor | (const RExtractorTechConductor conductor) | Adds the given conductor definition to the list of conductors | |
| void | add_via | (const RExtractorTechVia via) | Adds the given via definition to the list of vias | |
| void | assign | (const RExtractorTech other) | Assigns another object to self | |
| void | clear_conductors | Clears the list of conductor definitions | ||
| void | clear_vias | Clears the list of via definitions | ||
| [const] | new RExtractorTech ptr | dup | Creates a copy of self | |
| [const,iter] | RExtractorTechConductor | each_conductor | Iterates the list of conductor definitions | |
| [const,iter] | RExtractorTechVia | each_via | Iterates the list of via definitions | |
| [const] | bool | skip_simplify | Gets a value indicating whether to skip the simplify step | |
| void | skip_simplify= | (bool f) | Sets a value indicating whether to skip the simplify step | |
| [const] | string | to_s | Returns a string describing this object |
| 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] RExtractorTech 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. |
add_conductor | Signature: void add_conductor (const RExtractorTechConductor conductor) Description: Adds the given conductor definition to the list of conductors |
add_via | Signature: void add_via (const RExtractorTechVia via) Description: Adds the given via definition to the list of vias |
assign | Signature: void assign (const RExtractorTech other) Description: Assigns another object to self |
clear_conductors | Signature: void clear_conductors Description: Clears the list of conductor definitions |
clear_vias | Signature: void clear_vias Description: Clears the list of via definitions |
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 RExtractorTech ptr dup Description: Creates a copy of self Python specific notes: |
each_conductor | Signature: [const,iter] RExtractorTechConductor each_conductor Description: Iterates the list of conductor definitions |
each_via | Signature: [const,iter] RExtractorTechVia each_via Description: Iterates the list of via definitions |
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 RExtractorTech ptr new Description: Creates a new object of this class Python specific notes: |
skip_simplify | Signature: [const] bool skip_simplify Description: Gets a value indicating whether to skip the simplify step This values specifies to skip the simplify step of the network after the extraction has been done. By default, the network is simplified - i.e. serial resistors are joined etc. By setting this attribute to 'false', this step is skipped. Python specific notes: |
skip_simplify= | Signature: void skip_simplify= (bool f) Description: Sets a value indicating whether to skip the simplify step See skip_simplify 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: |