API reference - Class RExtractorTechVia

_const_cast

Signature: [const] RExtractorTechVia 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 RExtractorTechVia other)

Description: Assigns another object to self

bottom_conductor

Signature: [const] unsigned int bottom_conductor

Description: Gets the bottom conductor layer index

The layer index is a generic identifier for the layer. It is the value used as key in the geometry and port arguments of RNetExtractor#extract.

Python specific notes:
The object exposes a readable attribute 'bottom_conductor'. This is the getter.

bottom_conductor=

Signature: void bottom_conductor= (unsigned int l)

Description: Sets the via bottom conductor layer index

See bottom_conductor for a description of this attribute.

Python specific notes:
The object exposes a writable attribute 'bottom_conductor'. This is the setter.

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.

cut_layer

Signature: [const] unsigned int cut_layer

Description: Gets the cut layer index

The layer index is a generic identifier for the layer. It is the value used as key in the geometry and port arguments of RNetExtractor#extract. The cut layer is the layer where the via exists.

Python specific notes:
The object exposes a readable attribute 'cut_layer'. This is the getter.

cut_layer=

Signature: void cut_layer= (unsigned int l)

Description: Sets the cut layer index

See cut_layer for a description of this attribute.

Python specific notes:
The object exposes a writable attribute 'cut_layer'. This is the setter.

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 RExtractorTechVia ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

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.

merge_distance

Signature: [const] double merge_distance

Description: Gets the merge distance

If this value is not zero, it specifies the distance below (or equal) which vias are merged into bigger blocks. This is an optimization to reduce the complexity of the via extraction. The value is given in micrometers.

Python specific notes:
The object exposes a readable attribute 'merge_distance'. This is the getter.

merge_distance=

Signature: void merge_distance= (double d)

Description: Sets the merge distance

See merge_distance for a description of this attribute.

Python specific notes:
The object exposes a writable attribute 'merge_distance'. This is the setter.

new

Signature: [static] new RExtractorTechVia ptr new

Description: Creates a new object of this class

Python specific notes:
This method is the default initializer of the object.

resistance

Signature: [const] double resistance

Description: Gets the area resistance value of the vias

This value specifies the via resistance in Ohm * square micrometers. The actual resistance is obtained by dividing this value by the via area.

Python specific notes:
The object exposes a readable attribute 'resistance'. This is the getter.

resistance=

Signature: void resistance= (double d)

Description: Sets the via area resistance value

See resistance for a description of this attribute.

Python specific notes:
The object exposes a writable attribute 'resistance'. This is the setter.

to_s

Signature: [const] string to_s

Description: Returns a string describing this object

Python specific notes:
This method is also available as 'str(object)'.

top_conductor

Signature: [const] unsigned int top_conductor

Description: Gets the top conductor layer index

The layer index is a generic identifier for the layer. It is the value used as key in the geometry and port arguments of RNetExtractor#extract.

Python specific notes:
The object exposes a readable attribute 'top_conductor'. This is the getter.

top_conductor=

Signature: void top_conductor= (unsigned int l)

Description: Sets the via top conductor layer index

See top_conductor for a description of this attribute.

Python specific notes:
The object exposes a writable attribute 'top_conductor'. This is the setter.