A class that does the message deserialization. More...

#include <messageserializer.h>

Public Member Functions
bool	atEnd () const
	Checks if we are at the end of message. More...

XsSize	index () const

const XsMessage &	message () const

	MessageDeserializer (const XsMessage &message, XsSize offset=0)
	Default constructor. More...

MessageDeserializer &	operator>> (int16_t &value)
	Input stream operator that takes a int16_t from the stream. More...

MessageDeserializer &	operator>> (int32_t &value)
	Input stream operator that takes a int32_t from the stream. More...

MessageDeserializer &	operator>> (int64_t &value)
	Input stream operator that takes a int64_t from the stream. More...

MessageDeserializer &	operator>> (int8_t &value)
	Input stream operator that takes a int8_t from the stream. More...

MessageDeserializer &	operator>> (uint16_t &value)
	Input stream operator that takes a uint16_t from the stream. More...

MessageDeserializer &	operator>> (uint32_t &value)
	Input stream operator that takes a uint32_t from the stream. More...

MessageDeserializer &	operator>> (uint64_t &value)
	Input stream operator that takes a uint64_t from the stream. More...

MessageDeserializer &	operator>> (uint8_t &value)
	Input stream operator that takes a uint8_t from the stream. More...

MessageDeserializer &	operator>> (XsCanDataIdentifier &value)
	Input stream operator that takes a XsCanDataIdentifier from the stream. More...

MessageDeserializer &	operator>> (XsCanFrameFormat &value)
	Input stream operator that takes a XsCanIdLength from the stream. More...

MessageDeserializer &	operator>> (XsCanOutputConfiguration &cfg)
	Input stream operator that takes a XsCanOutputConfiguration from the stream. More...

MessageDeserializer &	operator>> (XsCanOutputConfigurationArray &config)
	Input stream operator that takes a XsCanOutputConfigurationArray from the stream. More...

MessageDeserializer &	operator>> (XsDataIdentifier &value)
	Input stream operator that takes a XsDataIdentifier from the stream. More...

MessageDeserializer &	operator>> (XsDeviceId &id)
	Input stream operator that takes a XsDeviceId from the stream. More...

MessageDeserializer &	operator>> (XsOutputConfiguration &cfg)
	Input stream operator that takes a XsOutputConfiguration from the stream. More...

MessageDeserializer &	operator>> (XsOutputConfigurationArray &config)
	Input stream operator that takes a XsOutputConfigurationArray from the stream. More...

virtual	~MessageDeserializer ()
	Destructor. More...

Private Attributes
XsSize	m_index

const XsMessage &	m_message

Detailed Description

A class that does the message deserialization.

Definition at line 149 of file messageserializer.h.

Constructor & Destructor Documentation

◆ MessageDeserializer()

MessageDeserializer::MessageDeserializer	(	const XsMessage &	message,
		XsSize	offset = `0`
	)

Default constructor.

Definition at line 254 of file messageserializer.cpp.

◆ ~MessageDeserializer()

MessageDeserializer::~MessageDeserializer ( )

virtual

Destructor.

Definition at line 262 of file messageserializer.cpp.

Member Function Documentation

◆ atEnd()

bool MessageDeserializer::atEnd ( ) const

Checks if we are at the end of message.

Returns: true if we are at the end.

Definition at line 430 of file messageserializer.cpp.

◆ index()

XsSize MessageDeserializer::index ( ) const

inline

Returns: The current index

Definition at line 207 of file messageserializer.h.

◆ message()

const XsMessage& MessageDeserializer::message ( ) const

inline

Returns: The current message

Definition at line 201 of file messageserializer.h.

◆ operator>>() [1/16]

MessageDeserializer& MessageDeserializer::operator>> ( int16_t & value )

inline

Input stream operator that takes a int16_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 187 of file messageserializer.h.

◆ operator>>() [2/16]

MessageDeserializer& MessageDeserializer::operator>> ( int32_t & value )

inline

Input stream operator that takes a int32_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 178 of file messageserializer.h.

◆ operator>>() [3/16]

MessageDeserializer& MessageDeserializer::operator>> ( int64_t & value )

inline

Input stream operator that takes a int64_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 169 of file messageserializer.h.

◆ operator>>() [4/16]

