imt::base::core::serialization::Deserializer Class Reference

Deserializes various data types from the given byte buffer. More...

#include <Imt.Base.Core.Serialization/Deserializer.h>

Public Member Functions
	Deserializer (const uint8_t buffer[], const uint32_t bufferSize)
	Constructor. More...
virtual	~Deserializer (void)
	Destructor. More...
uint32_t	getBufferPos (void) const
	Returns the read position within the byte buffer. More...
uint32_t	getBufferSize (void) const
	Returns the size of the byte buffer in bytes. More...
const uint8_t *	getBuffer (void) const
	Returns a read-only pointer to the byte buffer. More...
uint32_t	getUnusedBufferSize (void) const
	Returns the remaining data to read from the current position until the buffer is empty. More...
bool	isReset (void) const
	Returns true if the read position is at the beginning (getBufferPos == 0). More...
bool	isFullyDeserialized (void) const
	Returns true if buffer is completely deserialized. More...
const uint8_t &	getBufferByte (const uint32_t indexOfByte) const
	Returns the byte of the byte buffer at the given index. More...
void	reset (void)
	Resets the Deserializer. More...
Deserializer &	operator>> (bool &data)
	Returns a boolean out of the Deserializer. More...
Deserializer &	operator>> (uint8_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (char_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (char_t *data)
	Returns a null terminated string out of the Deserializer. More...
Deserializer &	operator>> (int8_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (uint16_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (int16_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (uint32_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (int32_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (uint64_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (int64_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (float32_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	operator>> (float64_t &data)
	Returns data out of the Deserializer. More...
Deserializer &	popData (void *const pDataDest, const uint32_t bytes)
	Returns multiple data out of Deserializer. More...
Deserializer &	operator>> (SerializableIfc &data)
	Returns data out of the Deserializer. More...

Detailed Description

Deserializes various data types from the given byte buffer.

The read position can be set to the beginning by calling reset. Important: The byte buffer passed with the constructor is not copied and only the pointer to the data is stored.

Constructor & Destructor Documentation

Deserializer()

imt::base::core::serialization::Deserializer::Deserializer ( const uint8_t  buffer[], const uint32_t  bufferSize  )

explicit

Constructor.

Parameters

buffer[]	Byte buffer array from which data should be read. Must be valid (!= NULL)!
bufferSize	Size of the byte buffer in number of bytes.

~Deserializer()

virtual imt::base::core::serialization::Deserializer::~Deserializer ( void  )

virtual

Destructor.

Member Function Documentation

getBuffer()

const uint8_t* imt::base::core::serialization::Deserializer::getBuffer

(

void

)

const

Returns a read-only pointer to the byte buffer.

Returns

Read-only pointer to the byte buffer.

getBufferByte()

const uint8_t& imt::base::core::serialization::Deserializer::getBufferByte

(

const uint32_t

indexOfByte

)

const

Returns the byte of the byte buffer at the given index.

Note

If the given index is out of bounds, the value at the last position will be returned.

Parameters

indexOfByte

Byte index.

Returns

Byte at the given index.

getBufferPos()

uint32_t imt::base::core::serialization::Deserializer::getBufferPos

(

void

)

const

Returns the read position within the byte buffer.

Returns

Read position within the byte buffer.

getBufferSize()

uint32_t imt::base::core::serialization::Deserializer::getBufferSize

(

void

)

const

Returns the size of the byte buffer in bytes.

Returns

Size of the byte buffer in bytes.

getUnusedBufferSize()

uint32_t imt::base::core::serialization::Deserializer::getUnusedBufferSize

(

void

)

const

Returns the remaining data to read from the current position until the buffer is empty.

Returns

The remaining bytes to read.

isFullyDeserialized()

bool imt::base::core::serialization::Deserializer::isFullyDeserialized

(

void

)

const

Returns true if buffer is completely deserialized.

Returns

True if buffer is completely deserialized.

isReset()

bool imt::base::core::serialization::Deserializer::isReset

(

void

)

const

Returns true if the read position is at the beginning (getBufferPos == 0).

Returns

True if the read position is at the beginning.

operator>>() [1/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

bool &

data

)

Returns a boolean out of the Deserializer.

Parameters

data	Holds returned boolean.

Returns

Reference to this deserializer.

operator>>() [2/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

char_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [3/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

char_t *

data

)

Returns a null terminated string out of the Deserializer.

Parameters

data	Holds returned string.

Returns

Reference to this deserializer.

operator>>() [4/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

float32_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [5/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

float64_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [6/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

int16_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [7/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

int32_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [8/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

int64_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [9/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

int8_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [10/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

SerializableIfc &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [11/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

uint16_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [12/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

uint32_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [13/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

uint64_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

operator>>() [14/14]

Deserializer& imt::base::core::serialization::Deserializer::operator>>

(

uint8_t &

data

)

Returns data out of the Deserializer.

Parameters

data	Holds returned data.

Returns

Reference to this deserializer.

popData()

Deserializer& imt::base::core::serialization::Deserializer::popData	(	void *const	pDataDest,
		const uint32_t	bytes
	)

Returns multiple data out of Deserializer.

Parameters

pDataDest	Holds returned data.
bytes	Number of bytes to return.

Returns

Reference to this deserializer.

reset()

void imt::base::core::serialization::Deserializer::reset

(

void

)

Resets the Deserializer.

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.Core.Serialization/Deserializer.h