ParamConfig¶
Bases: object
ParamConfig class provides required information for parameter configuration.
This class handles the configuration details for device parameters, including default values, ranges (min/max), step sizes, and whether the parameter is fixed.
__init__()
¶
Default constructor.
Initializes a new instance of the ParamConfig class.
fromXML(paramNode)
¶
Provide parameter information from the XML node.
Populates the parameter configuration from the provided XML node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
paramNode
|
XMLNode
|
The XML node containing parameter information |
required |
Raises:
| Type | Description |
|---|---|
InscoperException
|
If an error occurred |
toXML(xmlParent)
¶
Export parameter information in an XML node attached to the parent XML node.
Serializes the parameter configuration to the specified parent XML node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xmlParent
|
XMLNode
|
The parent XML node |
required |
Raises:
| Type | Description |
|---|---|
InscoperException
|
If an error occurred |
getTag()
¶
Get tag of the current parameter.
Retrieves the tag associated with this parameter.
Returns:
| Type | Description |
|---|---|
int
|
The current parameter tag |
setTag(tag)
¶
Set tag of the current parameter.
Assigns a tag to this parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tag
|
int
|
The current parameter tag |
required |
isFixed()
¶
Return whether the parameter is fixed or not.
Checks if the parameter value is fixed (unmodifiable).
Returns:
| Type | Description |
|---|---|
boolean
|
True if the parameter value is fixed, false otherwise |
setFixed(fixed)
¶
Set the parameter as fixed or not.
Specifies whether the parameter value should be fixed (unmodifiable).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fixed
|
boolean
|
True if the parameter is fixed |
required |
getDefaultValue()
¶
Get the default value of the parameter.
Retrieves the default value of this parameter.
Returns:
| Type | Description |
|---|---|
str
|
The default value |
setDefaultValue(defaultValue)
¶
Set the default value of the parameter.
Sets the default value of this parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
defaultValue
|
string
|
The default value |
required |
getMin()
¶
Get the minimum value of the parameter.
Retrieves the minimum allowed value of this parameter.
Returns:
| Type | Description |
|---|---|
str
|
The minimum value |
setMin(min)
¶
Set the minimum value of the parameter.
Sets the minimum allowed value of this parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
min
|
string
|
The minimum value |
required |
getMax()
¶
Get the maximum value of the parameter.
Retrieves the maximum allowed value of this parameter.
Returns:
| Type | Description |
|---|---|
str
|
The maximum value |
setMax(max)
¶
Set the maximum value of the parameter.
Sets the maximum allowed value of this parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
max
|
string
|
The maximum value |
required |
getStep()
¶
Get the step size of the parameter.
Retrieves the step size used to increment this parameter.
Returns:
| Type | Description |
|---|---|
str
|
The step size of the parameter |
setStep(step)
¶
Set the step size of the parameter.
Sets the step size used to increment this parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
step
|
string
|
The step size of the parameter |
required |