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

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

Additional Inherited Members

- Protected Member Functions inherited from Fw::SerializeBufferBase
SerializeBufferBaseoperator= (const SerializeBufferBase &src)
 copy assignment operator
 
 SerializeBufferBase ()
 default constructor
 

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: