Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | List of all members
psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message Class Reference

Higher level data type representing a reply message from the scanner. More...

#include <scanner_reply_msg.h>

Public Types

enum  OperationResult : uint32_t { OperationResult::accepted = 0x00, OperationResult::refused = 0xEB, OperationResult::unknown = 0xFF }
 Defines the operation result from the scanner. More...
 
enum  Type : uint32_t { Type::unknown = 0, Type::start = 0x35, Type::stop = 0x36 }
 Defines the possible types of reply messages which can be received from the scanner. More...
 

Public Member Functions

constexpr Message (const Type &type, const OperationResult &result)
 
constexpr OperationResult result () const
 
constexpr Type type () const
 

Static Public Member Functions

static constexpr OperationResult convertToOperationResult (const uint32_t &value)
 
static constexpr Type convertToReplyType (const uint32_t &value)
 

Static Public Attributes

static constexpr std::size_t SIZE { 16u }
 

Private Attributes

const OperationResult result_
 
const Type type_
 

Detailed Description

Higher level data type representing a reply message from the scanner.

Definition at line 33 of file scanner_reply_msg.h.

Member Enumeration Documentation

◆ OperationResult

Defines the operation result from the scanner.

Enumerator
accepted 
refused 
unknown 

Definition at line 45 of file scanner_reply_msg.h.

◆ Type

Defines the possible types of reply messages which can be received from the scanner.

Enumerator
unknown 
start 
stop 

Definition at line 37 of file scanner_reply_msg.h.

Constructor & Destructor Documentation

◆ Message()

constexpr psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::Message ( const Type type,
const OperationResult result 
)
inlineconstexpr

Definition at line 90 of file scanner_reply_msg.h.

Member Function Documentation

◆ convertToOperationResult()

constexpr Message::OperationResult psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::convertToOperationResult ( const uint32_t &  value)
inlinestaticconstexpr

Definition at line 80 of file scanner_reply_msg.h.

◆ convertToReplyType()

constexpr Message::Type psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::convertToReplyType ( const uint32_t &  value)
inlinestaticconstexpr

Definition at line 70 of file scanner_reply_msg.h.

◆ result()

constexpr Message::OperationResult psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::result ( ) const
inlineconstexpr

Definition at line 99 of file scanner_reply_msg.h.

◆ type()

constexpr Message::Type psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::type ( ) const
inlineconstexpr

Definition at line 94 of file scanner_reply_msg.h.

Member Data Documentation

◆ result_

const OperationResult psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::result_
private

Definition at line 67 of file scanner_reply_msg.h.

◆ SIZE

constexpr std::size_t psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::SIZE { 16u }
staticconstexpr

Definition at line 53 of file scanner_reply_msg.h.

◆ type_

const Type psen_scan_v2_standalone::data_conversion_layer::scanner_reply::Message::type_
private

Definition at line 66 of file scanner_reply_msg.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 25 2023 03:46:26