ExpectedStateAlarm Class Reference
This class checks expected state violations. More...
Inherits NamedItem.
Public Member Functions | |
Initialize / Finalize | |
Functions handling class initialization and finalization. | |
| def | ExpectedStateAlarm ( Optional[ExpectedStateAlarm] expected_state_alarm=None, Optional[c_void_p] native_ptr=None, is_clone: bool=False) -> def |
| Class initializer. More... | |
| def | clone () -> ExpectedStateAlarm |
| Creates and returns an extact copy of the object. | |
| def | copy (copy_from: object) -> None |
| Copies the contents of the provided 'copy_from' ExpectedStateAlarm. More... | |
| def | load_file (filename: str) -> None |
| Loads the ExpectedStateAlarm definition from the specified file. More... | |
| def | save_file (filename: str) -> None |
| Saves the ExpectedStateAlarm definition to the specified file. More... | |
| def | initialize () -> None |
| Initializes the object. More... | |
Alarm State Management | |
Functions handling expected state. | |
| def | check (check_value: str, ParameterStatus param_status) -> None |
| Checks the check_value for an expected state violation. More... | |
| def | get_expected_state () -> str |
| Gets the expected type for the alarm. More... | |
| def | set_expected_state (new_state: str) -> None |
| Sets the expected type for the alarm. More... | |
 Public Member Functions inherited from NamedItem | |
| def | __eq__ (named_item: object) -> bool |
| Equality operator "==". More... | |
| def | get_alias () -> str |
| Returns the alias of the item. More... | |
| def | get_name () -> str |
| Returns the name of the item. More... | |
| def | get_long_description () -> str |
| Returns the long description of the item. More... | |
| def | get_short_description () -> str |
| Returns the short description of the item. More... | |
| def | get_user_description () -> str |
| Returns the user description of the item. More... | |
| def | get_owner () -> str |
| Returns the owner of the item. More... | |
| def | set_name (name: str) -> None |
| Sets the name of the item. More... | |
| def | set_alias (alias: str) -> None |
| Sets the alias of the item. More... | |
| def | set_short_description (description: str) -> None |
| Sets the short description of the item. More... | |
| def | set_long_description (description: str) -> None |
| Sets the long description of the item. More... | |
| def | set_user_description (description: str) -> None |
| Sets the user description of the item. More... | |
| def | set_owner (owner: str) -> None |
| Sets the owner of the item. More... | |
Detailed Description
This class checks expected state violations.
If an expected state violation occurs, the parameter status is updated.
Constructor & Destructor Documentation
◆ ExpectedStateAlarm()
| ExpectedStateAlarm | ( | expected_state_alarm | : Optional[ExpectedStateAlarm] |