External serialize buffer with no copy semantics. More...

#include <Fw/Types/Serializable.hpp>

Inheritance diagram for Fw::ExternalSerializeBuffer:

Public Member Functions
	ExternalSerializeBuffer (U8 *buffPtr, Serializable::SizeType size)
	construct with external buffer More...

	ExternalSerializeBuffer ()
	default constructor More...

	~ExternalSerializeBuffer ()

void	setExtBuffer (U8 *buffPtr, Serializable::SizeType size)

void	clear ()
	clear external buffer More...

	ExternalSerializeBuffer (const ExternalSerializeBuffer &src)=delete
	deleted copy constructor More...

Serializable::SizeType	getBuffCapacity () const
	returns capacity, not current size, of buffer More...

U8 *	getBuffAddr ()
	gets buffer address for data filling More...

const U8 *	getBuffAddr () const
	gets buffer address for data reading, const version More...

ExternalSerializeBuffer &	operator= (const SerializeBufferBase &src)=delete
	deleted copy assignment operator More...

Public Member Functions inherited from Fw::SerializeBufferBase
virtual	~SerializeBufferBase ()
	destructor More...

SerializeStatus	serializeFrom (U8 val)
	serialize 8-bit unsigned int More...

SerializeStatus	serializeFrom (I8 val)
	serialize 8-bit signed int More...

SerializeStatus	serializeFrom (F32 val)
	serialize 32-bit floating point More...

SerializeStatus	serializeFrom (F64 val)
	serialize 64-bit floating point More...

SerializeStatus	serializeFrom (bool val)
	serialize boolean More...

SerializeStatus	serializeFrom (const void *val)
	serialize pointer (careful, only pointer value, not contents are serialized) More...

SerializeStatus	serializeFrom (const U8 *buff, FwSizeType length)
	serialize data buffer More...

SerializeStatus	serializeFrom (const U8 *buff, FwSizeType length, Serialization::t mode)
	serialize a byte buffer of a given length More...

SerializeStatus	serializeFrom (const SerializeBufferBase &val)
	serialize a serialized buffer More...

SerializeStatus	serializeFrom (const Serializable &val)
	serialize an object derived from serializable base class More...

SerializeStatus	serializeSize (const FwSizeType size)
	serialize a size value More...

SerializeStatus	deserializeTo (U8 &val)
	deserialize 8-bit unsigned int More...

SerializeStatus	deserializeTo (I8 &val)
	deserialize 8-bit signed int More...

SerializeStatus	deserializeTo (F32 &val)
	deserialize 32-bit floating point More...

SerializeStatus	deserializeTo (F64 &val)
	deserialize 64-bit floating point More...

SerializeStatus	deserializeTo (bool &val)
	deserialize boolean More...

SerializeStatus	deserializeTo (void *&val)
	deserialize point value (careful, pointer value only, not contents) More...

SerializeStatus	deserializeTo (U8 *buff, FwSizeType &length)
	deserialize data buffer More...

SerializeStatus	deserializeTo (U8 *buff, FwSizeType &length, Serialization::t mode)
	deserialize a byte buffer of a given length More...

SerializeStatus	deserializeTo (Serializable &val)
	deserialize an object derived from serializable base class More...

SerializeStatus	deserializeTo (SerializeBufferBase &val)
	serialize a serialized buffer More...

SerializeStatus	deserializeSize (FwSizeType &size)
	deserialize a size value More...

SerializeStatus	serialize (U8 val)

SerializeStatus	serialize (I8 val)

SerializeStatus	serialize (F32 val)

SerializeStatus	serialize (F64 val)

SerializeStatus	serialize (bool val)

SerializeStatus	serialize (const void *val)

	DEPRECATED (SerializeStatus serialize(const U8 buff, FwSizeType length, bool noLength), "Use serialize(const U8 buff, FwSizeType length, Serialization::t mode) instead")

SerializeStatus	serialize (const U8 *buff, FwSizeType length)

SerializeStatus	serialize (const U8 *buff, FwSizeType length, Serialization::t mode)

SerializeStatus	serialize (const Serializable &val)

SerializeStatus	serialize (const SerializeBufferBase &val)

SerializeStatus	deserialize (U8 &val)

SerializeStatus	deserialize (I8 &val)

SerializeStatus	deserialize (F32 &val)

SerializeStatus	deserialize (F64 &val)

SerializeStatus	deserialize (bool &val)

SerializeStatus	deserialize (void *&val)

	DEPRECATED (SerializeStatus deserialize(U8 buff, FwSizeType &length, bool noLength), "Use deserialize(U8 buff, FwSizeType& length, Serialization::t mode) instead")

SerializeStatus	deserialize (U8 *buff, FwSizeType &length)

SerializeStatus	deserialize (U8 *buff, FwSizeType &length, Serialization::t mode)

SerializeStatus	deserialize (Serializable &val)

SerializeStatus	deserialize (SerializeBufferBase &val)

void	resetSer ()
	reset to beginning of buffer to reuse for serialization More...

void	resetDeser ()
	reset deserialization to beginning More...

SerializeStatus	moveSerToOffset (FwSizeType offset)
	Moves serialization to the specified offset. More...

