API reference - Class DeviceParameterDefinition

Notation used in Ruby API documentation

Module: db

Description: A parameter descriptor

This class is used inside the DeviceClass class to describe a parameter of the device.

This class has been added in version 0.26.

Public constructors

new DeviceParameterDefinition ptrnew(string name,
string description = ,
double default_value = 0,
bool is_primary = true,
double si_scaling = 1)
Creates a new parameter definition.

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 DeviceParameterDefinition other)Assigns another object to self
[const]doubledefault_valueGets the default value of the parameter.
voiddefault_value=(double default_value)Sets the default value of the parameter.
[const]stringdescriptionGets the description of the parameter.
voiddescription=(string description)Sets the description of the parameter.
[const]new DeviceParameterDefinition ptrdupCreates a copy of self
[const]unsigned longidGets the ID of the parameter.
voidis_primary=(bool primary)Sets a value indicating whether the parameter is a primary parameter
[const]boolis_primary?Gets a value indicating whether the parameter is a primary parameter
[const]stringnameGets the name of the parameter.
voidname=(string name)Sets the name of the parameter.
[const]doublesi_scalingGets the scaling factor to SI units.

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

default_value

Signature: [const] double default_value

Description: Gets the default value of the parameter.

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

default_value=

Signature: void default_value= (double default_value)

Description: Sets the default value of the parameter.

The default value is used to initialize parameters of Device objects.

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

description

Signature: [const] string description

Description: Gets the description of the parameter.

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

description=

Signature: void description= (string description)

Description: Sets the description of the parameter.

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

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__'

id

Signature: [const] unsigned long id

Description: Gets the ID of the parameter.

The ID of the parameter is used in some places to refer to a specific parameter (e.g. in the NetParameterRef object).

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.

is_primary=

Signature: void is_primary= (bool primary)

Description: Sets a value indicating whether the parameter is a primary parameter

If this flag is set to true (the default), the parameter is considered a primary parameter. Only primary parameters are compared by default.

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

is_primary?

Signature: [const] bool is_primary?

Description: Gets a value indicating whether the parameter is a primary parameter

See is_primary= for details about this predicate.

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

name

Signature: [const] string name

Description: Gets the name of the parameter.

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

name=

Signature: void name= (string name)

Description: Sets the name of the parameter.

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

new

Signature: [static] new DeviceParameterDefinition ptr new (string name, string description = , double default_value = 0, bool is_primary = true, double si_scaling = 1)

Description: Creates a new parameter definition.

name:The name of the parameter
description:The human-readable description
default_value:The initial value
is_primary:True, if the parameter is a primary parameter (see is_primary=)
si_scaling:The scaling factor to SI units

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

si_scaling

Signature: [const] double si_scaling

Description: Gets the scaling factor to SI units.

For parameters in micrometers for example, this factor will be 1e-6.