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

Defines a byte and bit position of an error in the diagnostic chunk. More...

#include <diagnostics.h>

Public Types

using BitLocation = size_t
 
using ByteLocation = size_t
 

Public Member Functions

constexpr BitLocation bit () const
 
constexpr ByteLocation byte () const
 
constexpr ErrorLocation (const ByteLocation &byte, const BitLocation &bit)
 

Private Attributes

BitLocation bit_
 
ByteLocation byte_
 

Detailed Description

Defines a byte and bit position of an error in the diagnostic chunk.

The diagnostic chunk provided by the scanner when diagnostics are enabled in the ScannerConfiguration is a set of error bits stored in consecutive bytes.

This class helps defining the positions of those error bits.

See also
data_conversion_layer::monitoring_frame::diagnostic::error_bits
ScannerConfiguration

Definition at line 148 of file diagnostics.h.

Member Typedef Documentation

◆ BitLocation

Definition at line 152 of file diagnostics.h.

◆ ByteLocation

Definition at line 151 of file diagnostics.h.

Constructor & Destructor Documentation

◆ ErrorLocation()

constexpr psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::ErrorLocation::ErrorLocation ( const ByteLocation byte,
const BitLocation bit 
)
inlineconstexpr

Definition at line 153 of file diagnostics.h.

Member Function Documentation

◆ bit()

constexpr BitLocation psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::ErrorLocation::bit ( ) const
inlineconstexpr

Definition at line 160 of file diagnostics.h.

◆ byte()

constexpr ByteLocation psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::ErrorLocation::byte ( ) const
inlineconstexpr

Definition at line 155 of file diagnostics.h.

Member Data Documentation

◆ bit_

BitLocation psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::ErrorLocation::bit_
private

Definition at line 167 of file diagnostics.h.

◆ byte_

ByteLocation psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::diagnostic::ErrorLocation::byte_
private

Definition at line 163 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 25 2023 03:46:26