psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message Class Reference

Higher level data type representing a single monitoring frame. More...

#include <monitoring_frame_msg.h>

Public Member Functions
uint8_t	activeZoneset () const
std::vector< diagnostic::Message >	diagnosticMessages () const
util::TenthOfDegree	fromTheta () const
bool	hasActiveZonesetField () const
bool	hasDiagnosticMessagesField () const
bool	hasIntensitiesField () const
bool	hasIOPinField () const
bool	hasMeasurementsField () const
bool	hasScanCounterField () const
const std::vector< double > &	intensities () const
const io::PinData &	iOPinData () const
const std::vector< double > &	measurements () const
util::TenthOfDegree	resolution () const
uint32_t	scanCounter () const
configuration::ScannerId	scannerId () const

Private Attributes
boost::optional< uint8_t >	active_zoneset_
boost::optional< std::vector< diagnostic::Message > >	diagnostic_messages_
util::TenthOfDegree	from_theta_ { 0 }
boost::optional< std::vector< double > >	intensities_
boost::optional< io::PinData >	io_pin_data_
boost::optional< std::vector< double > >	measurements_
util::TenthOfDegree	resolution_ { 1 }
boost::optional< uint32_t >	scan_counter_
configuration::ScannerId	scanner_id_ { configuration::ScannerId::master }

Friends
class	MessageBuilder

Detailed Description

Higher level data type representing a single monitoring frame.

It contains all information deserialized from a single monitoring frame sent by the scanner hardware.

See also

monitoring_frame

Definition at line 62 of file monitoring_frame_msg.h.

Member Function Documentation

activeZoneset()

uint8_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::activeZoneset

(

)

const

Exceptions

AdditionalFieldMissing

if active_zoneset was missing during deserialization of a Message.

Definition at line 58 of file monitoring_frame_msg.cpp.

diagnosticMessages()

std::vector< diagnostic::Message > psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::diagnosticMessages

(

)

const

Exceptions

AdditionalFieldMissing

if diagnostic_messages were missing during deserialization of a Message.

Definition at line 106 of file monitoring_frame_msg.cpp.

fromTheta()

util::TenthOfDegree psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::fromTheta

(

)

const

Definition at line 36 of file monitoring_frame_msg.cpp.

hasActiveZonesetField()

bool psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::hasActiveZonesetField

(

)

const

Definition at line 123 of file monitoring_frame_msg.cpp.

hasDiagnosticMessagesField()

bool psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::hasDiagnosticMessagesField

(

)

const

Definition at line 143 of file monitoring_frame_msg.cpp.

hasIntensitiesField()

bool psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::hasIntensitiesField

(

)

const

Definition at line 138 of file monitoring_frame_msg.cpp.

hasIOPinField()

bool psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::hasIOPinField

(

)

const

Definition at line 128 of file monitoring_frame_msg.cpp.

hasMeasurementsField()

bool psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::hasMeasurementsField

(

)

const

Definition at line 133 of file monitoring_frame_msg.cpp.

hasScanCounterField()

bool psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::hasScanCounterField

(

)

const

Definition at line 118 of file monitoring_frame_msg.cpp.

intensities()

const std::vector< double > & psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::intensities

(

)

const

Exceptions

AdditionalFieldMissing

if intensities were missing during deserialization of a Message.

Definition at line 94 of file monitoring_frame_msg.cpp.

iOPinData()

const io::PinData & psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::iOPinData

(

)

const

Exceptions

AdditionalFieldMissing

if io_pin_data was missing during deserialization of a Message.

Definition at line 70 of file monitoring_frame_msg.cpp.

measurements()

const std::vector< double > & psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::measurements

(

)

const

Exceptions

AdditionalFieldMissing

if measurements were missing during deserialization of a Message.

Definition at line 82 of file monitoring_frame_msg.cpp.

resolution()

util::TenthOfDegree psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::resolution

(

)

const

Definition at line 41 of file monitoring_frame_msg.cpp.

scanCounter()

uint32_t psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::scanCounter

(

)

const

Exceptions

AdditionalFieldMissing

if scan_counter was missing during deserialization of a Message.

Definition at line 46 of file monitoring_frame_msg.cpp.

scannerId()

configuration::ScannerId psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::scannerId

(

)

const

Definition at line 31 of file monitoring_frame_msg.cpp.

Friends And Related Function Documentation

MessageBuilder

friend class MessageBuilder

friend

Definition at line 102 of file monitoring_frame_msg.h.

Member Data Documentation

active_zoneset_

boost::optional<uint8_t> psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::active_zoneset_

private

Definition at line 95 of file monitoring_frame_msg.h.

diagnostic_messages_

boost::optional<std::vector<diagnostic::Message> > psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::diagnostic_messages_

private

Definition at line 99 of file monitoring_frame_msg.h.

from_theta_

util::TenthOfDegree psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::from_theta_ { 0 }

private

Definition at line 91 of file monitoring_frame_msg.h.

intensities_

boost::optional<std::vector<double> > psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::intensities_

private

Definition at line 98 of file monitoring_frame_msg.h.

io_pin_data_

boost::optional<io::PinData> psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::io_pin_data_

private

Definition at line 96 of file monitoring_frame_msg.h.

measurements_

boost::optional<std::vector<double> > psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::measurements_

private

Definition at line 97 of file monitoring_frame_msg.h.

resolution_

util::TenthOfDegree psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::resolution_ { 1 }

private

Definition at line 92 of file monitoring_frame_msg.h.

scan_counter_

boost::optional<uint32_t> psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::scan_counter_

private

Definition at line 94 of file monitoring_frame_msg.h.

scanner_id_

configuration::ScannerId psen_scan_v2_standalone::data_conversion_layer::monitoring_frame::Message::scanner_id_ { configuration::ScannerId::master }

private

Definition at line 90 of file monitoring_frame_msg.h.

---

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

• monitoring_frame_msg.h
• monitoring_frame_msg.cpp