F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Public Member Functions | Protected Member Functions | List of all members
Fw::SerializeBufferBase Class Referenceabstract

#include <Fw/Types/Serializable.hpp>

Inheritance diagram for Fw::SerializeBufferBase:
Drv::DataBuffer Fw::ActiveComponentExitSerializableBuffer Fw::CmdArgBuffer Fw::ComBuffer Fw::ExternalSerializeBuffer Fw::LogBuffer Fw::ParamBuffer Fw::SerialBuffer Fw::TlmBuffer Utils::HashBuffer

Public Member Functions

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...
 
virtual NATIVE_UINT_TYPE getBuffCapacity () const =0
 returns capacity, not current size, of buffer More...
 
NATIVE_UINT_TYPE getBuffLength () const
 returns current buffer size More...
 
NATIVE_UINT_TYPE getBuffLeft () const
 returns how much deserialization buffer is left More...
 
virtual U8 * getBuffAddr ()=0
 gets buffer address for data filling More...
 
virtual const U8 * getBuffAddr () const =0
 gets buffer address for data reading, const version 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...
 

Protected Member Functions

 SerializeBufferBase ()
 default constructor More...
 

Detailed Description

Definition at line 41 of file Serializable.hpp.

Constructor & Destructor Documentation

◆ ~SerializeBufferBase()

Fw::SerializeBufferBase::~SerializeBufferBase ( )
virtual

destructor

Definition at line 45 of file Serializable.cpp.

◆ SerializeBufferBase()

Fw::SerializeBufferBase::SerializeBufferBase ( )
protected

default constructor

Definition at line 41 of file Serializable.cpp.

Member Function Documentation

◆ copyRaw()

SerializeStatus Fw::SerializeBufferBase::copyRaw ( SerializeBufferBase &  dest,
NATIVE_UINT_TYPE  size 
)

directly copies buffer without looking for a size in the stream.

Definition at line 657 of file Serializable.cpp.

◆ copyRawOffset()

SerializeStatus Fw::SerializeBufferBase::copyRawOffset ( SerializeBufferBase &  dest,
NATIVE_UINT_TYPE  size 
)

directly copies buffer without looking for a size in the stream.

Definition at line 671 of file Serializable.cpp.

