API reference - Class PCellParameterDeclaration
Notation used in Ruby API documentation
Description: A PCell parameter declaration
- Public constructors
- Public methods
- Public static methods and constants
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
This class declares a PCell parameter by providing a name, the type and a value and additional information like description, unit string and default value. It is used in the PCellDeclaration class to deliver the necessary information.
This class has been introduced in version 0.22.
Public constructors
| new PCellParameterDeclaration ptr | new | (string name, unsigned int type, string description) | Create a new parameter declaration with the given name and type |
| new PCellParameterDeclaration ptr | new | (string name, unsigned int type, string description, variant default) | Create a new parameter declaration with the given name, type and default value |
| new PCellParameterDeclaration ptr | new | (string name, unsigned int type, string description, variant default, string arg5) | Create a new parameter declaration with the given name, type, default value and unit string |
Public methods
| 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 | add_choice | (string description, variant value) | Add a new value to the list of choices | |
| void | assign | (const PCellParameterDeclaration other) | Assigns another object to self | |
| [const] | string[] | choice_descriptions | Returns a list of choice descriptions | |
| [const] | variant[] | choice_values | Returns a list of choice values | |
| void | clear_choices | Clears the list of choices | ||
| [const] | variant | default | Gets the default value | |
| void | default= | (variant value) | Sets the default value | |
| [const] | string | description | Gets the description text | |
| void | description= | (string description) | Sets the description | |
| [const] | new PCellParameterDeclaration ptr | dup | Creates a copy of self | |
| void | hidden= | (bool flag) | Makes the parameter hidden if this attribute is set to true | |
| [const] | bool | hidden? | Returns true, if the parameter is a hidden parameter that should not be shown in the user interface | |
| [const] | string | name | Gets the name | |
| void | name= | (string value) | Sets the name | |
| void | readonly= | (bool flag) | Makes the parameter read-only if this attribute is set to true | |
| [const] | bool | readonly? | Returns true, if the parameter is a read-only parameter | |
| [const] | unsigned int | type | Gets the type | |
| void | type= | (unsigned int type) | Sets the type | |
| [const] | string | unit | Gets the unit string | |
| void | unit= | (string unit) | Sets the unit string |
Public static methods and constants
| unsigned int | TypeBoolean | Type code: boolean data | ||
| unsigned int | TypeDouble | Type code: floating-point data | ||
| unsigned int | TypeInt | Type code: integer data | ||
| unsigned int | TypeLayer | Type code: a layer (a LayerInfo object) | ||
| unsigned int | TypeList | Type code: a list of variants | ||
| unsigned int | TypeNone | Type code: unspecific type | ||
| unsigned int | TypeShape | Type code: a guiding shape (Box, Edge, Point, Polygon or Path) | ||
| unsigned int | TypeString | Type code: string data |
Deprecated methods (protected, public, static, non-static and constructors)
| 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 |
Detailed description
TypeBoolean | Signature: [static] unsigned int TypeBoolean Description: Type code: boolean data | |||||||||
TypeDouble | Signature: [static] unsigned int TypeDouble Description: Type code: floating-point data | |||||||||
TypeInt | Signature: [static] unsigned int TypeInt Description: Type code: integer data | |||||||||
TypeLayer | Signature: [static] unsigned int TypeLayer Description: Type code: a layer (a LayerInfo object) | |||||||||
TypeList | Signature: [static] unsigned int TypeList Description: Type code: a list of variants | |||||||||
TypeNone | Signature: [static] unsigned int TypeNone Description: Type code: unspecific type | |||||||||
TypeShape | Signature: [static] unsigned int TypeShape Description: Type code: a guiding shape (Box, Edge, Point, Polygon or Path) | |||||||||
TypeString | Signature: [static] unsigned int TypeString Description: Type code: string data | |||||||||
_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. | |||||||||
add_choice | Signature: void add_choice (string description,variant value) Description: Add a new value to the list of choices This method will add the given value with the given description to the list of choices. If choices are defined, KLayout will show a drop-down box instead of an entry field in the parameter user interface. | |||||||||
assign | Signature: void assign (const PCellParameterDeclaration other) Description: Assigns another object to self | |||||||||
choice_descriptions | Signature: [const] string[] choice_descriptions Description: Returns a list of choice descriptions | |||||||||
choice_values | Signature: [const] variant[] choice_values Description: Returns a list of choice values | |||||||||
clear_choices | Signature: void clear_choices Description: Clears the list of choices | |||||||||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead | |||||||||
default | Signature: [const] variant default Description: Gets the default value Python specific notes: | |||||||||
default= | Signature: void default= (variant value) Description: Sets the default value If a default value is defined, it will be used to initialize the parameter value when a PCell is created. Python specific notes: | |||||||||
description | Signature: [const] string description Description: Gets the description text Python specific notes: | |||||||||
description= | Signature: void description= (string description) Description: Sets the description Python specific notes: | |||||||||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead | |||||||||
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 | |||||||||
dup | Signature: [const] new PCellParameterDeclaration ptr dup Description: Creates a copy of self | |||||||||
hidden= | Signature: void hidden= (bool flag) Description: Makes the parameter hidden if this attribute is set to true Python specific notes: | |||||||||
hidden? | Signature: [const] bool hidden? Description: Returns true, if the parameter is a hidden parameter that should not be shown in the user interface By making a parameter hidden, it is possible to create internal parameters which cannot be edited. Python specific notes: | |||||||||
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 | |||||||||
name | Signature: [const] string name Description: Gets the name Python specific notes: | |||||||||
name= | Signature: void name= (string value) Description: Sets the name Python specific notes: | |||||||||
new | Signature: [static] new PCellParameterDeclaration ptr new (string name,unsigned int type,string description) Description: Create a new parameter declaration with the given name and type
Python specific notes: | |||||||||
Signature: [static] new PCellParameterDeclaration ptr new (string name,unsigned int type,string description,variant default) Description: Create a new parameter declaration with the given name, type and default value
Python specific notes: | ||||||||||
Signature: [static] new PCellParameterDeclaration ptr new (string name,unsigned int type,string description,variant default,string arg5) Description: Create a new parameter declaration with the given name, type, default value and unit string
Python specific notes: | ||||||||||
readonly= | Signature: void readonly= (bool flag) Description: Makes the parameter read-only if this attribute is set to true Python specific notes: | |||||||||
readonly? | Signature: [const] bool readonly? Description: Returns true, if the parameter is a read-only parameter By making a parameter read-only, it is shown but cannot be edited. Python specific notes: | |||||||||
type | Signature: [const] unsigned int type Description: Gets the type The type is one of the T... constants. Python specific notes: | |||||||||
type= | Signature: void type= (unsigned int type) Description: Sets the type Python specific notes: | |||||||||
unit | Signature: [const] string unit Description: Gets the unit string Python specific notes: | |||||||||
unit= | Signature: void unit= (string unit) Description: Sets the unit string The unit string is shown right to the edit fields for numeric parameters. Python specific notes: |