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

#include <Fw/Types/Serializable.hpp>

Inheritance diagram for Fw::ExternalSerializeBufferWithMemberCopy:

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

	ExternalSerializeBufferWithMemberCopy ()
	Default constructor. More...

	~ExternalSerializeBufferWithMemberCopy ()
	Destructor. More...

	ExternalSerializeBufferWithMemberCopy (const ExternalSerializeBufferWithMemberCopy &src)
	Copy constructor with member copying. More...

ExternalSerializeBufferWithMemberCopy &	operator= (const ExternalSerializeBufferWithMemberCopy &src)
	Copy assignment operator with member copying. More...

Public Member Functions inherited from Fw::ExternalSerializeBuffer
	ExternalSerializeBuffer (U8 *buffPtr, Serializable::SizeType size)
	Construct with external buffer. More...

	ExternalSerializeBuffer ()
	Default constructor. More...

	~ExternalSerializeBuffer ()
	Destructor. More...

void	setExtBuffer (U8 *buffPtr, Serializable::SizeType size)
	Set the external buffer. More...

void	clear ()
	Clear external buffer. More...

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

	DEPRECATED (Serializable::SizeType getBuffCapacity() const, "Use getCapacity() instead")

Serializable::SizeType	getCapacity () const
	Get buffer capacity. More...

U8 *	getBuffAddr ()
	Get buffer address for data filling (non-const version) More...

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

ExternalSerializeBuffer &	operator= (const LinearBufferBase &src)=delete
	Deleted copy assignment operator. More...

Public Member Functions inherited from Fw::LinearBufferBase
virtual	~LinearBufferBase ()
	Destructor. More...

SerializeStatus	serializeFrom (U8 val, Endianness mode=Endianness::BIG) override
	Serialize an 8-bit unsigned integer value. More...

SerializeStatus	serializeFrom (I8 val, Endianness mode=Endianness::BIG) override
	Serialize an 8-bit signed integer value. More...

SerializeStatus	serializeFrom (F32 val, Endianness mode=Endianness::BIG) override
	Serialize a 32-bit floating point value. More...

SerializeStatus	serializeFrom (F64 val, Endianness mode=Endianness::BIG) override
	Serialize a 64-bit floating point value. More...

SerializeStatus	serializeFrom (bool val, Endianness mode=Endianness::BIG) override
	Serialize a boolean value. More...

SerializeStatus	serializeFrom (const void *val, Endianness mode=Endianness::BIG) override
	Serialize a pointer value. More...

SerializeStatus	serializeFrom (const U8 *buff, FwSizeType length, Endianness endianMode=Endianness::BIG) override
	Serialize a data buffer. More...

SerializeStatus	serializeFrom (const U8 *buff, FwSizeType length, Serialization::t lengthMode, Endianness endianMode=Endianness::BIG) override
	Serialize a byte buffer with optional length prefix. More...

SerializeStatus	serializeFrom (const LinearBufferBase &val, Endianness mode=Endianness::BIG) override
	Serialize another LinearBufferBase object. More...

SerializeStatus	serializeFrom (const Serializable &val, Endianness mode=Endianness::BIG) override
	Serialize a Serializable object. More...

SerializeStatus	serializeSize (const FwSizeType size, Endianness mode=Endianness::BIG) override
	Serialize a size value. More...

SerializeStatus	deserializeTo (U8 &val, Endianness mode=Endianness::BIG) override
	Deserialize an 8-bit unsigned integer value. More...

SerializeStatus	deserializeTo (I8 &val, Endianness mode=Endianness::BIG) override
	Deserialize an 8-bit signed integer value. More...

SerializeStatus	deserializeTo (F32 &val, Endianness mode=Endianness::BIG) override
	Deserialize a 32-bit floating point value. More...

SerializeStatus	deserializeTo (F64 &val, Endianness mode=Endianness::BIG) override
	Deserialize a 64-bit floating point value. More...

SerializeStatus	deserializeTo (bool &val, Endianness mode=Endianness::BIG) override
	Deserialize a boolean value. More...

SerializeStatus	deserializeTo (void *&val, Endianness mode=Endianness::BIG) override
	Deserialize a pointer value. More...