MessageDeserializer & MessageDeserializer::operator>> ( int8_t & value )

Input stream operator that takes a int8_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 337 of file messageserializer.cpp.

◆ operator>>() [5/16]

MessageDeserializer & MessageDeserializer::operator>> ( uint16_t & value )

Input stream operator that takes a uint16_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 348 of file messageserializer.cpp.

◆ operator>>() [6/16]

MessageDeserializer & MessageDeserializer::operator>> ( uint32_t & value )

Input stream operator that takes a uint32_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 359 of file messageserializer.cpp.

◆ operator>>() [7/16]

MessageDeserializer & MessageDeserializer::operator>> ( uint64_t & value )

Input stream operator that takes a uint64_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 370 of file messageserializer.cpp.

◆ operator>>() [8/16]

MessageDeserializer & MessageDeserializer::operator>> ( uint8_t & value )

Input stream operator that takes a uint8_t from the stream.

Parameters

value Reference in which the read value is stored

Returns: A reference to this object

Definition at line 326 of file messageserializer.cpp.

◆ operator>>() [9/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsCanDataIdentifier & value )

Input stream operator that takes a XsCanDataIdentifier from the stream.

Parameters

value Reference in which the CAN data identifier is stored

Returns: A reference to this object

Definition at line 282 of file messageserializer.cpp.

◆ operator>>() [10/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsCanFrameFormat & value )

Input stream operator that takes a XsCanIdLength from the stream.

Parameters

value Reference in which the CAN ID length is stored

Returns: A reference to this object

Definition at line 294 of file messageserializer.cpp.

◆ operator>>() [11/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsCanOutputConfiguration & cfg )

Input stream operator that takes a XsCanOutputConfiguration from the stream.

Parameters

cfg	Reference in which the CAN output configuration is stored

Returns: A reference to this object

Definition at line 422 of file messageserializer.cpp.

◆ operator>>() [12/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsCanOutputConfigurationArray & config )

Input stream operator that takes a XsCanOutputConfigurationArray from the stream.

Parameters

config Reference in which the CAN output configuration array is stored

Returns: A reference to this object

Definition at line 406 of file messageserializer.cpp.

◆ operator>>() [13/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsDataIdentifier & value )

Input stream operator that takes a XsDataIdentifier from the stream.

Parameters

value Reference in which the data identifier is stored

Returns: A reference to this object

Definition at line 270 of file messageserializer.cpp.

◆ operator>>() [14/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsDeviceId & value )

Input stream operator that takes a XsDeviceId from the stream.

Parameters

value Reference in which the device ID is stored

Returns: A reference to this object

Definition at line 306 of file messageserializer.cpp.

◆ operator>>() [15/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsOutputConfiguration & cfg )

Input stream operator that takes a XsOutputConfiguration from the stream.

Parameters

cfg	Reference in which the output configuration is stored

Returns: A reference to this object

Definition at line 397 of file messageserializer.cpp.

◆ operator>>() [16/16]

MessageDeserializer & MessageDeserializer::operator>> ( XsOutputConfigurationArray & config )

Input stream operator that takes a XsOutputConfigurationArray from the stream.

Parameters

config Reference in which the output configuration array is stored

Returns: A reference to this object

Definition at line 381 of file messageserializer.cpp.

Member Data Documentation

◆ m_index

XsSize MessageDeserializer::m_index

private

Definition at line 214 of file messageserializer.h.

◆ m_message

const XsMessage& MessageDeserializer::m_message

private

Definition at line 213 of file messageserializer.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MessageDeserializer()

◆ ~MessageDeserializer()

Member Function Documentation

◆ atEnd()

◆ index()

◆ message()

◆ operator>>() [1/16]

◆ operator>>() [2/16]

◆ operator>>() [3/16]

◆ operator>>() [4/16]

◆ operator>>() [5/16]

◆ operator>>() [6/16]

◆ operator>>() [7/16]

◆ operator>>() [8/16]

◆ operator>>() [9/16]

◆ operator>>() [10/16]

◆ operator>>() [11/16]

◆ operator>>() [12/16]

◆ operator>>() [13/16]

◆ operator>>() [14/16]

◆ operator>>() [15/16]

◆ operator>>() [16/16]

Member Data Documentation

◆ m_index

◆ m_message