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

The applications inputs from a udp data packet. More...

#include <ApplicationInputs.h>

Public Member Functions

 ApplicationInputs ()
 Constructor of application inputs. More...
 
std::vector< bool > getMonitoringCaseFlagsVector () const
 Gets the monitoring case flags. More...
 
std::vector< uint16_t > getMonitoringCasevector () const
 Gets the monitoring case numbers. More...
 
int8_t getSleepModeInput () const
 Gets the state of the sleep mode. More...
 
std::vector< bool > getUnsafeInputsFlagsVector () const
 Gets the flags for the unsafe input sources. More...
 
std::vector< bool > getUnsafeInputsInputSourcesVector () const
 Gets the unsafe input sources. More...
 
int16_t getVelocity0 () const
 Gets the first linear velocity input. More...
 
bool getVelocity0TransmittedSafely () const
 Gets if first linear velocity input is transmitted safely. More...
 
bool getVelocity0Valid () const
 Gets if first linear velocity input is valid. More...
 
int16_t getVelocity1 () const
 Gets the second linear velocity input. More...
 
bool getVelocity1TransmittedSafely () const
 Gets if second linear velocity input is transmitted safely. More...
 
bool getVelocity1Valid () const
 Gets if second linear velocity input is valid. More...
 
void setMonitoringCaseFlagsVector (const std::vector< bool > &monitoring_case_flags_vector)
 Sets the monitoring case flags. More...
 
void setMonitoringCaseVector (const std::vector< uint16_t > &monitoring_case_vector)
 Sets the monitoring case vector. More...
 
void setSleepModeInput (const int8_t &sleep_mode_input)
 Sets the state of the sleep mode. More...
 
void setUnsafeInputsFlagsVector (const std::vector< bool > &unsafe_inputs_flags_vector)
 Sets the unsafe input sources flags. More...
 
void setUnsafeInputsInputSourcesVector (const std::vector< bool > &unsafe_inputs_input_sources_vector)
 Sets the unsafe input sources. More...
 
void setVelocity0 (const int16_t &velocity_0)
 Sets the first linear velocity input. More...
 
void setVelocity0TransmittedSafely (bool velocity_0_transmitted_safely)
 Sets if first linear velocity input is transmitted safely. More...
 
void setVelocity0Valid (bool velocity_0_valid)
 Sets if first linear velocity input is valid. More...
 
void setVelocity1 (const int16_t &velocity_1)
 Sets the second linear velocity input. More...
 
void setVelocity1TransmittedSafely (bool velocity_1_transmitted_safely)
 Sets if second linear velocity input is transmitted safely. More...
 
void setVelocity1Valid (bool velocity_1_valid)
 If second linear velocity input is valid. More...
 

Private Attributes

std::vector< bool > m_monitoring_case_flags_vector
 
std::vector< uint16_t > m_monitoring_case_vector
 
int8_t m_sleep_mode_input
 
std::vector< bool > m_unsafe_inputs_flags_vector
 
std::vector< bool > m_unsafe_inputs_input_sources_vector
 
int16_t m_velocity_0
 
bool m_velocity_0_transmitted_safely
 
bool m_velocity_0_valid
 
int16_t m_velocity_1
 
bool m_velocity_1_transmitted_safely
 
bool m_velocity_1_valid
 

Detailed Description

The applications inputs from a udp data packet.

Definition at line 47 of file ApplicationInputs.h.

Constructor & Destructor Documentation

sick::datastructure::ApplicationInputs::ApplicationInputs ( )

Constructor of application inputs.

Definition at line 40 of file ApplicationInputs.cpp.

Member Function Documentation

std::vector< bool > sick::datastructure::ApplicationInputs::getMonitoringCaseFlagsVector ( ) const

Gets the monitoring case flags.

Returns
The monitoring case flags.

Definition at line 74 of file ApplicationInputs.cpp.

std::vector< uint16_t > sick::datastructure::ApplicationInputs::getMonitoringCasevector ( ) const

Gets the monitoring case numbers.

Returns
The monitoring case vector.

Definition at line 64 of file ApplicationInputs.cpp.

int8_t sick::datastructure::ApplicationInputs::getSleepModeInput ( ) const

Gets the state of the sleep mode.

Returns
The state of the sleep mode.

Definition at line 145 of file ApplicationInputs.cpp.

std::vector< bool > sick::datastructure::ApplicationInputs::getUnsafeInputsFlagsVector ( ) const

Gets the flags for the unsafe input sources.

There is one flag (bit) for each static input source. If the flag is HIGH, the corresponding input source is available to be used by the application.

Returns
The unsafe input sources flags.

Definition at line 53 of file ApplicationInputs.cpp.

std::vector< bool > sick::datastructure::ApplicationInputs::getUnsafeInputsInputSourcesVector ( ) const

Gets the unsafe input sources.

The individual bits represent the current state of the static input sources used for monitoring case switching

Returns
The unsafe input sources.

Definition at line 42 of file ApplicationInputs.cpp.

int16_t sick::datastructure::ApplicationInputs::getVelocity0 ( ) const

Gets the first linear velocity input.

Returns
The first linear velocity input.

Definition at line 85 of file ApplicationInputs.cpp.