SerializeStatus	deserializeTo (U8 *buff, FwSizeType &length, Endianness endianMode=Endianness::BIG) override
	Deserialize a data buffer. More...

SerializeStatus	deserializeTo (U8 *buff, FwSizeType &length, Serialization::t lengthMode, Endianness endianMode=Endianness::BIG) override
	Deserialize a byte buffer with optional length prefix. More...

SerializeStatus	deserializeTo (Serializable &val, Endianness mode=Endianness::BIG) override
	Deserialize a Serializable object. More...

SerializeStatus	deserializeTo (LinearBufferBase &val, Endianness mode=Endianness::BIG) override
	Deserialize a LinearBufferBase object. More...

SerializeStatus	deserializeSize (FwSizeType &size, Endianness mode=Endianness::BIG) override
	Deserialize a size value. More...

	DEPRECATED (SerializeStatus serialize(const LinearBufferBase &val), "Use serializeFrom(const SerialBufferBase& val) instead")

	DEPRECATED (SerializeStatus deserialize(LinearBufferBase &val), "Use deserializeTo(SerialBufferBase& val) instead")

void	resetSer () override
	Reset serialization pointer to beginning of buffer. More...

void	resetDeser () override
	Reset deserialization pointer to beginning of buffer. More...

SerializeStatus	moveSerToOffset (FwSizeType offset) override
	Move serialization pointer to specified offset. More...

SerializeStatus	moveDeserToOffset (FwSizeType offset) override
	Move deserialization pointer to specified offset. More...

SerializeStatus	serializeSkip (FwSizeType numBytesToSkip) override
	Skip specified number of bytes during serialization. More...

SerializeStatus	deserializeSkip (FwSizeType numBytesToSkip) override
	Skip specified number of bytes during deserialization. More...

	DEPRECATED (Serializable::SizeType getBuffCapacity() const, "Use getCapacity() instead")

	DEPRECATED (Serializable::SizeType getBuffLength() const, "Use getSize() instead")

	DEPRECATED (Serializable::SizeType getBuffLeft(), "Use getDeserializeSizeLeft() instead")

Serializable::SizeType	getSize () const override
	Get current buffer size. More...

Serializable::SizeType	getDeserializeSizeLeft () const override
	Get remaining deserialization buffer size. More...

Serializable::SizeType	getSerializeSizeLeft () const override
	Get remaining serialization buffer size. More...

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

U8 *	getBuffAddrSer ()
	Get address of end of serialization (DANGEROUS!) More...

SerializeStatus	setBuff (const U8 *src, Serializable::SizeType length) override
	Set buffer contents from external source. More...

SerializeStatus	setBuffLen (Serializable::SizeType length) override
	Set buffer length manually. More...

SerializeStatus	copyRaw (SerialBufferBase &dest, Serializable::SizeType size) override
	Copy raw bytes from this buffer to destination and advance source offset. More...

SerializeStatus	copyRawOffset (SerialBufferBase &dest, Serializable::SizeType size) override
	Append raw bytes to destination from this buffer and advance source offset. More...

	DEPRECATED (SerializeStatus serialize(U8 val), "Use serializeFrom(U8 val) instead")

	DEPRECATED (SerializeStatus serialize(I8 val), "Use serializeFrom(I8 val) instead")

	DEPRECATED (SerializeStatus serialize(F32 val), "Use serializeFrom(F32 val) instead")

	DEPRECATED (SerializeStatus serialize(F64 val), "Use serializeFrom(F64 val) instead")

	DEPRECATED (SerializeStatus serialize(bool val), "Use serializeFrom(bool val) instead")

	DEPRECATED (SerializeStatus serialize(const void val), "Use serializeFrom(const void val) instead")

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

	DEPRECATED (SerializeStatus serialize(const U8 buff, FwSizeType length), "Use serializeFrom(const U8 buff, FwSizeType length) instead")

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

	DEPRECATED (SerializeStatus serialize(const Serializable &val), "Use serializeFrom(const Serializable& val) instead")

	DEPRECATED (SerializeStatus deserialize(U8 &val), "Use deserializeTo(U8& val) instead")

	DEPRECATED (SerializeStatus deserialize(I8 &val), "Use deserializeTo(I8& val) instead")

	DEPRECATED (SerializeStatus deserialize(F32 &val), "Use deserializeTo(F32& val) instead")

	DEPRECATED (SerializeStatus deserialize(F64 &val), "Use deserializeTo(F64& val) instead")

	DEPRECATED (SerializeStatus deserialize(bool &val), "Use deserializeTo(bool& val) instead")

	DEPRECATED (SerializeStatus deserialize(void &val), "Use deserializeTo(void& val) instead")

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

	DEPRECATED (SerializeStatus deserialize(U8 buff, FwSizeType &length), "Use deserializeTo(U8 buff, FwSizeType& length) instead")

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

	DEPRECATED (SerializeStatus deserialize(Serializable &val), "Use deserializeTo(Serializable& val) instead")

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

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

	LinearBufferBase ()
	Default constructor. More...

	LinearBufferBase (const LinearBufferBase &src)
	Copy constructor (protected) More...

