Fw::CmdArgBuffer Class Reference

#include <Fw/Cmd/CmdArgBuffer.hpp>

Inheritance diagram for Fw::CmdArgBuffer:

Public Types
enum	{ SERIALIZED_TYPE_ID = FW_TYPEID_CMD_BUFF , SERIALIZED_SIZE = FW_CMD_ARG_BUFFER_MAX_SIZE + sizeof(I32) }

Public Member Functions
	CmdArgBuffer (const U8 *args, NATIVE_UINT_TYPE size)
	buffer source constructor More...
	CmdArgBuffer ()
	default constructor More...
	CmdArgBuffer (const CmdArgBuffer &other)
	other arg buffer constructor More...
virtual	~CmdArgBuffer ()
	destructor More...
CmdArgBuffer &	operator= (const CmdArgBuffer &other)
	Equal operator. More...
NATIVE_UINT_TYPE	getBuffCapacity () const
	return capacity of buffer (how much it can hold) More...
U8 *	getBuffAddr ()
	return address of buffer (non const version) More...
const U8 *	getBuffAddr () const
	return address of buffer (const version) More...
Public Member Functions inherited from Fw::SerializeBufferBase
SerializeBufferBase &	operator= (const SerializeBufferBase &src)
	equal operator More...
virtual	~SerializeBufferBase ()
	destructor More...
SerializeStatus	serialize (U8 val)
	serialize 8-bit unsigned int More...
SerializeStatus	serialize (I8 val)
	serialize 8-bit signed int More...
SerializeStatus	serialize (F32 val)
	serialize 32-bit floating point More...
SerializeStatus	serialize (bool val)
	serialize boolean More...
SerializeStatus	serialize (const void *val)
	serialize pointer (careful, only pointer value, not contents are serialized) More...
SerializeStatus	serialize (const U8 *buff, NATIVE_UINT_TYPE length, bool noLength=false)
	serialize data buffer More...
SerializeStatus	serialize (const SerializeBufferBase &val)
	serialize a serialized buffer More...
SerializeStatus	serialize (const Serializable &val)
	serialize an object derived from serializable base class More...
SerializeStatus	deserialize (U8 &val)
	deserialize 8-bit unsigned int More...
SerializeStatus	deserialize (I8 &val)
	deserialize 8-bit signed int More...
SerializeStatus	deserialize (F32 &val)
	deserialize 32-bit floating point More...
SerializeStatus	deserialize (bool &val)
	deserialize boolean More...
SerializeStatus	deserialize (void *&val)
	deserialize point value (careful, pointer value only, not contents) More...
SerializeStatus	deserialize (U8 *buff, NATIVE_UINT_TYPE &length, bool noLength=false)
	deserialize data buffer More...
SerializeStatus	deserialize (Serializable &val)
	deserialize an object derived from serializable base class More...
SerializeStatus	deserialize (SerializeBufferBase &val)
	serialize a serialized buffer More...
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...
NATIVE_UINT_TYPE	getBuffLength () const
	returns current buffer size More...
NATIVE_UINT_TYPE	getBuffLeft () const
	returns how much deserialization buffer is left More...
const U8 *	getBuffAddrLeft () const
	gets address of remaining non-deserialized data. More...
U8 *	getBuffAddrSer ()
	gets address of end of serialization. DANGEROUS! Need to know max buffer size and adjust when done More...
SerializeStatus	setBuff (const U8 *src, NATIVE_UINT_TYPE length)
	sets buffer contents and size More...
SerializeStatus	setBuffLen (NATIVE_UINT_TYPE length)
	sets buffer length manually after filling with data More...
SerializeStatus	copyRaw (SerializeBufferBase &dest, NATIVE_UINT_TYPE size)
	directly copies buffer without looking for a size in the stream. More...
SerializeStatus	copyRawOffset (SerializeBufferBase &dest, NATIVE_UINT_TYPE size)
	directly copies buffer without looking for a size in the stream. More...

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

Detailed Description

Definition at line 21 of file CmdArgBuffer.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_TYPE_ID	type id for CmdArgBuffer
SERIALIZED_SIZE	size when serialized. Buffer + size of buffer

Definition at line 24 of file CmdArgBuffer.hpp.

Constructor & Destructor Documentation

CmdArgBuffer() [1/3]

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

buffer source constructor

Definition at line 6 of file CmdArgBuffer.cpp.

CmdArgBuffer() [2/3]

Fw::CmdArgBuffer::CmdArgBuffer

(

)

default constructor

Definition at line 11 of file CmdArgBuffer.cpp.

CmdArgBuffer() [3/3]

Fw::CmdArgBuffer::CmdArgBuffer

(

const CmdArgBuffer &

other

)

other arg buffer constructor

Definition at line 17 of file CmdArgBuffer.cpp.

~CmdArgBuffer()

Fw::CmdArgBuffer::~CmdArgBuffer ( )

virtual

destructor

Definition at line 14 of file CmdArgBuffer.cpp.

Member Function Documentation

getBuffAddr() [1/2]

U8 * Fw::CmdArgBuffer::getBuffAddr ( )

virtual

return address of buffer (non const version)

Implements Fw::SerializeBufferBase.

Definition at line 40 of file CmdArgBuffer.cpp.

getBuffAddr() [2/2]

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

virtual

return address of buffer (const version)

Implements Fw::SerializeBufferBase.

Definition at line 36 of file CmdArgBuffer.cpp.

getBuffCapacity()

NATIVE_UINT_TYPE Fw::CmdArgBuffer::getBuffCapacity ( ) const

virtual

return capacity of buffer (how much it can hold)

Implements Fw::SerializeBufferBase.

Definition at line 32 of file CmdArgBuffer.cpp.

operator=()

CmdArgBuffer & Fw::CmdArgBuffer::operator=

(

const CmdArgBuffer &

other

)

Equal operator.

Definition at line 22 of file CmdArgBuffer.cpp.

---

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

• Fw/Cmd/CmdArgBuffer.hpp
• Fw/Cmd/CmdArgBuffer.cpp