Notation used in Ruby API documentation
Module: pex
Description: Represents a node in a R network graph
See RNetwork for a description of this object
This class has been introduced in version 0.30.2
| new RNode ptr | new | Creates a new object of this class |
| [const] | RNode 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 RNode other) | Assigns another object to self | |
| [const] | new RNode ptr | dup | Creates a copy of self | |
| [iter] | new RElement ptr | each_element | Iterates the RElement objects attached to the node | |
| [const] | unsigned int | layer | Gets the Layer ID of the node | |
| [const] | DBox | location | Gets the location attribute of the node | |
| [const] | unsigned long | object_id | Returns an ID representing the actual object | |
| [const] | unsigned int | port_index | Gets the port index of the node | |
| [const] | string | to_s | (bool with_coords = false) | Returns a string representation of this object |
| [const] | RNodeType | type | Gets the type attribute of the node |
| [static,const] | RNodeType | Internal | Specifies an internal node in a R network | |
| [static,const] | RNodeType | PolygonPort | Specifies a polygon port node in a R network | |
| [static,const] | RNodeType | VertexPort | Specifies a vertex port node in a R 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 |
Internal | Signature: [static,const] RNodeType Internal Description: Specifies an internal node in a R network Internal nodes are generated during the R extraction process. The port index of such a node is an arbitrary index. Python specific notes: |
PolygonPort | Signature: [static,const] RNodeType PolygonPort Description: Specifies a polygon port node in a R network Polygon port nodes are generated for polygon ports in RExtractor#extract, see 'polygon_ports' argument. The port index of such a node refers to the position in that list. Python specific notes: |
VertexPort | Signature: [static,const] RNodeType VertexPort Description: Specifies a vertex port node in a R network Vertex port nodes are generated for vertex ports in RExtractor#extract, see 'vertex_ports' argument. The port index of such a node refers to the position in that list. Python specific notes: |
_const_cast | Signature: [const] RNode 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 RNode 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 RNode ptr dup Description: Creates a copy of self Python specific notes: |
each_element | Signature: [iter] new RElement ptr each_element Description: Iterates the RElement objects attached to the node |
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 ID of the node The port index associates a node with a original port definition layer-wise. |
location | Signature: [const] DBox location Description: Gets the location attribute of the node The location defined the original position of the node |
new | Signature: [static] new RNode ptr new Description: Creates a new object of this class Python specific notes: |
object_id | Signature: [const] unsigned long object_id Description: Returns an ID representing the actual object For every call, a new instance of this object is created, while multiple ones may represent the same internal object. The 'object_id' is a ID that indicates the internal object. Same object_id means same node. |
port_index | Signature: [const] unsigned int port_index Description: Gets the port index of the node The port index associates a node with a original port definition. |
to_s | Signature: [const] string to_s (bool with_coords = false) Description: Returns a string representation of this object Nodes are printed with coordinates with 'with_coords' is true. Python specific notes: |
type | Signature: [const] RNodeType type Description: Gets the type attribute of the node |