Class GeneralSystemState

Defined in File GeneralSystemState.h

Class Documentation

class GeneralSystemState

The GeneralSystemState class. It includes a summary of the current system state, the state of the safe and the non-safe cut-off path and bits indicating if a restart interlock is ready to be reset.

Public Functions

GeneralSystemState(): Constructor of GeneralSystemState, creates empty instance.

bool getRunModeActive() const

Returns if run mode is active.

Returns: If run mode is active.

void setRunModeActive(bool run_mode_active)

Setter for run mode.

Parameters: run_mode_active – If run mode is active or inactive.

bool getStandbyModeActive() const

Returns if the standby mode is active.

Returns: If the standby mode is active.

void setStandbyModeActive(bool standby_mode_active)

Setter for standby mode.

Parameters: standby_mode_active – If standby mode is active or inactive.

bool getContaminationWarning() const

Returns if a contamination warning is exists.

Returns: If a contamination warning exists.

void setContaminationWarning(bool contamination_warning)

Set if a contamination warning exists.

Parameters: contamination_warning – If a contamination warning exists.

bool getContaminationError() const

Returns if a contamination error exists.

Returns: If a contamination error exists.

void setContaminationError(bool contamination_error)

Set if a contamination error exists.

Parameters: contamination_error – If a contamination error exists.

bool getReferenceContourStatus() const

Returns if the reference contour status is true.

Returns: If the reference contour status ist true.

void setReferenceContourStatus(bool reference_contour_status)

Set the reference contour status.

Parameters: reference_contour_status – The new reference contour status.

bool getManipulationStatus() const

Returns if the manipulation status is set to true.

Returns: If the manipulation status is set.

void setManipulationStatus(bool manipulation_status)

Set the manipulation status.

Parameters: manipulation_status – The new manipulation status.

std::vector<bool> getSafeCutOffPathVector() const

Returns the state for all safe cut off paths.

Returns: Vector containing the state of all safe cut off paths.

void setSafeCutOffPathvector(const std::vector<bool> &safe_cut_off_path_vector)

Sets the state of all safe cut-off paths.

Parameters: safe_cut_off_path_vector – Vector for the state of all safe cut-off paths.

std::vector<bool> getNonSafeCutOffPathVector() const

Returns the state of all non-safe cut-off paths.

Returns: Vector containing the state of all non-safe cut-off paths

void setNonSafeCutOffPathVector(const std::vector<bool> &non_safe_cut_off_path_vector)

Sets the state of all non-safe cut-off paths.

Parameters: non_safe_cut_off_path_vector – Vector for the state of all non-safe cut-off paths

std::vector<bool> getResetRequiredCutOffPathVector() const

Returns if a cut-off path has to be reset.

Returns: Vector if a cut-off path has to be reset.

void setResetRequiredCutOffPathVector(const std::vector<bool> &reset_required_cut_off_path_vector)

Sets the reset state for all cut-off paths.

Parameters: reset_required_cut_off_path_vector – Vector for the reset state of all cut-off paths

uint8_t getCurrentMonitoringCaseNoTable1() const

Returns the current monitor case table 1.

Returns: The current monitoring case table 1.

void setCurrentMonitoringCaseNoTable1(const uint8_t &current_monitoring_case_no_table_1)

Sets the current monitoring case table 1.

Parameters: current_monitoring_case_no_table_1 – The current monitoring case table 1.

uint8_t getCurrentMonitoringCaseNoTable2() const

Returns the current monitor case table 2.

Returns: The current monitoring case table 2.

void setCurrentMonitoringCaseNoTable2(const uint8_t &current_monitoring_case_no_table_2)

Sets the current monitoring case table 2.

Parameters: current_monitoring_case_no_table_2 – The current monitoring case table 2.

uint8_t getCurrentMonitoringCaseNoTable3() const

Returns the current monitor case table 3.

Returns: The current monitoring case table 3.

void setCurrentMonitoringCaseNoTable3(const uint8_t &current_monitoring_case_no_table_3)

Sets the current monitoring case table 3.

Parameters: current_monitoring_case_no_table_3 – The current monitoring case table 3.

uint8_t getCurrentMonitoringCaseNoTable4() const

Returns the current monitor case table 4.

Returns: The current monitoring case table 4.

void setCurrentMonitoringCaseNoTable4(const uint8_t &current_monitoring_case_no_table_4)

Sets the current monitoring case table 4.

Parameters: current_monitoring_case_no_table_4 – The current monitoring case table 4 .

bool getApplicationError() const

Return if an application error exists.

Returns: If an application error exists.

void setApplicationError(bool application_error)

Set if an application error exists.

Parameters: application_error – If an application error exists.

bool getDeviceError() const

Return if a device error exists.

Returns: If a device error exists.

void setDeviceError(bool device_error)

Set if a device error exists.

Parameters: device_error – If a device error exists

bool isEmpty() const

Return if general system state has been enabled.

Returns: If general system state has been enabled.

void setIsEmpty(bool is_empty)

Set if general system state has been enabled.

Parameters: is_empty – If general system state has been enabled.