F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Fw::CmdArgBuffer Class Referencefinal

#include <Fw/Cmd/CmdArgBuffer.hpp>

Inheritance diagram for Fw::CmdArgBuffer:
Fw::SerializeBufferBase

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, FwSizeType size)
 buffer source constructor More...
 
 CmdArgBuffer ()
 default constructor More...
 
 CmdArgBuffer (const CmdArgBuffer &other)
 other arg buffer constructor More...
 
virtual ~CmdArgBuffer ()
 destructor More...
 
CmdArgBufferoperator= (const CmdArgBuffer &other)
 Equal operator. More...
 
FwSizeType getBuffCapacity () const
 return capacity of buffer (how much it can hold) More...
 
U8getBuffAddr ()
 return address of buffer (non const version) More...
 
const U8getBuffAddr () const
 return address of buffer (const version) More...
 
- Public Member Functions inherited from Fw::SerializeBufferBase
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...
 
Serializable::SizeType getBuffLength () const
 returns current buffer size More...
 
Serializable::SizeType getBuffLeft () const
 returns how much deserialization buffer is left More...
 
const U8getBuffAddrLeft () const
 gets address of remaining non-deserialized data. More...
 
U8getBuffAddrSer ()
 
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...
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::SerializeBufferBase
SerializeBufferBaseoperator= (const SerializeBufferBase &src)
 copy assignment operator More...
 
 SerializeBufferBase ()
 default constructor More...
 
- Protected Attributes inherited from Fw::SerializeBufferBase
Serializable::SizeType m_serLoc
 current offset in buffer of serialized data More...
 
Serializable::SizeType m_deserLoc
 current offset for deserialization 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 23 of file CmdArgBuffer.hpp.

Constructor & Destructor Documentation

◆ CmdArgBuffer() [1/3]

Fw::CmdArgBuffer::CmdArgBuffer ( const U8 args,
FwSizeType  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 15 of file CmdArgBuffer.cpp.

◆ ~CmdArgBuffer()

Fw::CmdArgBuffer::~CmdArgBuffer ( )
virtual

destructor

Definition at line 13 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 38 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 34 of file CmdArgBuffer.cpp.

◆ getBuffCapacity()

FwSizeType Fw::CmdArgBuffer::getBuffCapacity ( ) const
virtual

return capacity of buffer (how much it can hold)

Implements Fw::SerializeBufferBase.

Definition at line 30 of file CmdArgBuffer.cpp.

◆ operator=()

CmdArgBuffer & Fw::CmdArgBuffer::operator= ( const CmdArgBuffer other)

Equal operator.

Definition at line 20 of file CmdArgBuffer.cpp.


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