Notation used in Ruby API documentation
Module: pex
Description: The network R extractor class
This class provides the algorithms for extracting a R network from a multi-layer arrangement of conductors and vias. The main feature is the extract method. It takes a multi-layer geometry, a tech stack and a number of port definitions and returns a R network. The nodes in that network are annotated, so the corresponding port can be deduced from a node of VertexPort or PolygonPort type.
Layers are given by layer indexes - those are generic IDs. Every layer has to be given a unique ID, which must be used throughout the different specifications (geometry, vias, conductors, ports).
Two kind of ports are provided: point-like vertex ports and polygon ports. Polygons for polygon ports should be convex and sit inside the geometry they mark. Ports become nodes in the network. Beside ports, the network can have internal nodes. Nodes are annotated with a type (vertex, polygon, internal) and an index and layer. The layer is the layer ID, the index specifies the position of the corresponding port in the 'vertex_ports' or 'polygon_ports' list of the extract call.
This class has been introduced in version 0.30.2
| new RNetExtractor ptr | new | (double dbu) | Creates a network R extractor |
| [const] | RNetExtractor 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 RNetExtractor other) | Assigns another object to self | |
| [const] | new RNetExtractor ptr | dup | Creates a copy of self | |
| new RNetwork ptr | extract | (const RExtractorTech ptr tech_stack, map<unsigned int,Region> ptr geo, map<unsigned int,Point[]> ptr vertex_ports, map<unsigned int,Polygon[]> ptr polygon_ports) | Runs the extraction on the given multi-layer geometry |
| 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] RNetExtractor 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 RNetExtractor 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 RNetExtractor ptr dup Description: Creates a copy of self Python specific notes: | ||||||
extract | Signature: new RNetwork ptr extract (const RExtractorTech ptr tech_stack, map<unsigned int,Region> ptr geo, map<unsigned int,Point[]> ptr vertex_ports, map<unsigned int,Polygon[]> ptr polygon_ports) Description: Runs the extraction on the given multi-layer geometry See the description of the class for more details. | ||||||
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 RNetExtractor ptr new (double dbu) Description: Creates a network R extractor
Python specific notes: |