ParamDescription¶
Bases: object
ParamDescription class provides parameter information coming from drivers.
Notes: This class is non-copyable and non-movable.
This class is an abstract base class storing device parameters, including their tag, name, description, and type.
getTag()
¶
Get the tag of the parameter.
Retrieves the unique tag of the parameter.
Returns:
| Type | Description |
|---|---|
int
|
The tag of the parameter |
getName()
¶
Get the name of the parameter.
Retrieves the display name of the parameter.
Returns:
| Type | Description |
|---|---|
str
|
The name of the parameter |
getDescription()
¶
Get the description of the parameter.
Retrieves the textual description of the parameter.
Returns:
| Type | Description |
|---|---|
str
|
The description of the parameter |
getType()
¶
Get the type of the parameter.
Retrieves the data type of the parameter.
Returns:
| Type | Description |
|---|---|
int
|
The type of the parameter |
getConstraint()
¶
Get the constraints of the parameter.
Retrieves the constraints of the parameter (e.g. min, max, step size).
Returns:
| Type | Description |
|---|---|
Constraint
|
The constraint of the parameter |