SerializeStatus	moveDeserToOffset (FwSizeType offset)
	Moves deserialization to the specified offset. More...

SerializeStatus	serializeSkip (FwSizeType numBytesToSkip)
	Skips the number of specified bytes for serialization. More...

SerializeStatus	deserializeSkip (FwSizeType numBytesToSkip)
	Skips the number of specified bytes for deserialization. More...

Serializable::SizeType	getBuffLength () const
	returns current buffer size More...

Serializable::SizeType	getBuffLeft () const
	returns how much deserialization buffer is left More...

const U8 *	getBuffAddrLeft () const
	gets address of remaining non-deserialized data. More...

U8 *	getBuffAddrSer ()

SerializeStatus	setBuff (const U8 *src, Serializable::SizeType length)
	sets buffer contents and size More...

SerializeStatus	setBuffLen (Serializable::SizeType length)
	sets buffer length manually after filling with data More...

SerializeStatus	copyRaw (SerializeBufferBase &dest, Serializable::SizeType size)
	directly copies buffer without looking for a size in the stream. More...

SerializeStatus	copyRawOffset (SerializeBufferBase &dest, Serializable::SizeType size)
	directly copies buffer without looking for a size in the stream. More...

Protected Attributes
U8 *	m_buff
	pointer to external buffer More...

Serializable::SizeType	m_buffSize
	size of external buffer More...

Protected Attributes inherited from Fw::SerializeBufferBase
Serializable::SizeType	m_serLoc
	current offset in buffer of serialized data More...

Serializable::SizeType	m_deserLoc
	current offset for deserialization More...

Additional Inherited Members
Protected Member Functions inherited from Fw::SerializeBufferBase
SerializeBufferBase &	operator= (const SerializeBufferBase &src)
	copy assignment operator More...

	SerializeBufferBase ()
	default constructor More...

Detailed Description

External serialize buffer with no copy semantics.

Definition at line 262 of file Serializable.hpp.

Constructor & Destructor Documentation

◆ ExternalSerializeBuffer() [1/3]

Fw::ExternalSerializeBuffer::ExternalSerializeBuffer	(	U8 *	buffPtr,
		Serializable::SizeType	size
	)

construct with external buffer

Definition at line 739 of file Serializable.cpp.

◆ ExternalSerializeBuffer() [2/3]

Fw::ExternalSerializeBuffer::ExternalSerializeBuffer ( )

default constructor

Definition at line 743 of file Serializable.cpp.

◆ ~ExternalSerializeBuffer()

Fw::ExternalSerializeBuffer::~ExternalSerializeBuffer ( )

inline

destructor

Definition at line 266 of file Serializable.hpp.

◆ ExternalSerializeBuffer() [3/3]

Fw::ExternalSerializeBuffer::ExternalSerializeBuffer ( const ExternalSerializeBuffer & src )

delete

deleted copy constructor

Member Function Documentation

◆ clear()

void Fw::ExternalSerializeBuffer::clear ( )

clear external buffer

Definition at line 754 of file Serializable.cpp.

◆ getBuffAddr() [1/2]

U8 * Fw::ExternalSerializeBuffer::getBuffAddr ( )

virtual

gets buffer address for data filling

Implements Fw::SerializeBufferBase.

Definition at line 765 of file Serializable.cpp.

◆ getBuffAddr() [2/2]

const U8 * Fw::ExternalSerializeBuffer::getBuffAddr ( ) const

virtual

gets buffer address for data reading, const version

Implements Fw::SerializeBufferBase.

Definition at line 769 of file Serializable.cpp.

◆ getBuffCapacity()

Serializable::SizeType Fw::ExternalSerializeBuffer::getBuffCapacity ( ) const

virtual

returns capacity, not current size, of buffer

Implements Fw::SerializeBufferBase.

Definition at line 761 of file Serializable.cpp.

◆ operator=()

ExternalSerializeBuffer& Fw::ExternalSerializeBuffer::operator= ( const SerializeBufferBase & src )

delete

deleted copy assignment operator

◆ setExtBuffer()

void Fw::ExternalSerializeBuffer::setExtBuffer	(	U8 *	buffPtr,
		Serializable::SizeType	size
	)

Set the external buffer This action also resets the serialization and deserialization pointers

Definition at line 747 of file Serializable.cpp.

Member Data Documentation

◆ m_buff

U8* Fw::ExternalSerializeBuffer::m_buff

protected

pointer to external buffer

Definition at line 283 of file Serializable.hpp.

◆ m_buffSize

Serializable::SizeType Fw::ExternalSerializeBuffer::m_buffSize

protected

size of external buffer

Definition at line 284 of file Serializable.hpp.

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

Fw/Types/Serializable.hpp
Fw/Types/Serializable.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExternalSerializeBuffer() [1/3]

◆ ExternalSerializeBuffer() [2/3]

◆ ~ExternalSerializeBuffer()

◆ ExternalSerializeBuffer() [3/3]

Member Function Documentation

◆ clear()

◆ getBuffAddr() [1/2]

◆ getBuffAddr() [2/2]

◆ getBuffCapacity()

◆ operator=()

◆ setExtBuffer()

Member Data Documentation

◆ m_buff

◆ m_buffSize