#include <Fw/Types/Serializable.hpp>

Inheritance diagram for Fw::SerializeBufferBase:

Public Member Functions
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...

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

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

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

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

virtual const U8 *	getBuffAddr () const =0
	gets buffer address for data reading, const version 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 Member Functions
SerializeBufferBase &	operator= (const SerializeBufferBase &src)
	copy assignment operator More...

	SerializeBufferBase ()
	default constructor More...

Protected Attributes
Serializable::SizeType	m_serLoc
	current offset in buffer of serialized data More...

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

Friends
class	SerializeBufferBaseTester

Detailed Description

Definition at line 64 of file Serializable.hpp.

Constructor & Destructor Documentation

◆ ~SerializeBufferBase()

Fw::SerializeBufferBase::~SerializeBufferBase ( )

virtual

destructor

Definition at line 42 of file Serializable.cpp.

◆ SerializeBufferBase()

Fw::SerializeBufferBase::SerializeBufferBase ( )

protected

default constructor

Definition at line 40 of file Serializable.cpp.

Member Function Documentation

◆ copyRaw()

SerializeStatus Fw::SerializeBufferBase::copyRaw	(	SerializeBufferBase &	dest,
		Serializable::SizeType	size
	)

directly copies buffer without looking for a size in the stream.

Definition at line 662 of file Serializable.cpp.

◆ copyRawOffset()

SerializeStatus Fw::SerializeBufferBase::copyRawOffset	(	SerializeBufferBase &	dest,
		Serializable::SizeType	size
	)

directly copies buffer without looking for a size in the stream.

Definition at line 675 of file Serializable.cpp.

◆ DEPRECATED() [1/2]

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

◆ DEPRECATED() [2/2]

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

