Public Member Functions | Private Attributes | List of all members
sick::datastructure::GeneralSystemState Class Reference

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. More...

#include <GeneralSystemState.h>

Public Member Functions

 GeneralSystemState ()
 Constructor of GeneralSystemState, creates empty instance. More...
 
bool getApplicationError () const
 Return if an application error exists. More...
 
bool getContaminationError () const
 Returns if a contamination error exists. More...
 
bool getContaminationWarning () const
 Returns if a contamination warning is exists. More...
 
uint8_t getCurrentMonitoringCaseNoTable1 () const
 Returns the current monitor case table 1. More...
 
uint8_t getCurrentMonitoringCaseNoTable2 () const
 Returns the current monitor case table 2. More...
 
uint8_t getCurrentMonitoringCaseNoTable3 () const
 Returns the current monitor case table 3. More...
 
uint8_t getCurrentMonitoringCaseNoTable4 () const
 Returns the current monitor case table 4. More...
 
bool getDeviceError () const
 Return if a device error exists. More...
 
bool getManipulationStatus () const
 Returns if the manipulation status is set to true. More...
 
std::vector< bool > getNonSafeCutOffPathVector () const
 Returns the state of all non-safe cut-off paths. More...
 
bool getReferenceContourStatus () const
 Returns if the reference contour status is true. More...
 
std::vector< bool > getResetRequiredCutOffPathVector () const
 Returns if a cut-off path has to be reset. More...
 
bool getRunModeActive () const
 Returns if run mode is active. More...
 
std::vector< bool > getSafeCutOffPathVector () const
 Returns the state for all safe cut off paths. More...
 
bool getStandbyModeActive () const
 Returns if the standby mode is active. More...
 
bool isEmpty () const
 Return if general system state has been enabled. More...
 
void setApplicationError (bool application_error)
 Set if an application error exists. More...
 
void setContaminationError (bool contamination_error)
 Set if a contamination error exists. More...
 
void setContaminationWarning (bool contamination_warning)
 Set if a contamination warning exists. More...
 
void setCurrentMonitoringCaseNoTable1 (const uint8_t &current_monitoring_case_no_table_1)
 Sets the current monitoring case table 1. More...
 
void setCurrentMonitoringCaseNoTable2 (const uint8_t &current_monitoring_case_no_table_2)
 Sets the current monitoring case table 2. More...
 
void setCurrentMonitoringCaseNoTable3 (const uint8_t &current_monitoring_case_no_table_3)
 Sets the current monitoring case table 3. More...
 
void setCurrentMonitoringCaseNoTable4 (const uint8_t &current_monitoring_case_no_table_4)
 Sets the current monitoring case table 4. More...
 
void setDeviceError (bool device_error)
 Set if a device error exists. More...
 
void setIsEmpty (bool is_empty)
 Set if general system state has been enabled. More...
 
void setManipulationStatus (bool manipulation_status)
 Set the manipulation status. More...
 
void setNonSafeCutOffPathVector (const std::vector< bool > &non_safe_cut_off_path_vector)
 Sets the state of all non-safe cut-off paths. More...
 
void setReferenceContourStatus (bool reference_contour_status)
 Set the reference contour status. More...
 
void setResetRequiredCutOffPathVector (const std::vector< bool > &reset_required_cut_off_path_vector)
 Sets the reset state for all cut-off paths. More...
 
void setRunModeActive (bool run_mode_active)
 Setter for run mode. More...
 
void setSafeCutOffPathvector (const std::vector< bool > &safe_cut_off_path_vector)
 Sets the state of all safe cut-off paths. More...
 
void setStandbyModeActive (bool standby_mode_active)
 Setter for standby mode. More...
 

Private Attributes

bool m_application_error
 
bool m_contamination_error
 
bool m_contamination_warning
 
uint8_t m_current_monitoring_case_no_table_1
 
uint8_t m_current_monitoring_case_no_table_2
 
uint8_t m_current_monitoring_case_no_table_3
 
uint8_t m_current_monitoring_case_no_table_4
 
bool m_device_error
 
bool m_is_empty
 
bool m_manipulation_status
 
std::vector< bool > m_non_safe_cut_off_path_vector
 
bool m_reference_contour_status
 
std::vector< bool > m_reset_required_cut_off_path_vector
 
bool m_run_mode_active
 
std::vector< bool > m_safe_cut_off_path_vector
 
bool m_standby_mode_active
 

Detailed Description

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.

Definition at line 49 of file GeneralSystemState.h.

Constructor & Destructor Documentation

sick::datastructure::GeneralSystemState::GeneralSystemState ( )

Constructor of GeneralSystemState, creates empty instance.

Definition at line 40 of file GeneralSystemState.cpp.

Member Function Documentation

bool sick::datastructure::GeneralSystemState::getApplicationError ( ) const

Return if an application error exists.

Returns
If an application error exists.

Definition at line 181 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::getContaminationError ( ) const

Returns if a contamination error exists.

Returns
If a contamination error exists.

Definition at line 75 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::getContaminationWarning ( ) const

Returns if a contamination warning is exists.

Returns
If a contamination warning exists.

Definition at line 65 of file GeneralSystemState.cpp.

uint8_t sick::datastructure::GeneralSystemState::getCurrentMonitoringCaseNoTable1 ( ) const

Returns the current monitor case table 1.

Returns
The current monitoring case table 1.

Definition at line 137 of file GeneralSystemState.cpp.

uint8_t sick::datastructure::GeneralSystemState::getCurrentMonitoringCaseNoTable2 ( ) const

Returns the current monitor case table 2.

Returns
The current monitoring case table 2.

Definition at line 148 of file GeneralSystemState.cpp.

uint8_t sick::datastructure::GeneralSystemState::getCurrentMonitoringCaseNoTable3 ( ) const

Returns the current monitor case table 3.

Returns
The current monitoring case table 3.

Definition at line 159 of file GeneralSystemState.cpp.

uint8_t sick::datastructure::GeneralSystemState::getCurrentMonitoringCaseNoTable4 ( ) const

Returns the current monitor case table 4.

Returns
The current monitoring case table 4.

Definition at line 170 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::getDeviceError ( ) const

Return if a device error exists.

Returns
If a device error exists.

Definition at line 191 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::getManipulationStatus ( ) const

Returns if the manipulation status is set to true.

Returns
If the manipulation status is set.

Definition at line 95 of file GeneralSystemState.cpp.

std::vector< bool > sick::datastructure::GeneralSystemState::getNonSafeCutOffPathVector ( ) const

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

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

Definition at line 115 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::getReferenceContourStatus ( ) const

Returns if the reference contour status is true.

Returns
If the reference contour status ist true.

Definition at line 85 of file GeneralSystemState.cpp.

std::vector< bool > sick::datastructure::GeneralSystemState::getResetRequiredCutOffPathVector ( ) const

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

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

Definition at line 126 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::getRunModeActive ( ) const

Returns if run mode is active.

Returns
If run mode is active.

Definition at line 45 of file GeneralSystemState.cpp.

std::vector< bool > sick::datastructure::GeneralSystemState::getSafeCutOffPathVector ( ) const

Returns the state for all safe cut off paths.

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

Definition at line 105 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::getStandbyModeActive ( ) const

Returns if the standby mode is active.

Returns
If the standby mode is active.

Definition at line 55 of file GeneralSystemState.cpp.

bool sick::datastructure::GeneralSystemState::isEmpty ( ) const

Return if general system state has been enabled.

Returns
If general system state has been enabled.

Definition at line 201 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setApplicationError ( bool  application_error)

Set if an application error exists.

Parameters
application_errorIf an application error exists.

Definition at line 186 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setContaminationError ( bool  contamination_error)

Set if a contamination error exists.

Parameters
contamination_errorIf a contamination error exists.

Definition at line 80 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setContaminationWarning ( bool  contamination_warning)

Set if a contamination warning exists.

Parameters
contamination_warningIf a contamination warning exists.

Definition at line 70 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setCurrentMonitoringCaseNoTable1 ( const uint8_t &  current_monitoring_case_no_table_1)

Sets the current monitoring case table 1.

Parameters
current_monitoring_case_no_table_1The current monitoring case table 1.