bool sick::datastructure::ApplicationInputs::getVelocity0TransmittedSafely ( ) const

Gets if first linear velocity input is transmitted safely.

Returns
If first linear velocity input is transmitted safely.

Definition at line 125 of file ApplicationInputs.cpp.

bool sick::datastructure::ApplicationInputs::getVelocity0Valid ( ) const

Gets if first linear velocity input is valid.

Returns
If first linear velocity input is valid.

Definition at line 105 of file ApplicationInputs.cpp.

int16_t sick::datastructure::ApplicationInputs::getVelocity1 ( ) const

Gets the second linear velocity input.

Returns
The second linear velocity input

Definition at line 95 of file ApplicationInputs.cpp.

bool sick::datastructure::ApplicationInputs::getVelocity1TransmittedSafely ( ) const

Gets if second linear velocity input is transmitted safely.

Returns
If second linear velocity input is transmitted safely.

Definition at line 135 of file ApplicationInputs.cpp.

bool sick::datastructure::ApplicationInputs::getVelocity1Valid ( ) const

Gets if second linear velocity input is valid.

Returns
If second linear velocity input is valid.

Definition at line 115 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setMonitoringCaseFlagsVector ( const std::vector< bool > &  monitoring_case_flags_vector)

Sets the monitoring case flags.

Parameters
monitoring_case_flags_vectorThe monitoring case flags.

Definition at line 79 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setMonitoringCaseVector ( const std::vector< uint16_t > &  monitoring_case_vector)

Sets the monitoring case vector.

Parameters
monitoring_case_vectorThe monitoring case vector.

Definition at line 69 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setSleepModeInput ( const int8_t &  sleep_mode_input)

Sets the state of the sleep mode.

Parameters
sleep_mode_inputThe state of the sleep mode.

Definition at line 150 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setUnsafeInputsFlagsVector ( const std::vector< bool > &  unsafe_inputs_flags_vector)

Sets the unsafe input sources flags.

Parameters
unsafe_inputs_flags_vectorThe unsafe input sources flags.

Definition at line 58 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setUnsafeInputsInputSourcesVector ( const std::vector< bool > &  unsafe_inputs_input_sources_vector)

Sets the unsafe input sources.

Parameters
unsafe_inputs_input_sources_vectorThe unsafe input sources.

Definition at line 47 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setVelocity0 ( const int16_t &  velocity_0)

Sets the first linear velocity input.

Parameters
velocity_0The first linear velocity input.

Definition at line 90 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setVelocity0TransmittedSafely ( bool  velocity_0_transmitted_safely)

Sets if first linear velocity input is transmitted safely.

Parameters
velocity_0_transmitted_safely

Definition at line 130 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setVelocity0Valid ( bool  velocity_0_valid)

Sets if first linear velocity input is valid.

Parameters
velocity_0_validIf first linear velocity input is valid.

Definition at line 110 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setVelocity1 ( const int16_t &  velocity_1)

Sets the second linear velocity input.

Parameters
velocity_1The second linear velocity input.

Definition at line 100 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setVelocity1TransmittedSafely ( bool  velocity_1_transmitted_safely)

Sets if second linear velocity input is transmitted safely.

Parameters
velocity_1_transmitted_safelyIf second linear velocity input is transmitted safely.

Definition at line 140 of file ApplicationInputs.cpp.

void sick::datastructure::ApplicationInputs::setVelocity1Valid ( bool  velocity_1_valid)

If second linear velocity input is valid.

Parameters
velocity_1_validIf second linear velocity input is valid.

Definition at line 120 of file ApplicationInputs.cpp.

Member Data Documentation

std::vector<bool> sick::datastructure::ApplicationInputs::m_monitoring_case_flags_vector
private

Definition at line 211 of file ApplicationInputs.h.

std::vector<uint16_t> sick::datastructure::ApplicationInputs::m_monitoring_case_vector
private

Definition at line 210 of file ApplicationInputs.h.

int8_t sick::datastructure::ApplicationInputs::m_sleep_mode_input
private

Definition at line 221 of file ApplicationInputs.h.

std::vector<bool> sick::datastructure::ApplicationInputs::m_unsafe_inputs_flags_vector
private

Definition at line 208 of file ApplicationInputs.h.

std::vector<bool> sick::datastructure::ApplicationInputs::m_unsafe_inputs_input_sources_vector
private

Definition at line 207 of file ApplicationInputs.h.

int16_t sick::datastructure::ApplicationInputs::m_velocity_0
private

Definition at line 213 of file ApplicationInputs.h.

bool sick::datastructure::ApplicationInputs::m_velocity_0_transmitted_safely
private

Definition at line 218 of file ApplicationInputs.h.

bool sick::datastructure::ApplicationInputs::m_velocity_0_valid
private

Definition at line 216 of file ApplicationInputs.h.

int16_t sick::datastructure::ApplicationInputs::m_velocity_1
private

Definition at line 214 of file ApplicationInputs.h.

bool sick::datastructure::ApplicationInputs::m_velocity_1_transmitted_safely
private

Definition at line 219 of file ApplicationInputs.h.

bool sick::datastructure::ApplicationInputs::m_velocity_1_valid
private

Definition at line 217 of file ApplicationInputs.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