Fw::ComBuffer Class Reference

#include <Fw/Com/ComBuffer.hpp>

Inheritance diagram for Fw::ComBuffer:

Public Types
enum	{ SERIALIZED_TYPE_ID = 1010 , SERIALIZED_SIZE = FW_COM_BUFFER_MAX_SIZE + sizeof(FwBuffSizeType) }

Public Member Functions
	ComBuffer (const U8 *args, NATIVE_UINT_TYPE size)
	ComBuffer ()
	ComBuffer (const ComBuffer &other)
virtual	~ComBuffer ()
ComBuffer &	operator= (const ComBuffer &other)
NATIVE_UINT_TYPE	getBuffCapacity () const
	returns capacity, not current size, of buffer
U8 *	getBuffAddr ()
	gets buffer address for data filling
const U8 *	getBuffAddr () const
	gets buffer address for data reading, const version
Public Member Functions inherited from Fw::SerializeBufferBase
SerializeBufferBase &	operator= (const SerializeBufferBase &src)
	equal operator
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=false)
	serialize data buffer
SerializeStatus	serialize (const SerializeBufferBase &val)
	serialize a serialized buffer
SerializeStatus	serialize (const Serializable &val)
	serialize an object derived from serializable base class
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=false)
	deserialize data buffer
SerializeStatus	deserialize (Serializable &val)
	deserialize an object derived from serializable base class
SerializeStatus	deserialize (SerializeBufferBase &val)
	serialize a serialized buffer
void	resetSer ()
	reset to beginning of buffer to reuse for serialization
void	resetDeser ()
	reset deserialization to beginning
SerializeStatus	deserializeSkip (NATIVE_UINT_TYPE numBytesToSkip)
	Skips the number of specified bytes for deserialization.
virtual NATIVE_UINT_TYPE	getBuffCapacity () const =0
	returns capacity, not current size, of buffer
NATIVE_UINT_TYPE	getBuffLength () const
	returns current buffer size
NATIVE_UINT_TYPE	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 ()
	gets address of end of serialization. DANGEROUS! Need to know max buffer size and adjust when done
SerializeStatus	setBuff (const U8 *src, NATIVE_UINT_TYPE length)
	sets buffer contents and size
SerializeStatus	setBuffLen (NATIVE_UINT_TYPE length)
	sets buffer length manually after filling with data
SerializeStatus	copyRaw (SerializeBufferBase &dest, NATIVE_UINT_TYPE size)
	directly copies buffer without looking for a size in the stream.
SerializeStatus	copyRawOffset (SerializeBufferBase &dest, NATIVE_UINT_TYPE size)
	directly copies buffer without looking for a size in the stream.

Additional Inherited Members
Protected Member Functions inherited from Fw::SerializeBufferBase
	SerializeBufferBase ()
	default constructor

Detailed Description

Definition at line 20 of file ComBuffer.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_TYPE_ID
SERIALIZED_SIZE

Definition at line 23 of file ComBuffer.hpp.

Constructor & Destructor Documentation

ComBuffer() [1/3]

Fw::ComBuffer::ComBuffer	(	const U8 *	args,
		NATIVE_UINT_TYPE	size
	)

Definition at line 6 of file ComBuffer.cpp.

ComBuffer() [2/3]

Fw::ComBuffer::ComBuffer

(

)

Definition at line 11 of file ComBuffer.cpp.

ComBuffer() [3/3]

Fw::ComBuffer::ComBuffer

(

const ComBuffer &

other

)

Definition at line 17 of file ComBuffer.cpp.

~ComBuffer()

Fw::ComBuffer::~ComBuffer ( )

virtual

Definition at line 14 of file ComBuffer.cpp.

Member Function Documentation

getBuffAddr() [1/2]

U8 * Fw::ComBuffer::getBuffAddr ( )

virtual

gets buffer address for data filling

Implements Fw::SerializeBufferBase.

Definition at line 40 of file ComBuffer.cpp.

getBuffAddr() [2/2]

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

virtual

gets buffer address for data reading, const version

Implements Fw::SerializeBufferBase.

Definition at line 36 of file ComBuffer.cpp.

getBuffCapacity()

NATIVE_UINT_TYPE Fw::ComBuffer::getBuffCapacity ( ) const

virtual

returns capacity, not current size, of buffer

Implements Fw::SerializeBufferBase.

Definition at line 32 of file ComBuffer.cpp.

operator=()

ComBuffer & Fw::ComBuffer::operator=

(

const ComBuffer &

other

)

Definition at line 22 of file ComBuffer.cpp.

---

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

• Fw/Com/ComBuffer.hpp
• Fw/Com/ComBuffer.cpp