 |
Telescience Resource Kit
TReK Python
5.4.0 ART
|
|
|
Telescience Resource Kit
TReK Python
5.4.0 ART
|
This class switches limit sets. More...
Inherits SwitchSet.
Public Member Functions | |
Initialize / Finalize | |
Functions handling class initialization and destruction. | |
| def | LimitAlarmSwitchSet ( Optional[LimitAlarmSwitchSet] limit_alarm_set=None, Optional[c_void_p] native_ptr=None, is_clone: bool=False -> def ) -> def |
| Class initializer. More... | |
| def | clone ( -> LimitAlarmSwitchSet ) -> def |
| Creates and returns an extact copy of the object. | |
| def | copy (copy_from: object -> None ) -> def |
| Copies contents from LimitAlarmSwitchSet. More... | |
| def | load_file (filename: str -> None ) -> def |
| Loads the LimitAlarmSwitchSet definition from the specified file. More... | |
| def | save_file (filename: str -> None ) -> def |
| Saves the LimitAlarmSwitchSet definition to the specified file. More... | |
Switch Management | |
Functions handling managing the switch set. | |
| def | add_limit_alarm (limit_alarm: LimitAlarm -> None ) -> def |
| Adds a limit alarm. More... | |
| def | delete_limit_alarm (name: str -> None ) -> def |
| Deletes the specified limit alarm. More... | |
| def | delete_all_limit_alarms ( -> None ) -> def |
| Deletes all of the limit alarms. | |
| def | get_limit_alarm (name: str -> Optional[LimitAlarm] ) -> def |
| Returns the limit alarm with the specified name. More... | |
| def | get_limit_alarm_type ( -> LimitAlarmSetType ) -> def |
| Gets data type used by LimitAlarm's in set. More... | |
| def | check ( Union[int, float] value, param_status: ParameterStatus -> None ) -> def |
| Checks the input value for alarm violations. More... | |
 Public Member Functions inherited from SwitchSet | |
