Stateful-control-specific info about an Endpoint in an Integra Module interface.
More...
#include "api/interface_definition.h"
Stateful-control-specific info about an Endpoint in an Integra Module interface.
| virtual const IConstraint& integra_api::IStateInfo::get_constraint |
( |
| ) |
const |
|
pure virtual |
get the constraint. Defines which values are allowed
| virtual const CValue& integra_api::IStateInfo::get_default_value |
( |
| ) |
const |
|
pure virtual |
| virtual const value_map& integra_api::IStateInfo::get_state_labels |
( |
| ) |
const |
|
pure virtual |
Get the state labels.
State labels are a set of 'special' values with strings assigned to them They could be used to provide specially labelled widgets. For instance, a pan control might want to define the labels { -1:'L', 0:'C', 1:'R' }
| virtual CValue::type integra_api::IStateInfo::get_type |
( |
| ) |
const |
|
pure virtual |
get type of value used to represent the endpoint's state
| virtual const IValueScale* integra_api::IStateInfo::get_value_scale |
( |
| ) |
const |
|
pure virtual |
how should the value be scaled?
| virtual bool integra_api::IStateInfo::test_constraint |
( |
const CValue & |
value | ) |
const |
|
pure virtual |
Test whether a value adheres to constraint.
- Parameters
-
- Returns
- true if value's type matches type of this state, and value adheres to constraint
The documentation for this class was generated from the following file:
1.8.6
