API reference - Class NetlistDeviceExtractorError

Notation used in Ruby API documentation

Module: db

Description: An error that occurred during device extraction

The device extractor will keep errors that occurred during extraction of the devices. It does not by using this error class.

An error is basically described by the cell/circuit it occurs in and the message. In addition, a geometry may be attached forming a marker that can be shown when the error is selected. The geometry is given as a DPolygon object. If no geometry is specified, this polygon is empty.

For categorization of the errors, a category name and description may be specified. If given, the errors will be shown in the specified category. The category description is optional.

This class has been introduced in version 0.26.

Public constructors

new NetlistDeviceExtractorError ptrnewCreates a new object of this class

Public methods

void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const NetlistDeviceExtractorError other)Assigns another object to self
[const]stringcategory_descriptionGets the category description.
voidcategory_description=(string description)Sets the category description.
[const]stringcategory_nameGets the category name.
voidcategory_name=(string name)Sets the category name.
[const]stringcell_nameGets the cell name.
voidcell_name=(string cell_name)Sets the cell name.
[const]new NetlistDeviceExtractorError ptrdupCreates a copy of self
[const]DPolygongeometryGets the geometry.
voidgeometry=(const DPolygon polygon)Sets the geometry.
[const]stringmessageGets the message text.
voidmessage=(string message)Sets the message text.

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_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 NetlistDeviceExtractorError other)

Description: Assigns another object to self

category_description

Signature: [const] string category_description

Description: Gets the category description.

See category_name= for details about categories.

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

category_description=

Signature: void category_description= (string description)

Description: Sets the category description.

See category_name= for details about categories.

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

category_name

Signature: [const] string category_name

Description: Gets the category name.

See category_name= for more details.

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

category_name=

Signature: void category_name= (string name)

Description: Sets the category name.

The category name is optional. If given, it specifies a formal category name. Errors with the same category name are shown in that category. If in addition a category description is specified (see category_description), this description will be displayed as the title of.

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

cell_name

Signature: [const] string cell_name

Description: Gets the cell name.

See cell_name= for details about this attribute.

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

cell_name=

Signature: void cell_name= (string cell_name)

Description: Sets the cell name.

The cell name is the name of the layout cell which was treated. This is also the name of the circuit the device should have appeared in (it may be dropped because of this error). If netlist hierarchy manipulation happens however, the circuit may not exist any longer or may be renamed.

Python specific notes:
The object exposes a writable attribute 'cell_name'. 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.

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

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__'

geometry

Signature: [const] DPolygon geometry

Description: Gets the geometry.

See geometry= for more details.

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

geometry=

Signature: void geometry= (const DPolygon polygon)

Description: Sets the geometry.

The geometry is optional. If given, a marker will be shown when selecting this error.

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

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.

message

Signature: [const] string message

Description: Gets the message text.

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

message=

Signature: void message= (string message)

Description: Sets the message text.

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

new

Signature: [static] new NetlistDeviceExtractorError ptr new

Description: Creates a new object of this class

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