Public Member Functions | Private Attributes | Friends | List of all members
psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message Class Reference

Defines an Diagnostic message by defining the ErrorLocation and a scanner ID. More...

#include <diagnostics.h>

Public Member Functions

constexpr ErrorType diagnosticCode () const
 
constexpr ErrorLocation errorLocation () const
 
constexpr Message (const configuration::ScannerId &id, const diagnostic::ErrorLocation &location)
 
constexpr bool operator== (const diagnostic::Message &rhs) const
 
constexpr configuration::ScannerId scannerId () const
 

Private Attributes

ErrorLocation error_location_
 
configuration::ScannerId id_
 

Friends

RawChunk serialize (const std::vector< diagnostic::Message > &messages)
 

Detailed Description

Defines an Diagnostic message by defining the ErrorLocation and a scanner ID.

With the provided information a message can be generated for this specific diagnostic incident. The Message object then can be used in an std::ostream to print the diagnostic message defined in the error_code_to_string array.

See also
data_conversion_layer::monitoring_frame::diagnostic::ErrorLocation
data_conversion_layer::monitoring_frame::diagnostic::error_bits
data_conversion_layer::monitoring_frame::diagnostic::error_code_to_string

Definition at line 181 of file diagnostics.h.

Constructor & Destructor Documentation

◆ Message()

constexpr psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message::Message ( const configuration::ScannerId id,
const diagnostic::ErrorLocation location 
)
inline

Definition at line 209 of file diagnostics.h.

Member Function Documentation

◆ diagnosticCode()

constexpr ErrorType psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message::diagnosticCode ( ) const
inline

Definition at line 199 of file diagnostics.h.

◆ errorLocation()

constexpr ErrorLocation psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message::errorLocation ( ) const
inline

Definition at line 194 of file diagnostics.h.

◆ operator==()

constexpr bool psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message::operator== ( const diagnostic::Message rhs) const
inline

Definition at line 214 of file diagnostics.h.

◆ scannerId()

constexpr configuration::ScannerId psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message::scannerId ( ) const
inline

Definition at line 189 of file diagnostics.h.

Friends And Related Function Documentation

◆ serialize

RawChunk serialize ( const std::vector< diagnostic::Message > &  messages)
friend

Member Data Documentation

◆ error_location_

ErrorLocation psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message::error_location_
private

Definition at line 206 of file diagnostics.h.

◆ id_

configuration::ScannerId psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::Message::id_
private

Definition at line 205 of file diagnostics.h.


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


psen_scan_v2
Author(s): Pilz GmbH + Co. KG
autogenerated on Sat Nov 5 2022 02:13:36