Notation used in Ruby API documentation
Module: pex
Description: Represents a network of resistors
The network is basically a graph with nodes and edges (the resistors). The resistors are called 'elements' and are represented by RElement objects. The nodes are represented by RNode objects. The network is created by RExtractor#extract, which turns a polygon into a resistor network.
This class has been introduced in version 0.30.2
| new RNetwork ptr | new | Creates a new object of this class |
| [const] | RNetwork 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 | clear | Clears the network | ||
| new RElement ptr | create_element | (double resistance, RNode ptr a, RNode ptr b) | Creates a new element between the nodes given by 'a' abd 'b'. | |
| new RNode ptr | create_node | (RNodeType type, unsigned int port_index, unsigned int layer = 0) | Creates a new node with the given type and index'. | |
| [iter] | new RElement ptr | each_element | Iterates the RElement objects inside the network | |
| [iter] | new RNode ptr | each_node | Iterates the RNode objects inside the network | |
| [const] | unsigned long | num_elements | Gets the number of elements in the network | |
| [const] | unsigned long | num_internal_nodes | Gets the number of internal nodes in the network | |
| [const] | unsigned long | num_nodes | Gets the total number of nodes in the network | |
| void | remove_element | (RElement ptr element) | Removes the given element | |
| void | remove_node | (RNode ptr node) | Removes the given node | |
| void | simplify | Simplifies the network | ||
| [const] | string | to_s | (bool with_coords = false) | Returns a string representation of the network |
| 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] RNetwork 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. | ||
clear | Signature: void clear Description: Clears the network | ||
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. | ||
create_element | Signature: new RElement ptr create_element (double resistance, RNode ptr a, RNode ptr b) Description: Creates a new element between the nodes given by 'a' abd 'b'.
If a resistor already exists between the two nodes, both resistors are combined into one. | ||
create_node | Signature: new RNode ptr create_node (RNodeType type, unsigned int port_index, unsigned int layer = 0) Description: Creates a new node with the given type and index'.
| ||
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. | ||
each_element | Signature: [iter] new RElement ptr each_element Description: Iterates the RElement objects inside the network | ||
each_node | Signature: [iter] new RNode ptr each_node Description: Iterates the RNode objects inside the network | ||
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 RNetwork ptr new Description: Creates a new object of this class Python specific notes: | ||
num_elements | Signature: [const] unsigned long num_elements Description: Gets the number of elements in the network | ||
num_internal_nodes | Signature: [const] unsigned long num_internal_nodes Description: Gets the number of internal nodes in the network | ||
num_nodes | Signature: [const] unsigned long num_nodes Description: Gets the total number of nodes in the network | ||
remove_element | Signature: void remove_element (RElement ptr element) Description: Removes the given element If removing the element renders an internal node orphan (i.e. without elements), this node is removed too. | ||
remove_node | Signature: void remove_node (RNode ptr node) Description: Removes the given node Only internal nodes can be removed. Removing a node will also remove the elements attached to this node. | ||
simplify | Signature: void simplify Description: Simplifies the network This will:
| ||
to_s | Signature: [const] string to_s (bool with_coords = false) Description: Returns a string representation of the network Nodes are printed with coordinates with 'with_coords' is true. Python specific notes: |