API reference - Class ParseElementData

Notation used in Ruby API documentation

Module: db

Description: Supplies the return value for \NetlistSpiceReaderDelegate#parse_element.

This is a structure with four members: 'model_name' for the model name, 'value' for the default numerical value, 'net_names' for the net names and 'parameters' for the named parameters.

This helper class has been introduced in version 0.27.1. Starting with version 0.28.6, named parameters can be string types too.

Public constructors

new ParseElementData 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 ParseElementData other)Assigns another object to self
[const]new ParseElementData ptrdupCreates a copy of self
[const]stringmodel_nameGets the model name
voidmodel_name=(string m)Sets the model name
[const]string[]net_namesGets the net names
voidnet_names=(string[] list)Sets the net names
[const]map<string,variant>parametersGets the (named) parameters
voidparameters=(map<string,variant> dict)Sets the (named) parameters
[const]doublevalueGets the value
voidvalue=(double v)Sets the value

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 ParseElementData 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 ParseElementData 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.

model_name

Signature: [const] string model_name

Description: Gets the model name

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

model_name=

Signature: void model_name= (string m)

Description: Sets the model name

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

net_names

Signature: [const] string[] net_names

Description: Gets the net names

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

net_names=

Signature: void net_names= (string[] list)

Description: Sets the net names

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

new

Signature: [static] new ParseElementData ptr new

Description: Creates a new object of this class

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

parameters

Signature: [const] map<string,variant> parameters

Description: Gets the (named) parameters

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

parameters=

Signature: void parameters= (map<string,variant> dict)

Description: Sets the (named) parameters

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

value

Signature: [const] double value

Description: Gets the value

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

value=

Signature: void value= (double v)

Description: Sets the value

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