Notation used in Ruby API documentation
Module: db
Description: A connectivity description for the net tracer
This object represents the technology description for the net tracer (represented by the NetTracer class). A technology description basically consists of connection declarations. A connection is given by either two or three expressions describing two conductive materials. With two expressions, the connection describes a transition from one material to another one. With three expressions, the connection describes a transition from one material to another through a connection (a "via").
The conductive material is derived from original layers either directly or through boolean expressions. These expressions can include symbols which are defined through the symbol method.
For details about the expressions see the description of the net tracer feature.
This class has been introduced in version 0.28 and replaces the 'NetTracerTechnology' class which has been generalized.
| new NetTracerConnectivity ptr | new | Creates a new object of this class |
| 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 NetTracerConnectivity other) | Assigns another object to self | |
| void | connection | (string a, string b) | Defines a connection between two materials | |
| void | connection | (string a, string via, string b) | Defines a connection between materials through a via | |
| [const] | string | description | Gets the description text of the connectivty definition | |
| void | description= | (string d) | Sets the description of the connectivty definition | |
| [const] | new NetTracerConnectivity ptr | dup | Creates a copy of self | |
| [const,iter] | NetTracerConnectionInfo | each_connection | Gets the connection information. | |
| [const,iter] | NetTracerSymbolInfo | each_symbol | Gets the symbol information. | |
| [const] | string | name | Gets the name of the connectivty definition | |
| void | name= | (string n) | Sets the name of the connectivty definition | |
| void | symbol | (string name, string expr) | Defines a symbol for use in the material expressions. |
| 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 |
_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 NetTracerConnectivity other) Description: Assigns another object to self |
connection | (1) Signature: void connection (string a, string b) Description: Defines a connection between two materials See the class description for details about this method. |
(2) Signature: void connection (string a, string via, string b) Description: Defines a connection between materials through a via See the class description for details about this method. | |
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. |
description | Signature: [const] string description Description: Gets the description text of the connectivty definition The description is an optional string giving a human-readable description for this definition. Python specific notes: |
description= | Signature: void description= (string d) Description: Sets the description of the connectivty definition Python specific notes: |
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 NetTracerConnectivity ptr dup Description: Creates a copy of self Python specific notes: |
each_connection | Signature: [const,iter] NetTracerConnectionInfo each_connection Description: Gets the connection information. This iterator method has been introduced in version 0.28.3. |
each_symbol | Signature: [const,iter] NetTracerSymbolInfo each_symbol Description: Gets the symbol information. This iterator method has been introduced in version 0.28.3. |
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. |
name | Signature: [const] string name Description: Gets the name of the connectivty definition The name is an optional string defining the formal name for this definition. Python specific notes: |
name= | Signature: void name= (string n) Description: Sets the name of the connectivty definition Python specific notes: |
new | Signature: [static] new NetTracerConnectivity ptr new Description: Creates a new object of this class Python specific notes: |
symbol | Signature: void symbol (string name, string expr) Description: Defines a symbol for use in the material expressions. Defines a sub-expression to be used in further symbols or material expressions. For the detailed notation of the expression see the description of the net tracer feature. |