trek::SwitchSet Class Referenceabstract
This class is the abstraction for sets of information that can be switched by the value of a parameter. More...
#include <switch_set.h>
Inherits trek::NamedItem.
Inherited by trek::CalibratorSwitchSet, trek::EnumeratorSwitchSet, trek::ExpectedStateAlarmSwitchSet, and trek::LimitAlarmSwitchSet.
Public Member Functions | |
| int32_t | SetDefaultSetName (const char *name) |
| Sets the default set name. More... | |
| const char * | GetDefaultSetName () |
| Gets the default set name. More... | |
| int32_t | SetSwitchParameterName (const char *name) |
| Sets the name of the parameter to use as a switch. More... | |
| const char * | GetSwitchParameterName () |
| Gets the default set name. More... | |
| void | SetSwitchType (switch_type input) |
| Sets the type of switch to use. More... | |
| switch_type | GetSwitchType () |
| Returns the current switch type. More... | |
| int32_t | SetSwitchParameter (Parameter *input_ptr) |
| Sets the parameter to use for switching. More... | |
| int32_t | AddRangeSwitch (double low, double high, const char *name) |
| Adds a range switch. More... | |
| int32_t | AddEnumerationSwitch (const char *enum_name, const char *name) |
| Adds an enumeration switch. More... | |
| int32_t | DeleteRangeSwitch (double low) |
| Deletes the specified range switch. More... | |
| int32_t | DeleteEnumerationSwitch (const char *enum_name) |
| Deletes the specified enumeration switch. More... | |
| int32_t | GetRangeSwitches (double **input, uint32_t &array_size) |
| Gets the low value for each range switch. More... | |
| void | GetEnumerationSwitches (StringArray &input) |
| Gets the enumeration values for the switch. More... | |
| int32_t | GetRangeSwitchInfo (double low, double &high, char **name) |
| Gets the high value and name for a range switch based on its low value. More... | |
| int32_t | GetEnumerationInfo (const char *enum_name, char **name) |
| Gets the name for a switch based on its enumerated value. More... | |
| int32_t | Validate () |
| Determines if it is safe to use the switched set. More... | |
| const char * | GetValidationErrors () |
| Gets a string of the last validation errors. More... | |
| void | GetItemNames (StringArray &input) |
| Retrieves an array of the (e.g., calibrator) names from the set. More... | |
Constructors, Destructor, and Other Basic Methods | |
| SwitchSet () | |
| Default constructor of the class. | |
| SwitchSet (SwitchSet &input) | |
| Copy constructor of the class. | |
| virtual | ~SwitchSet () |
| Class destructor. More... | |
| void | operator= (SwitchSet &right_side) |
| Provides the equal operator. | |
| virtual void | Init () |
| Initializes the object. | |
 Public Member Functions inherited from trek::NamedItem | |
| void | SetName (const char *input_ptr) |
| Sets the name of the item. More... | |
| void | SetAlias (const char *input) |
| Sets the alias of the item. More... | |
| void | SetShortDescription (const char *input_ptr) |
| Sets the short description of the item. More... | |
| void | SetLongDescription (const char *input_ptr) |
| Sets the long description of the item. More... | |
| void | SetUserDescription (const char *input_ptr) |
| Sets the user description of the item. More... | |
| void | SetOwner (const char *input_ptr) |
| Sets the owner of the item. More... | |
| const char * | GetName () |
| Returns the name of the item. | |
| const char * | GetAlias () |
| Returns the alias of the item. | |
| const char * | GetShortDescription () |
| Returns the short description of the item. | |
| const char * | GetLongDescription () |
| Returns the long description of the item. | |
| const char * | GetUserDescription () |
| Returns the user description of the item. | |
| const char * | GetOwner () |
| Returns the owner of the item. | |
| NamedItem () | |
| Default constructor of the class. | |
| NamedItem (NamedItem &input) | |
| Copy constructor of the class. | |
| virtual | ~NamedItem () |
| Class destructor. More... | |
| void | operator= (NamedItem &right_side) |
| Provides the equal operator. | |
| bool | operator== (NamedItem &right_side) |
| Provides the == operator. | |
Detailed Description
This class is the abstraction for sets of information that can be switched by the value of a parameter.
The switch parameter can be used to determine which set of information to use. Used for enumeration, calbiration, limits, and expected states. Two types of switching are supported: range switching and enumeration switching.