◆ deserialize() [1/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( U8 & val )

Definition at line 839 of file Serializable.cpp.

◆ deserialize() [2/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( I8 & val )

Definition at line 842 of file Serializable.cpp.

◆ deserialize() [3/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( F32 & val )

Definition at line 869 of file Serializable.cpp.

◆ deserialize() [4/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( F64 & val )

Definition at line 872 of file Serializable.cpp.

◆ deserialize() [5/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( bool & val )

Definition at line 875 of file Serializable.cpp.

◆ deserialize() [6/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( void *& val )

Definition at line 878 of file Serializable.cpp.

◆ deserialize() [7/10]

SerializeStatus Fw::SerializeBufferBase::deserialize	(	U8 *	buff,
		FwSizeType &	length
	)

Definition at line 888 of file Serializable.cpp.

◆ deserialize() [8/10]

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

Definition at line 892 of file Serializable.cpp.

◆ deserialize() [9/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( Serializable & val )

Definition at line 896 of file Serializable.cpp.

◆ deserialize() [10/10]

SerializeStatus Fw::SerializeBufferBase::deserialize ( SerializeBufferBase & val )

Definition at line 899 of file Serializable.cpp.

◆ deserializeSize()

SerializeStatus Fw::SerializeBufferBase::deserializeSize ( FwSizeType & size )

deserialize a size value

Definition at line 572 of file Serializable.cpp.

◆ deserializeSkip()

SerializeStatus Fw::SerializeBufferBase::deserializeSkip ( FwSizeType numBytesToSkip )

Skips the number of specified bytes for deserialization.

Definition at line 604 of file Serializable.cpp.

◆ deserializeTo() [1/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( U8 & val )

deserialize 8-bit unsigned int

Definition at line 292 of file Serializable.cpp.

◆ deserializeTo() [2/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( I8 & val )

deserialize 8-bit signed int

Definition at line 306 of file Serializable.cpp.

◆ deserializeTo() [3/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( F32 & val )

deserialize 32-bit floating point

Definition at line 483 of file Serializable.cpp.

◆ deserializeTo() [4/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( F64 & val )

deserialize 64-bit floating point

Definition at line 439 of file Serializable.cpp.

◆ deserializeTo() [5/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( bool & val )

deserialize boolean

Definition at line 452 of file Serializable.cpp.

◆ deserializeTo() [6/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( void *& val )

deserialize point value (careful, pointer value only, not contents)

Definition at line 473 of file Serializable.cpp.

◆ deserializeTo() [7/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo	(	U8 *	buff,
		FwSizeType &	length
	)

deserialize data buffer

Definition at line 495 of file Serializable.cpp.

◆ deserializeTo() [8/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo	(	U8 *	buff,
		FwSizeType &	length,
		Serialization::t	mode
	)

deserialize a byte buffer of a given length

The mode parameter specifies whether the serialized length should be read from the buffer.

Parameters

buff	buffer to deserialize into
length	length of the buffer, updated with the actual deserialized length
mode	deserialization type

Returns: status of serialization

Definition at line 502 of file Serializable.cpp.

◆ deserializeTo() [9/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( Serializable & val )

deserialize an object derived from serializable base class

Definition at line 536 of file Serializable.cpp.

◆ deserializeTo() [10/10]

SerializeStatus Fw::SerializeBufferBase::deserializeTo ( SerializeBufferBase & val )

serialize a serialized buffer

Definition at line 540 of file Serializable.cpp.

◆ getBuffAddr() [1/2]

virtual U8* Fw::SerializeBufferBase::getBuffAddr ( )

pure virtual

gets buffer address for data filling

Implemented in Fw::ExternalSerializeBuffer, Utils::HashBuffer, Fw::SerialBuffer, Fw::ParamBuffer, Fw::CmdArgBuffer, Fw::ComBuffer, Fw::LogBuffer, Fw::SmSignalBuffer, Fw::TlmBuffer, Drv::DataBuffer, Fw::StatementArgBuffer, and Fw::ActiveComponentExitSerializableBuffer.

◆ getBuffAddr() [2/2]

virtual const U8* Fw::SerializeBufferBase::getBuffAddr ( ) const

pure virtual

gets buffer address for data reading, const version

Implemented in Fw::ExternalSerializeBuffer, Utils::HashBuffer, Fw::SerialBuffer, Fw::ParamBuffer, Fw::CmdArgBuffer, Fw::ComBuffer, Fw::LogBuffer, Fw::SmSignalBuffer, Fw::TlmBuffer, Drv::DataBuffer, Fw::StatementArgBuffer, and Fw::ActiveComponentExitSerializableBuffer.

◆ getBuffAddrLeft()

const U8 * Fw::SerializeBufferBase::getBuffAddrLeft ( ) const

gets address of remaining non-deserialized data.

gets address of end of serialization. Used to manually place data at the end

Definition at line 696 of file Serializable.cpp.

◆ getBuffAddrSer()

U8 * Fw::SerializeBufferBase::getBuffAddrSer ( )

gets address of end of serialization. DANGEROUS! Need to know max buffer size and adjust when done

Definition at line 701 of file Serializable.cpp.

◆ getBuffCapacity()

virtual Serializable::SizeType Fw::SerializeBufferBase::getBuffCapacity ( ) const

pure virtual

returns capacity, not current size, of buffer

Implemented in Fw::ExternalSerializeBuffer, Utils::HashBuffer, Fw::SerialBuffer, Fw::ParamBuffer, Fw::CmdArgBuffer, Fw::ComBuffer, Fw::LogBuffer, Fw::SmSignalBuffer, Fw::TlmBuffer, Drv::DataBuffer, Fw::StatementArgBuffer, and Fw::ActiveComponentExitSerializableBuffer.

◆ getBuffLeft()

Serializable::SizeType Fw::SerializeBufferBase::getBuffLeft ( ) const

returns how much deserialization buffer is left

Definition at line 656 of file Serializable.cpp.

◆ getBuffLength()

Serializable::SizeType Fw::SerializeBufferBase::getBuffLength ( ) const

returns current buffer size

Definition at line 629 of file Serializable.cpp.

◆ moveDeserToOffset()

SerializeStatus Fw::SerializeBufferBase::moveDeserToOffset ( FwSizeType offset )

Moves deserialization to the specified offset.

Definition at line 622 of file Serializable.cpp.

◆ moveSerToOffset()

SerializeStatus Fw::SerializeBufferBase::moveSerToOffset ( FwSizeType offset )

Moves serialization to the specified offset.

Definition at line 616 of file Serializable.cpp.

◆ operator=()

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

protected

copy assignment operator

Definition at line 57 of file Serializable.cpp.

◆ resetDeser()

void Fw::SerializeBufferBase::resetDeser ( )

reset deserialization to beginning

Definition at line 586 of file Serializable.cpp.

◆ resetSer()

void Fw::SerializeBufferBase::resetSer ( )

reset to beginning of buffer to reuse for serialization

Definition at line 581 of file Serializable.cpp.

◆ serialize() [1/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( U8 val )

Definition at line 777 of file Serializable.cpp.

◆ serialize() [2/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( I8 val )

Definition at line 780 of file Serializable.cpp.

◆ serialize() [3/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( F32 val )

Definition at line 807 of file Serializable.cpp.

◆ serialize() [4/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( F64 val )

Definition at line 810 of file Serializable.cpp.

◆ serialize() [5/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( bool val )

Definition at line 813 of file Serializable.cpp.

◆ serialize() [6/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( const void * val )

Definition at line 816 of file Serializable.cpp.

◆ serialize() [7/10]

SerializeStatus Fw::SerializeBufferBase::serialize	(	const U8 *	buff,
		FwSizeType	length
	)

Definition at line 826 of file Serializable.cpp.

◆ serialize() [8/10]

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

Definition at line 829 of file Serializable.cpp.

◆ serialize() [9/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( const Serializable & val )

Definition at line 832 of file Serializable.cpp.

◆ serialize() [10/10]

SerializeStatus Fw::SerializeBufferBase::serialize ( const SerializeBufferBase & val )

Definition at line 835 of file Serializable.cpp.

◆ serializeFrom() [1/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( U8 val )

serialize 8-bit unsigned int

Definition at line 64 of file Serializable.cpp.

◆ serializeFrom() [2/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( I8 val )

serialize 8-bit signed int

Definition at line 76 of file Serializable.cpp.

◆ serializeFrom() [3/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( F32 val )

serialize 32-bit floating point

Definition at line 193 of file Serializable.cpp.

◆ serializeFrom() [4/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( F64 val )

serialize 64-bit floating point

Definition at line 186 of file Serializable.cpp.

◆ serializeFrom() [5/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( bool val )

serialize boolean

Definition at line 200 of file Serializable.cpp.

◆ serializeFrom() [6/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( const void * val )

serialize pointer (careful, only pointer value, not contents are serialized)

Definition at line 217 of file Serializable.cpp.

◆ serializeFrom() [7/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom	(	const U8 *	buff,
		FwSizeType	length
	)

serialize data buffer

Definition at line 225 of file Serializable.cpp.

◆ serializeFrom() [8/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom	(	const U8 *	buff,
		FwSizeType	length,
		Serialization::t	mode
	)

serialize a byte buffer of a given length

Serialize bytes from buff up to length. If serializationMode is set to INCLUDE_LENGTH then the length is included as the first token. Length may be omitted with OMIT_LENGTH.

Parameters

buff	buffer to serialize
length	length of data to serialize
mode	serialization type

Returns: status of serialization

Definition at line 229 of file Serializable.cpp.

◆ serializeFrom() [9/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( const SerializeBufferBase & val )

serialize a serialized buffer

Definition at line 256 of file Serializable.cpp.

◆ serializeFrom() [10/10]

SerializeStatus Fw::SerializeBufferBase::serializeFrom ( const Serializable & val )

serialize an object derived from serializable base class

Definition at line 252 of file Serializable.cpp.

◆ serializeSize()

SerializeStatus Fw::SerializeBufferBase::serializeSize ( const FwSizeType size )

serialize a size value

Definition at line 279 of file Serializable.cpp.

◆ serializeSkip()

SerializeStatus Fw::SerializeBufferBase::serializeSkip ( FwSizeType numBytesToSkip )

Skips the number of specified bytes for serialization.

Definition at line 590 of file Serializable.cpp.

◆ setBuff()

SerializeStatus Fw::SerializeBufferBase::setBuff	(	const U8 *	src,
		Serializable::SizeType	length
	)

sets buffer contents and size

Definition at line 633 of file Serializable.cpp.

◆ setBuffLen()

SerializeStatus Fw::SerializeBufferBase::setBuffLen ( Serializable::SizeType length )

sets buffer length manually after filling with data

Definition at line 646 of file Serializable.cpp.

Friends And Related Function Documentation

◆ SerializeBufferBaseTester

friend class SerializeBufferBaseTester

friend

Definition at line 65 of file Serializable.hpp.

Member Data Documentation

◆ m_deserLoc

Serializable::SizeType Fw::SerializeBufferBase::m_deserLoc

protected

current offset for deserialization

Definition at line 250 of file Serializable.hpp.

◆ m_serLoc

Serializable::SizeType Fw::SerializeBufferBase::m_serLoc

protected

current offset in buffer of serialized data

Definition at line 249 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 Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~SerializeBufferBase()

◆ SerializeBufferBase()

Member Function Documentation

◆ copyRaw()

◆ copyRawOffset()

◆ DEPRECATED() [1/2]

◆ DEPRECATED() [2/2]

◆ deserialize() [1/10]

◆ deserialize() [2/10]

◆ deserialize() [3/10]

◆ deserialize() [4/10]

◆ deserialize() [5/10]

◆ deserialize() [6/10]

◆ deserialize() [7/10]

◆ deserialize() [8/10]

◆ deserialize() [9/10]

◆ deserialize() [10/10]

◆ deserializeSize()

◆ deserializeSkip()

◆ deserializeTo() [1/10]

◆ deserializeTo() [2/10]

◆ deserializeTo() [3/10]

◆ deserializeTo() [4/10]

◆ deserializeTo() [5/10]

◆ deserializeTo() [6/10]

◆ deserializeTo() [7/10]

◆ deserializeTo() [8/10]

◆ deserializeTo() [9/10]

◆ deserializeTo() [10/10]

◆ getBuffAddr() [1/2]

◆ getBuffAddr() [2/2]

◆ getBuffAddrLeft()

◆ getBuffAddrSer()

◆ getBuffCapacity()

◆ getBuffLeft()

◆ getBuffLength()

◆ moveDeserToOffset()

◆ moveSerToOffset()

◆ operator=()

◆ resetDeser()

◆ resetSer()

◆ serialize() [1/10]

◆ serialize() [2/10]

◆ serialize() [3/10]

◆ serialize() [4/10]

◆ serialize() [5/10]

◆ serialize() [6/10]

◆ serialize() [7/10]

◆ serialize() [8/10]

◆ serialize() [9/10]

◆ serialize() [10/10]

◆ serializeFrom() [1/10]

◆ serializeFrom() [2/10]

◆ serializeFrom() [3/10]

◆ serializeFrom() [4/10]

◆ serializeFrom() [5/10]

◆ serializeFrom() [6/10]

◆ serializeFrom() [7/10]

◆ serializeFrom() [8/10]

◆ serializeFrom() [9/10]

◆ serializeFrom() [10/10]

◆ serializeSize()

◆ serializeSkip()

◆ setBuff()

◆ setBuffLen()

Friends And Related Function Documentation

◆ SerializeBufferBaseTester

Member Data Documentation

◆ m_deserLoc

◆ m_serLoc