#include <Fw/Types/Serializable.hpp>

Inheritance diagram for Fw::SerializeBufferBase:

Public Member Functions
virtual	~SerializeBufferBase ()
	destructor

SerializeStatus	serialize (U8 val)
	serialize 8-bit unsigned int

SerializeStatus	serialize (I8 val)
	serialize 8-bit signed int

SerializeStatus	serialize (F32 val)
	serialize 32-bit floating point

SerializeStatus	serialize (bool val)
	serialize boolean

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

SerializeStatus	serialize (const U8 *buff, NATIVE_UINT_TYPE length, bool noLength)
	serialize data buffer

SerializeStatus	serialize (const U8 *buff, NATIVE_UINT_TYPE length)
	serialize data buffer

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

SerializeStatus	serialize (const SerializeBufferBase &val)
	serialize a serialized buffer

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

SerializeStatus	serializeSize (const FwSizeType size)
	serialize a size value

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

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

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

SerializeStatus	deserialize (bool &val)
	deserialize boolean

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

SerializeStatus	deserialize (U8 *buff, NATIVE_UINT_TYPE &length, bool noLength)
	deserialize data buffer

SerializeStatus	deserialize (U8 *buff, NATIVE_UINT_TYPE &length)
	deserialize data buffer

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

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

SerializeStatus	deserialize (SerializeBufferBase &val)
	serialize a serialized buffer

SerializeStatus	deserializeSize (FwSizeType &size)
	deserialize a size value

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

void	resetDeser ()
	reset deserialization to beginning

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

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

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

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

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

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

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

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

virtual const U8 *	getBuffAddr () const =0
	gets buffer address for data reading, const version

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

U8 *	getBuffAddrSer ()

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

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

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

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

Protected Member Functions
SerializeBufferBase &	operator= (const SerializeBufferBase &src)
	copy assignment operator

	SerializeBufferBase ()
	default constructor

Detailed Description

Definition at line 54 of file Serializable.hpp.

Constructor & Destructor Documentation

◆ ~SerializeBufferBase()

Fw::SerializeBufferBase::~SerializeBufferBase ( )

virtual

destructor

Definition at line 41 of file Serializable.cpp.

◆ SerializeBufferBase()

Fw::SerializeBufferBase::SerializeBufferBase ( )

protected

default constructor

Definition at line 39 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 682 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 695 of file Serializable.cpp.

◆ deserialize() [1/10]

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

deserialize boolean

Definition at line 464 of file Serializable.cpp.

◆ deserialize() [2/10]

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

deserialize 32-bit floating point

Definition at line 495 of file Serializable.cpp.

◆ deserialize() [3/10]

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

deserialize 8-bit signed int

Definition at line 314 of file Serializable.cpp.

◆ deserialize() [4/10]

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

deserialize an object derived from serializable base class

Definition at line 556 of file Serializable.cpp.

◆ deserialize() [5/10]

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

serialize a serialized buffer

Definition at line 560 of file Serializable.cpp.

◆ deserialize() [6/10]

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

deserialize 8-bit unsigned int

Definition at line 300 of file Serializable.cpp.

◆ deserialize() [7/10]

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

deserialize a byte buffer of a given length

Deserialize bytes into buff of length bytes. If serializationMode is set to INCLUDE_LENGTH then the length is deserialized first followed by the bytes. Length may be omitted with OMIT_LENGTH and in this case length bytes will be deserialized. length will be filled with the amount of data deserialized.

Parameters

buff	buffer to hold deserialized data
length	length of data to deserialize length is filled with deserialized length
mode	deserialization type

Returns: status of serialization

Definition at line 522 of file Serializable.cpp.

◆ deserialize() [8/10]

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

deserialize data buffer

Definition at line 507 of file Serializable.cpp.

◆ deserialize() [9/10]