◆ deserialize() [1/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( bool &  val)

deserialize boolean

Definition at line 459 of file Serializable.cpp.

◆ deserialize() [2/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( F32 &  val)

deserialize 32-bit floating point

Definition at line 490 of file Serializable.cpp.

◆ deserialize() [3/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( I8 &  val)

deserialize 8-bit signed int

Definition at line 304 of file Serializable.cpp.

◆ deserialize() [4/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( Serializable &  val)

deserialize an object derived from serializable base class

Definition at line 537 of file Serializable.cpp.

◆ deserialize() [5/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( SerializeBufferBase &  val)

serialize a serialized buffer

Definition at line 541 of file Serializable.cpp.

◆ deserialize() [6/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( U8 &  val)

deserialize 8-bit unsigned int

Definition at line 290 of file Serializable.cpp.

◆ deserialize() [7/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( U8 *  buff,
NATIVE_UINT_TYPE &  length,
bool  noLength = false 
)

deserialize data buffer

Definition at line 502 of file Serializable.cpp.

◆ deserialize() [8/8]

SerializeStatus Fw::SerializeBufferBase::deserialize ( void *&  val)

deserialize point value (careful, pointer value only, not contents)

Definition at line 480 of file Serializable.cpp.

◆ deserializeSkip()

SerializeStatus Fw::SerializeBufferBase::deserializeSkip ( FwSizeType  numBytesToSkip)

Skips the number of specified bytes for deserialization.

Definition at line 600 of file Serializable.cpp.

◆ getBuffAddr() [1/2]

virtual const U8* Fw::SerializeBufferBase::getBuffAddr ( ) const
pure virtual

gets buffer address for data reading, const version

Implemented in Utils::HashBuffer, Fw::ExternalSerializeBuffer, Fw::SerialBuffer, Fw::TlmBuffer, Fw::ParamBuffer, Fw::LogBuffer, Fw::ActiveComponentExitSerializableBuffer, Fw::ComBuffer, Fw::CmdArgBuffer, and Drv::DataBuffer.

◆ getBuffAddr() [2/2]

virtual U8* Fw::SerializeBufferBase::getBuffAddr ( )
pure virtual

gets buffer address for data filling

Implemented in Utils::HashBuffer, Fw::ExternalSerializeBuffer, Fw::SerialBuffer, Fw::TlmBuffer, Fw::ParamBuffer, Fw::LogBuffer, Fw::ActiveComponentExitSerializableBuffer, Fw::ComBuffer, Fw::CmdArgBuffer, and Drv::DataBuffer.

◆ getBuffAddrLeft()

const U8 * Fw::SerializeBufferBase::getBuffAddrLeft ( ) const

gets address of remaining non-deserialized data.

gets address of end of serialization. Used to manually place data at the end

Definition at line 692 of file Serializable.cpp.

◆ getBuffAddrSer()

U8 * Fw::SerializeBufferBase::getBuffAddrSer ( )

gets address of end of serialization. DANGEROUS! Need to know max buffer size and adjust when done

Definition at line 697 of file Serializable.cpp.

◆ getBuffCapacity()

virtual NATIVE_UINT_TYPE Fw::SerializeBufferBase::getBuffCapacity ( ) const
pure virtual

returns capacity, not current size, of buffer

Implemented in Utils::HashBuffer, Fw::ExternalSerializeBuffer, Fw::SerialBuffer, Fw::TlmBuffer, Fw::ParamBuffer, Fw::LogBuffer, Fw::ActiveComponentExitSerializableBuffer, Fw::ComBuffer, Fw::CmdArgBuffer, and Drv::DataBuffer.

◆ getBuffLeft()

NATIVE_UINT_TYPE Fw::SerializeBufferBase::getBuffLeft ( ) const

returns how much deserialization buffer is left

Definition at line 653 of file Serializable.cpp.

◆ getBuffLength()

NATIVE_UINT_TYPE Fw::SerializeBufferBase::getBuffLength ( ) const

returns current buffer size

Definition at line 626 of file Serializable.cpp.

◆ moveDeserToOffset()

SerializeStatus Fw::SerializeBufferBase::moveDeserToOffset ( FwSizeType  offset)

Moves deserialization to the specified offset.

Definition at line 619 of file Serializable.cpp.

◆ moveSerToOffset()

SerializeStatus Fw::SerializeBufferBase::moveSerToOffset ( FwSizeType  offset)

Moves serialization to the specified offset.

Definition at line 613 of file Serializable.cpp.

◆ operator=()

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

equal operator

Definition at line 60 of file Serializable.cpp.

◆ resetDeser()

void Fw::SerializeBufferBase::resetDeser ( )

reset deserialization to beginning

Definition at line 580 of file Serializable.cpp.

◆ resetSer()

void Fw::SerializeBufferBase::resetSer ( )

reset to beginning of buffer to reuse for serialization

Definition at line 575 of file Serializable.cpp.

◆ serialize() [1/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( bool  val)

serialize boolean

Definition at line 210 of file Serializable.cpp.

◆ serialize() [2/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( const Serializable &  val)

serialize an object derived from serializable base class

Definition at line 260 of file Serializable.cpp.

◆ serialize() [3/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( const SerializeBufferBase &  val)

serialize a serialized buffer

Definition at line 264 of file Serializable.cpp.

◆ serialize() [4/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( const U8 *  buff,
NATIVE_UINT_TYPE  length,
bool  noLength = false 
)

serialize data buffer

Definition at line 237 of file Serializable.cpp.

◆ serialize() [5/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( const void *  val)

serialize pointer (careful, only pointer value, not contents are serialized)

Definition at line 227 of file Serializable.cpp.

◆ serialize() [6/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( F32  val)

serialize 32-bit floating point

Definition at line 201 of file Serializable.cpp.

◆ serialize() [7/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( I8  val)

serialize 8-bit signed int

Definition at line 79 of file Serializable.cpp.

◆ serialize() [8/8]

SerializeStatus Fw::SerializeBufferBase::serialize ( U8  val)

serialize 8-bit unsigned int

Definition at line 67 of file Serializable.cpp.

◆ serializeSkip()

SerializeStatus Fw::SerializeBufferBase::serializeSkip ( FwSizeType  numBytesToSkip)

Skips the number of specified bytes for serialization.

Definition at line 584 of file Serializable.cpp.

◆ setBuff()

SerializeStatus Fw::SerializeBufferBase::setBuff ( const U8 *  src,
NATIVE_UINT_TYPE  length 
)

sets buffer contents and size

Definition at line 630 of file Serializable.cpp.

◆ setBuffLen()

SerializeStatus Fw::SerializeBufferBase::setBuffLen ( NATIVE_UINT_TYPE  length)

sets buffer length manually after filling with data

Definition at line 643 of file Serializable.cpp.

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