Parameter Property
Class full path: ParameterProperty.ParameterProperty
Definition of class ParameterProperty
Attributes
attribute_id: int
property
writable
Get the attribute id of the property
Returns:
| Type | Description |
|---|---|
int
|
attribute id of the property. |
attribute_id_str: str
property
writable
Get the attribute id string of the property
Returns:
| Type | Description |
|---|---|
str
|
attribute id of the property. |
dimensions: str
property
writable
Get the dimensions of the property in case of a list
Returns:
| Type | Description |
|---|---|
str
|
dimensions. |
exclude_identical: bool
property
writable
Get the exclude identical state
If True, the parameter is not used for checking identical PythonParts
Returns:
| Type | Description |
|---|---|
bool
|
returns |
group_name: str
property
writable
Get the group name of the property
Returns:
| Type | Description |
|---|---|
str
|
name of the property. |
input_type: InputType
property
writable
Getter for input type paramter
Returns:
| Type | Description |
|---|---|
InputType
|
Input type of parameter property. |
is_modified: bool
property
writable
Get the modified state
Returns:
| Type | Description |
|---|---|
bool
|
returns |
list_reverse: bool
property
writable
Get the list reverse state
Returns:
| Type | Description |
|---|---|
bool
|
returns |
list_squeeze: bool
property
writable
Get the list squeeze state
Returns:
| Type | Description |
|---|---|
bool
|
returns |
list_state: int
property
writable
Get the list as block state
Returns:
| Type | Description |
|---|---|
int
|
returns |
name: str
property
writable
Get the name of the property
Returns:
| Type | Description |
|---|---|
str
|
name of the property. |
named_tuple_def: Optional[NamedTupleDef]
property
Get the named tuple definition
Returns:
| Type | Description |
|---|---|
Optional[NamedTupleDef]
|
returns |
persistent: Persistent
property
writable
Get the persistent state of the property
Returns:
| Type | Description |
|---|---|
Persistent
|
persistent state (save in the PythonPart data). |
selected_value: Any
property
writable
Get the selected value of the property
Returns:
| Type | Description |
|---|---|
Any
|
value of the property. |
value: Any
property
writable
Get the value of the property
Returns:
| Type | Description |
|---|---|
Any
|
value of the property. |
value_type: ParameterPropertyValueType
property
writable
Get the value type of the property
Returns:
| Type | Description |
|---|---|
ParameterPropertyValueType
|
value type. |
Classes
InputType
Bases: IntEnum
Class used to define the type of inputs
Persistent
Bases: IntEnum
Definition of class PersistentType
Functions
__init__()
initialize
__repr__()
Print class information
Returns:
| Type | Description |
|---|---|
str
|
parameter property as string |
deep_copy()
deep copy of the parameter values
Returns:
| Type | Description |
|---|---|
ParameterProperty
|
copied parameter property |
reset_modified()
Reset the is_modified state
set_named_tuple_def(typename, field_names)
Set the named tuple definition
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
typename
|
str
|
description |
required |
field_names
|
List[str]
|
description |
required |