| def | initialize ( -> None ) -> def |
| Initializes the object. More... | |
| def | set_default_set_name (name: str -> None ) -> def |
| Sets the default set name. More... | |
| def | get_default_set_name ( -> str ) -> def |
| Gets the default set name. More... | |
| def | set_switch_parameter_name (par_name: str -> None ) -> def |
| Sets the name of the parameter to use as a switch. More... | |
| def | get_switch_parameter_name ( -> str ) -> def |
| Gets the switch parameter name. More... | |
| def | set_switch_type (switch_type: SwitchType -> None ) -> def |
| Sets the type of switch to use. More... | |
| def | get_switch_type ( -> SwitchType ) -> def |
| Returns the current switch type. More... | |
| def | get_item_names ( -> list[str] ) -> def |
| Retrieves an array of the (e.g., calibrator) names from the set. More... | |
| def | add_enumeration_switch (enum_name: str, name: str -> None ) -> def |
| Adds an enumeration switch. More... | |
| def | get_enumeration_switches ( -> list[str] ) -> def |
| Gets the enumeration values for the switch. More... | |
| def | get_enumeration_info (enum_name: str -> str ) -> def |
| Gets the name for a switch based on its enumerated value. More... | |
| def | get_enumeration_info_length (enum_name: str -> int ) -> def |
| Gets the length for returned info of input parameter. More... | |
| def | delete_enumeration_switch (enum_name: str -> None ) -> def |
| Deletes the specified enumeration switch. More... | |
| def | add_range_switch (low: float, high: float, name: str -> None ) -> def |
| Adds a range switch. More... | |
| def | get_range_switches ( -> list[float] ) -> def |
| Gets the low value for each range switch. | |
| def | get_range_switch_info (low: float -> RangeSwitchInfo ) -> def |
| Gets the high value and name for a range switch based on its low value. More... | |
| def | get_range_switch_info_length (low: float -> int ) -> def |
| Gets the length for returned info of input parameter. More... | |
| def | delete_range_switch (low: float -> None ) -> def |
| Deletes the specified range switch. More... | |
| def | validate ( -> int ) -> def |
| Determines if it is safe to use the switched set. More... | |
| def | get_validation_errors ( -> str ) -> def |
| Gets a string of the last validation errors. More... | |
| Public Member Functions inherited from NamedItem | |
| def | remove_all_attributes ( -> None ) -> def |
| Removes all attributes. | |
| def | remove_attribute (name: str -> None ) -> def |
| Removes the attribute by name. More... | |
| def | __eq__ (named_item: object -> bool ) -> def |
| Equality operator "==". More... | |
| def | add_attribute (name: str, value: str -> None ) -> def |
| Adds an attribute to the item. More... | |
| def | get_alias ( -> str ) -> def |
| Returns the alias of the item. More... | |
| def | get_attribute (name: str -> str ) -> def |
| Get the value of the specified attribute. More... | |
| def | get_attribute_list ( -> list[str] ) -> def |
| Gets a list of the attribute names. More... | |
| def | get_name ( -> str ) -> def |
| Returns the name of the item. More... | |
| def | get_long_description ( -> str ) -> def |
| Returns the long description of the item. More... | |
| def | get_short_description ( -> str ) -> def |
| Returns the short description of the item. More... | |
| def | get_user_description ( -> str ) -> def |
| Returns the user description of the item. More... | |
| def | get_owner ( -> str ) -> def |
| Returns the owner of the item. More... | |
| def | get_path ( -> str ) -> def |
| Returns the path for the item. More... | |
| def | set_name (name: str -> None ) -> def |
| Sets the name of the item. More... | |
| def | set_alias (alias: str -> None ) -> def |
| Sets the alias of the item. More... | |
| def | set_short_description (description: str -> None ) -> def |
| Sets the short description of the item. More... | |
| def | set_long_description (description: str -> None ) -> def |
| Sets the long description of the item. More... | |
| def | set_user_description (description: str -> None ) -> def |
| Sets the user description of the item. More... | |
| def | set_owner (owner: str -> None ) -> def |
| Sets the owner of the item. More... | |
| def | set_path (path: str -> None ) -> def |
| Sets the path of the item. More... | |
This class switches limit sets.
The details of switching are defined in SwitchSet. This class limits the type of information that is in the set and provides the serialization of the data.
| ( | limit_alarm_set | : Optional[LimitAlarmSwitchSet] | |
| native_ptr | : Optional[c_void_p] | ||
| is_clone | : bool | ||
| ) | -> def |
Class initializer.
| [in] | limit_alarm_set | (Optional) LimitAlarmSwitchSet to copy. |
| [in] | native_ptr | (Optional) Internal parameter, do not provide. |
| [in] | is_clone | (Optional) Internal parameter, do not provide. |
Reimplemented from SwitchSet.
| ( | limit_alarm | : LimitAlarm | ) | -> None |
Adds a limit alarm.
Adds the limit alarm that can be referenced by a switch. The name of the limit alarm is used for the reference.
| [in] | limit_alarm | Limit alarm to add. |
| TrekError | 15005 - TREK_DATA_ALREADY_EXISTS |
| ( | value | : Union[int, float] | |
| param_status | : ParameterStatus | ||
| ) | -> None |
Checks the input value for alarm violations.
Determines the correct limit alarm to use based on the switching and checks the input value.
| [in] | value | The value to check. |
| [in] | param_status | The status to update. |
| TrekError | 15113 - TREK_DATA_SWITCH_ERROR |
| ( | copy_from | : object | ) | -> None |
Copies contents from LimitAlarmSwitchSet.
| [in] | copy_from | Instance to copy from. |
Reimplemented from SwitchSet.
| ( | name | : str | ) | -> None |
Deletes the specified limit alarm.
| [in] | name | The name of the alarm to delete. |
| TrekError | 15007 - TREK_DATA_DOES_NOT_EXIST |
| ( | name | : str | ) | -> Optional[LimitAlarm] |
Returns the limit alarm with the specified name.
| ( | ) | -> LimitAlarmSetType |
Gets data type used by LimitAlarm's in set.
| ( | filename | : str | ) | -> None |
Loads the LimitAlarmSwitchSet definition from the specified file.
Reads an XML LimitAlarmSwitchSet.
| [in] | filename | The file from which to load the limit alarm switch set object. |
| ( | filename | : str | ) | -> None |
Saves the LimitAlarmSwitchSet definition to the specified file.
Writes an XML LimitAlarmSwitchSet.
| [in] | filename | The file to save the limit alarm switch set. |