Definition at line 142 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setCurrentMonitoringCaseNoTable2 ( const uint8_t &  current_monitoring_case_no_table_2)

Sets the current monitoring case table 2.

Parameters
current_monitoring_case_no_table_2The current monitoring case table 2.

Definition at line 153 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setCurrentMonitoringCaseNoTable3 ( const uint8_t &  current_monitoring_case_no_table_3)

Sets the current monitoring case table 3.

Parameters
current_monitoring_case_no_table_3The current monitoring case table 3.

Definition at line 164 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setCurrentMonitoringCaseNoTable4 ( const uint8_t &  current_monitoring_case_no_table_4)

Sets the current monitoring case table 4.

Parameters
current_monitoring_case_no_table_4The current monitoring case table 4 .

Definition at line 175 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setDeviceError ( bool  device_error)

Set if a device error exists.

Parameters
device_errorIf a device error exists

Definition at line 196 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setIsEmpty ( bool  is_empty)

Set if general system state has been enabled.

Parameters
is_emptyIf general system state has been enabled.

Definition at line 206 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setManipulationStatus ( bool  manipulation_status)

Set the manipulation status.

Parameters
manipulation_statusThe new manipulation status.

Definition at line 100 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::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_vectorVector for the state of all non-safe cut-off paths

Definition at line 120 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setReferenceContourStatus ( bool  reference_contour_status)

Set the reference contour status.

Parameters
reference_contour_statusThe new reference contour status.

Definition at line 90 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::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_vectorVector for the reset state of all cut-off paths

Definition at line 131 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setRunModeActive ( bool  run_mode_active)

Setter for run mode.

Parameters
run_mode_activeIf run mode is active or inactive.

Definition at line 50 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setSafeCutOffPathvector ( const std::vector< bool > &  safe_cut_off_path_vector)

Sets the state of all safe cut-off paths.

Parameters
safe_cut_off_path_vectorVector for the state of all safe cut-off paths.

Definition at line 110 of file GeneralSystemState.cpp.

void sick::datastructure::GeneralSystemState::setStandbyModeActive ( bool  standby_mode_active)

Setter for standby mode.

Parameters
standby_mode_activeIf standby mode is active or inactive.

Definition at line 60 of file GeneralSystemState.cpp.

Member Data Documentation

bool sick::datastructure::GeneralSystemState::m_application_error
private

Definition at line 268 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_contamination_error
private

Definition at line 255 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_contamination_warning
private

Definition at line 254 of file GeneralSystemState.h.

uint8_t sick::datastructure::GeneralSystemState::m_current_monitoring_case_no_table_1
private

Definition at line 263 of file GeneralSystemState.h.

uint8_t sick::datastructure::GeneralSystemState::m_current_monitoring_case_no_table_2
private

Definition at line 264 of file GeneralSystemState.h.

uint8_t sick::datastructure::GeneralSystemState::m_current_monitoring_case_no_table_3
private

Definition at line 265 of file GeneralSystemState.h.

uint8_t sick::datastructure::GeneralSystemState::m_current_monitoring_case_no_table_4
private

Definition at line 266 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_device_error
private

Definition at line 269 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_is_empty
private

Definition at line 251 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_manipulation_status
private

Definition at line 257 of file GeneralSystemState.h.

std::vector<bool> sick::datastructure::GeneralSystemState::m_non_safe_cut_off_path_vector
private

Definition at line 260 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_reference_contour_status
private

Definition at line 256 of file GeneralSystemState.h.

std::vector<bool> sick::datastructure::GeneralSystemState::m_reset_required_cut_off_path_vector
private

Definition at line 261 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_run_mode_active
private

Definition at line 252 of file GeneralSystemState.h.

std::vector<bool> sick::datastructure::GeneralSystemState::m_safe_cut_off_path_vector
private

Definition at line 259 of file GeneralSystemState.h.

bool sick::datastructure::GeneralSystemState::m_standby_mode_active
private

Definition at line 253 of file GeneralSystemState.h.


The documentation for this class was generated from the following files:


sick_safetyscanners
Author(s): Lennart Puck
autogenerated on Fri Apr 2 2021 02:45:42