psen_scan_v2_standalone::data_conversion_layer::monitoring_frame Namespace Reference

Namespace containing all things about the MonitoringFrame data strucure. More...

Namespaces
	diagnostic
	Contains all types, etc. needed to describe the diagnostics information contained in a data_conversion_layer::monitoring_frame::Message.
	io
	Contains all types, etc. needed to describe the IOs information contained in a data_conversion_layer::monitoring_frame::Message.

Classes
class	AdditionalFieldHeader
	Definition for the type and length of an additional field in a monitoring frame. More...
class	AdditionalFieldMissing
	Exception thrown if an additional field was missing during deserialization of a Message. More...
class	AdditionalFieldUnexpectedSize
	Exception thrown on problems with the additional fields with fixed size. More...
class	DecodingFailure
	Exception thrown on problems during the extraction of the measurement data. More...
class	FixedFields
	The information included in every single monitoring frame. More...
class	Message
	Higher level data type representing a single monitoring frame. More...
class	MessageBuilder
struct	MessageStamped
	Wrapping class for a Message and its corresponding timestamp. More...

Enumerations
enum	AdditionalFieldHeaderID : AdditionalFieldHeader::Id {   AdditionalFieldHeaderID::io_pin_data = 0x01, AdditionalFieldHeaderID::scan_counter = 0x02, AdditionalFieldHeaderID::zone_set = 0x03, AdditionalFieldHeaderID::diagnostics = 0x04,   AdditionalFieldHeaderID::measurements = 0x05, AdditionalFieldHeaderID::intensities = 0x06, AdditionalFieldHeaderID::end_of_frame = 0x09 }

Functions
monitoring_frame::Message	deserialize (const data_conversion_layer::RawData &data, const std::size_t &num_bytes)
AdditionalFieldHeader	readAdditionalField (std::istream &is, const std::size_t &max_num_bytes)
FixedFields	readFixedFields (std::istream &is)
static constexpr double	toIntensities (const uint16_t &value)
static constexpr double	toMeter (const uint16_t &value)

Variables
static constexpr uint32_t	DEFAULT_DEVICE_STATUS { 0 }
static constexpr uint32_t	GUI_MONITORING_TRANSACTION { 0x05 }
static constexpr uint8_t	MAX_SCANNER_ID { configuration::VALID_SCANNER_IDS.size() - 1 }
static constexpr uint16_t	NO_SIGNAL_ARRIVED { 59956 }
static constexpr uint16_t	NUMBER_OF_BYTES_SCAN_COUNTER { 4 }
static constexpr uint16_t	NUMBER_OF_BYTES_SINGLE_INTENSITY { 2 }
static constexpr uint16_t	NUMBER_OF_BYTES_SINGLE_MEASUREMENT { 2 }
static constexpr uint16_t	NUMBER_OF_BYTES_ZONE_SET { 1 }
static constexpr uint32_t	ONLINE_WORKING_MODE { 0x00 }
static constexpr uint32_t	OP_CODE_MONITORING_FRAME { 0xCA }
static constexpr uint16_t	SIGNAL_TOO_LATE { 59958 }

Detailed Description

Namespace containing all things about the MonitoringFrame data strucure.

The MonitoringFrame is a data structure fitting into a UDP paket, containing for example distance and intensity data, and also diagnostic data. Take a look into the protocol description for more info about the MonitoringFrame data structure.

Enumeration Type Documentation

AdditionalFieldHeaderID

enum psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::AdditionalFieldHeaderID : AdditionalFieldHeader::Id

strong

Enumerator
io_pin_data
scan_counter
zone_set
diagnostics
measurements
intensities
end_of_frame

Definition at line 135 of file monitoring_frame_deserialization.h.

Function Documentation

deserialize()

monitoring_frame::Message psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::deserialize	(	const data_conversion_layer::RawData &	data,
		const std::size_t &	num_bytes
	)

Definition at line 79 of file monitoring_frame_deserialization.cpp.

readAdditionalField()

AdditionalFieldHeader psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::readAdditionalField	(	std::istream &	is,
		const std::size_t &	max_num_bytes
	)

Definition at line 166 of file monitoring_frame_deserialization.cpp.

readFixedFields()

FixedFields psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::readFixedFields

(

std::istream &

is

)

Definition at line 232 of file monitoring_frame_deserialization.cpp.

toIntensities()

static constexpr double psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::toIntensities ( const uint16_t &  value )

staticconstexpr

Definition at line 72 of file monitoring_frame_deserialization.cpp.

toMeter()

static constexpr double psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::toMeter ( const uint16_t &  value )

staticconstexpr

Definition at line 63 of file monitoring_frame_deserialization.cpp.

Variable Documentation

DEFAULT_DEVICE_STATUS

constexpr uint32_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::DEFAULT_DEVICE_STATUS { 0 }

staticconstexpr

Definition at line 53 of file monitoring_frame_deserialization.h.

GUI_MONITORING_TRANSACTION

constexpr uint32_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::GUI_MONITORING_TRANSACTION { 0x05 }

staticconstexpr

Definition at line 56 of file monitoring_frame_deserialization.h.

MAX_SCANNER_ID

constexpr uint8_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::MAX_SCANNER_ID { configuration::VALID_SCANNER_IDS.size() - 1 }

staticconstexpr

Definition at line 44 of file monitoring_frame_msg.h.

NO_SIGNAL_ARRIVED

constexpr uint16_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::NO_SIGNAL_ARRIVED { 59956 }

staticconstexpr

Definition at line 60 of file monitoring_frame_deserialization.h.

NUMBER_OF_BYTES_SCAN_COUNTER

constexpr uint16_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::NUMBER_OF_BYTES_SCAN_COUNTER { 4 }

staticconstexpr

Definition at line 57 of file monitoring_frame_deserialization.h.

NUMBER_OF_BYTES_SINGLE_INTENSITY

constexpr uint16_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::NUMBER_OF_BYTES_SINGLE_INTENSITY { 2 }

staticconstexpr

Definition at line 62 of file monitoring_frame_deserialization.h.

NUMBER_OF_BYTES_SINGLE_MEASUREMENT

constexpr uint16_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::NUMBER_OF_BYTES_SINGLE_MEASUREMENT { 2 }

staticconstexpr

Definition at line 59 of file monitoring_frame_deserialization.h.

NUMBER_OF_BYTES_ZONE_SET

constexpr uint16_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::NUMBER_OF_BYTES_ZONE_SET { 1 }

staticconstexpr

Definition at line 58 of file monitoring_frame_deserialization.h.

ONLINE_WORKING_MODE

constexpr uint32_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::ONLINE_WORKING_MODE { 0x00 }

staticconstexpr

Definition at line 55 of file monitoring_frame_deserialization.h.

OP_CODE_MONITORING_FRAME

constexpr uint32_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::OP_CODE_MONITORING_FRAME { 0xCA }

staticconstexpr

Definition at line 54 of file monitoring_frame_deserialization.h.

SIGNAL_TOO_LATE

constexpr uint16_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::SIGNAL_TOO_LATE { 59958 }

staticconstexpr

Definition at line 61 of file monitoring_frame_deserialization.h.