void	copyFrom (const LinearBufferBase &src)
	Copy data from source buffer. More...

Protected Attributes inherited from Fw::ExternalSerializeBuffer
U8 *	m_buff
	pointer to external buffer More...

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

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

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

Detailed Description

External serialize buffer with member copy semantics.

This class provides a serialization buffer that uses an external buffer and performs member copying during assignment operations. It is designed for scenarios where you want to move data between buffers efficiently.

Note: This class should be used when the object on the left-hand side of an assignment (esb1 = esb2) has an invalid buffer, and you want to move the buffer of esb2 into it. In this case, there should usually be no more uses of esb2 after the assignment.

See also: ExternalSerializeBuffer for a version without data copying; ExternalSerializeBufferWithDataCopy for a version with data copying

Definition at line 1552 of file Serializable.hpp.

Constructor & Destructor Documentation

◆ ExternalSerializeBufferWithMemberCopy() [1/3]

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

inline

Construct with external buffer.

Creates an ExternalSerializeBufferWithMemberCopy instance that uses the provided external buffer.

Parameters

buffPtr	Pointer to the external buffer
size	Size of the external buffer in bytes

Definition at line 1561 of file Serializable.hpp.

◆ ExternalSerializeBufferWithMemberCopy() [2/3]

Fw::ExternalSerializeBufferWithMemberCopy::ExternalSerializeBufferWithMemberCopy ( )

inline

Default constructor.

Creates an ExternalSerializeBufferWithMemberCopy instance without an external buffer. The buffer must be set later using setExtBuffer().

Definition at line 1568 of file Serializable.hpp.

◆ ~ExternalSerializeBufferWithMemberCopy()

Fw::ExternalSerializeBufferWithMemberCopy::~ExternalSerializeBufferWithMemberCopy ( )

inline

Destructor.

Destroys the ExternalSerializeBufferWithMemberCopy instance.

Definition at line 1573 of file Serializable.hpp.

◆ ExternalSerializeBufferWithMemberCopy() [3/3]

Fw::ExternalSerializeBufferWithMemberCopy::ExternalSerializeBufferWithMemberCopy ( const ExternalSerializeBufferWithMemberCopy & src )

inline

Copy constructor with member copying.

This constructor copies members from the source instance, including the buffer pointer, size, serialization location, and deserialization location.

Parameters

src	Reference to the source instance to copy from

Definition at line 1582 of file Serializable.hpp.

Member Function Documentation

◆ operator=()

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

inline

Copy assignment operator with member copying.

This assignment operator copies members from the source instance, including the buffer pointer, size, serialization location, and deserialization location. It guards against self-assignment.

Parameters

src	Reference to the source instance to copy from

Returns: Reference to this instance

Definition at line 1596 of file Serializable.hpp.

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

Fw/Types/Serializable.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExternalSerializeBufferWithMemberCopy() [1/3]

◆ ExternalSerializeBufferWithMemberCopy() [2/3]

◆ ~ExternalSerializeBufferWithMemberCopy()

◆ ExternalSerializeBufferWithMemberCopy() [3/3]

Member Function Documentation

◆ operator=()