SerializeStatus Fw::SerializeBufferBase::deserialize	(	U8 *	buff,
		NATIVE_UINT_TYPE &	length,
		bool	noLength
	)

deserialize data buffer

Definition at line 514 of file Serializable.cpp.

◆ deserialize() [10/10]

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

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

Definition at line 485 of file Serializable.cpp.

◆ deserializeSize()

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

deserialize a size value

Definition at line 592 of file Serializable.cpp.

◆ deserializeSkip()

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

Skips the number of specified bytes for deserialization.

Definition at line 624 of file Serializable.cpp.

◆ getBuffAddr() [1/2]

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

pure virtual

gets buffer address for data reading, const version

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

◆ getBuffAddr() [2/2]

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

pure virtual

gets buffer address for data filling

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

◆ 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 715 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 720 of file Serializable.cpp.

◆ getBuffCapacity()

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

pure virtual

returns capacity, not current size, of buffer

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

◆ getBuffLeft()

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

returns how much deserialization buffer is left

Definition at line 676 of file Serializable.cpp.

◆ getBuffLength()

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

returns current buffer size

Definition at line 649 of file Serializable.cpp.

◆ moveDeserToOffset()

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

Moves deserialization to the specified offset.

Definition at line 642 of file Serializable.cpp.

◆ moveSerToOffset()

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

Moves serialization to the specified offset.

Definition at line 636 of file Serializable.cpp.

◆ operator=()

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

protected

copy assignment operator

Definition at line 56 of file Serializable.cpp.

◆ resetDeser()

void Fw::SerializeBufferBase::resetDeser ( )

reset deserialization to beginning

Definition at line 606 of file Serializable.cpp.

◆ resetSer()

void Fw::SerializeBufferBase::resetSer ( )

reset to beginning of buffer to reuse for serialization

Definition at line 601 of file Serializable.cpp.

◆ serialize() [1/10]

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

serialize boolean

Definition at line 203 of file Serializable.cpp.

◆ serialize() [2/10]

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

serialize an object derived from serializable base class

Definition at line 260 of file Serializable.cpp.

◆ serialize() [3/10]

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

serialize a serialized buffer

Definition at line 264 of file Serializable.cpp.

◆ serialize() [4/10]

SerializeStatus Fw::SerializeBufferBase::serialize	(	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 237 of file Serializable.cpp.

◆ serialize() [5/10]

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

serialize data buffer

Definition at line 228 of file Serializable.cpp.

◆ serialize() [6/10]

SerializeStatus Fw::SerializeBufferBase::serialize	(	const U8 *	buff,
		NATIVE_UINT_TYPE	length,
		bool	noLength
	)

serialize data buffer

Definition at line 232 of file Serializable.cpp.

◆ serialize() [7/10]

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

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

Definition at line 220 of file Serializable.cpp.

◆ serialize() [8/10]

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

serialize 32-bit floating point

Definition at line 196 of file Serializable.cpp.

◆ serialize() [9/10]

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

serialize 8-bit signed int

Definition at line 75 of file Serializable.cpp.

◆ serialize() [10/10]

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

serialize 8-bit unsigned int

Definition at line 63 of file Serializable.cpp.

◆ serializeSize()

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

serialize a size value

Definition at line 287 of file Serializable.cpp.

◆ serializeSkip()

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

Skips the number of specified bytes for serialization.

Definition at line 610 of file Serializable.cpp.

◆ setBuff()

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

sets buffer contents and size

Definition at line 653 of file Serializable.cpp.

◆ setBuffLen()

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

sets buffer length manually after filling with data

Definition at line 666 of file Serializable.cpp.

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

Detailed Description

Constructor & Destructor Documentation

◆ ~SerializeBufferBase()

◆ SerializeBufferBase()

Member Function Documentation

◆ copyRaw()

◆ copyRawOffset()

◆ 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()

◆ 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]

◆ serializeSize()

◆ serializeSkip()

◆ setBuff()

◆ setBuffLen()