 |
Telescience Resource Kit
TReK Python
5.4.0 ART
|
|
|
Telescience Resource Kit
TReK Python
5.4.0 ART
|
This class switches calibrator sets. More...
Inherits SwitchSet.
Public Member Functions | |
Initialize / Finalize | |
Functions handling class initialization and finalization. | |
| def | CalibratorSwitchSet ( Optional[CalibratorSwitchSet] cal_switch_set=None, Optional[c_void_p] native_ptr=None, is_clone: bool=False -> def ) -> def |
| Class initializer. More... | |
| def | clone ( -> CalibratorSwitchSet ) -> def |
| Creates and returns an extact copy of the object. | |
| def | copy (copy_from: object -> None ) -> def |
| Copies contents from CalibratorSwitchSet. More... | |
| def | load_file (filename: str -> None ) -> def |
| Loads the CalibratorSwitchSet definition from the specified file. More... | |
| def | save_file (filename: str -> None ) -> def |
| Saves the CalibratorSwitchSet definition to the specified file. More... | |
Switch Management | |
Functions handling managing the switch set. | |
| def | add_calibrator (calibrator: Calibrator -> None ) -> def |
| Adds a calibrator. More... | |
| def | delete_calibrator (name: str -> None ) -> def |
| Deletes the specified calibrator. More... | |
| def | delete_all_calibrators ( -> None ) -> def |
| Deletes all of the calibrators. | |
| def | get_calibrator (calibrator_name: str -> Optional[Calibrator] ) -> def |
| Returns the calibrator with the specified name. More... | |
| def | calibrate (input_value: float -> float ) -> def |
| Performs the calibration on the input value. 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 calibrator 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.
| ( | cal_switch_set | : Optional[CalibratorSwitchSet] | |
| native_ptr | : Optional[c_void_p] | ||
| is_clone | : bool | ||
| ) | -> def |
Class initializer.
| [in] | cal_switch_set | (Optional) The CalibratorSwitchSet to copy. |
| [in] | native_ptr | (Optional) Internal parameter, do not provide. |
| [in] | is_clone | (Optional) Internal parameter, do not provide. |
Reimplemented from SwitchSet.
| ( | calibrator | : Calibrator | ) | -> None |
Adds a calibrator.
Adds the calibrator that can be referenced by a switch. The name of the calibrator is used for the reference.
| [in] | calibrator | Calibrator to add, the provided calibrator is copied. |
| TrekError | 15005 - TREK_DATA_ALREADY_EXISTS |
| ( | input_value | : float | ) | -> float |
Performs the calibration on the input value.
Determines the correct calibrator to use based on the switching and calibrates the input value.
| [in] | input_value | Value to calibrate. |
| TrekError | 15113 - TREK_DATA_SWITCH_ERROR |
| ( | copy_from | : object | ) | -> None |
Copies contents from CalibratorSwitchSet.
| [in] | copy_from | Instance to copy from. |
| TypeError | if 'copy_from' is not a CalibratorSwitchSet. |
Reimplemented from SwitchSet.
| ( | name | : str | ) | -> None |
Deletes the specified calibrator.
| [in] | name | The name of the calibrator to delete. |
| TrekError | 15007 - TREK_DATA_DOES_NOT_EXIST |
| ( | calibrator_name | : str | ) | -> Optional[Calibrator] |
Returns the calibrator with the specified name.
| [in] | calibrator_name | The name of the desired calibrator. |
| ( | filename | : str | ) | -> None |
Loads the CalibratorSwitchSet definition from the specified file.
Reads an XML CalibratorSwitchSet.
| [in] | filename | The file from which to load the calibrator switch set object. |
| ( | filename | : str | ) | -> None |
Saves the CalibratorSwitchSet definition to the specified file.
Writes an XML CalibratorSwitchSet.
| [in] | filename | The file to save the calibrator switch set. |