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.
new DeviceParameterDefinition ptr | new | (string name, string description = , double default_value = 0, bool is_primary = true, double si_scaling = 1, double geo_scaling_exponent = 0) | Creates a new parameter definition. |
[const] | DeviceParameterDefinition ptr | _const_cast | Returns a non-const reference to self. | |
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 DeviceParameterDefinition other) | Assigns another object to self | |
[const] | double | default_value | Gets the default value of the parameter. | |
void | default_value= | (double default_value) | Sets the default value of the parameter. | |
[const] | string | description | Gets the description of the parameter. | |
void | description= | (string description) | Sets the description of the parameter. | |
[const] | new DeviceParameterDefinition ptr | dup | Creates a copy of self | |
[const] | double | geo_scaling_exponent | Gets the geometry scaling exponent. | |
void | geo_scaling_exponent= | (double expo) | Sets the geometry scaling exponent. | |
[const] | unsigned long | id | Gets the ID of the parameter. | |
void | is_primary= | (bool primary) | Sets a value indicating whether the parameter is a primary parameter | |
[const] | bool | is_primary? | Gets a value indicating whether the parameter is a primary parameter | |
[const] | string | name | Gets the name of the parameter. | |
void | name= | (string name) | Sets the name of the parameter. | |
[const] | double | si_scaling | Gets the scaling factor to SI units. | |
void | si_scaling= | (double flag) | Sets the scaling factor to SI units. |
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 |
_const_cast | Signature: [const] DeviceParameterDefinition 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 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: | ||||||||||||
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: | ||||||||||||
description | Signature: [const] string description Description: Gets the description of the parameter. Python specific notes: | ||||||||||||
description= | Signature: void description= (string description) Description: Sets the description of the parameter. 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 DeviceParameterDefinition ptr dup Description: Creates a copy of self Python specific notes: | ||||||||||||
geo_scaling_exponent | Signature: [const] double geo_scaling_exponent Description: Gets the geometry scaling exponent. This value is used when applying '.options scale' in the SPICE reader for example. It is zero for 'no scaling', 1.0 for linear scaling and 2.0 for quadratic scaling. This attribute has been added in version 0.28.6. Python specific notes: | ||||||||||||
geo_scaling_exponent= | Signature: void geo_scaling_exponent= (double expo) Description: Sets the geometry scaling exponent. See geo_scaling_exponent for details. This attribute has been added in version 0.28.6. Python specific notes: | ||||||||||||
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: | ||||||||||||
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: | ||||||||||||
name | Signature: [const] string name Description: Gets the name of the parameter. Python specific notes: | ||||||||||||
name= | Signature: void name= (string name) Description: Sets the name of the parameter. Python specific notes: | ||||||||||||
new | Signature: [static] new DeviceParameterDefinition ptr new (string name, string description = , double default_value = 0, bool is_primary = true, double si_scaling = 1, double geo_scaling_exponent = 0) Description: Creates a new parameter definition.
Python specific notes: | ||||||||||||
si_scaling | Signature: [const] double si_scaling Description: Gets the scaling factor to SI units. For parameters in micrometers - for example W and L of MOS devices - this factor can be set to 1e-6 to reflect the unit. Python specific notes: | ||||||||||||
si_scaling= | Signature: void si_scaling= (double flag) Description: Sets the scaling factor to SI units. This setter has been added in version 0.28.6. Python specific notes: |