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

#include <Fw/Cmd/CmdPortAc.hpp>

Inheritance diagram for Fw::CmdPortBuffer:
Fw::LinearBufferBase Fw::SerialBufferBase

Public Member Functions

Fw::Serializable::SizeType getCapacity () const override
 
U8getBuffAddr () override
 
const U8getBuffAddr () const override
 
- Public Member Functions inherited from Fw::LinearBufferBase
virtual ~LinearBufferBase ()
 Destructor. More...
 
SerializeStatus serializeFrom (U8 val, Endianness mode=Endianness::BIG) override
 Serialize an 8-bit unsigned integer value. More...
 
SerializeStatus serializeFrom (I8 val, Endianness mode=Endianness::BIG) override
 Serialize an 8-bit signed integer value. More...
 
SerializeStatus serializeFrom (F32 val, Endianness mode=Endianness::BIG) override
 Serialize a 32-bit floating point value. More...
 
SerializeStatus serializeFrom (F64 val, Endianness mode=Endianness::BIG) override
 Serialize a 64-bit floating point value. More...
 
SerializeStatus serializeFrom (bool val, Endianness mode=Endianness::BIG) override
 Serialize a boolean value. More...
 
SerializeStatus serializeFrom (const void *val, Endianness mode=Endianness::BIG) override
 Serialize a pointer value. More...
 
SerializeStatus serializeFrom (const U8 *buff, FwSizeType length, Endianness endianMode=Endianness::BIG) override
 Serialize a data buffer. More...
 
SerializeStatus serializeFrom (const U8 *buff, FwSizeType length, Serialization::t lengthMode, Endianness endianMode=Endianness::BIG) override
 Serialize a byte buffer with optional length prefix. More...
 
SerializeStatus serializeFrom (const LinearBufferBase &val, Endianness mode=Endianness::BIG) override
 Serialize another LinearBufferBase object. More...
 
SerializeStatus serializeFrom (const Serializable &val, Endianness mode=Endianness::BIG) override
 Serialize a Serializable object. More...
 
SerializeStatus serializeSize (const FwSizeType size, Endianness mode=Endianness::BIG) override
 Serialize a size value. More...
 
SerializeStatus deserializeTo (U8 &val, Endianness mode=Endianness::BIG) override
 Deserialize an 8-bit unsigned integer value. More...
 
SerializeStatus deserializeTo (I8 &val, Endianness mode=Endianness::BIG) override
 Deserialize an 8-bit signed integer value. More...
 
SerializeStatus deserializeTo (F32 &val, Endianness mode=Endianness::BIG) override
 Deserialize a 32-bit floating point value. More...
 
SerializeStatus deserializeTo (F64 &val, Endianness mode=Endianness::BIG) override
 Deserialize a 64-bit floating point value. More...
 
SerializeStatus deserializeTo (bool &val, Endianness mode=Endianness::BIG) override
 Deserialize a boolean value. More...
 
SerializeStatus deserializeTo (void *&val, Endianness mode=Endianness::BIG) override
 Deserialize a pointer value. More...
 
SerializeStatus deserializeTo (U8 *buff, FwSizeType &length, Endianness endianMode=Endianness::BIG) override
 Deserialize a data buffer. More...
 
SerializeStatus deserializeTo (U8 *buff, FwSizeType &length, Serialization::t lengthMode, Endianness endianMode=Endianness::BIG) override
 Deserialize a byte buffer with optional length prefix. More...
 
SerializeStatus deserializeTo (Serializable &val, Endianness mode=Endianness::BIG) override
 Deserialize a Serializable object. More...
 
SerializeStatus deserializeTo (LinearBufferBase &val, Endianness mode=Endianness::BIG) override
 Deserialize a LinearBufferBase object. More...
 
SerializeStatus deserializeSize (FwSizeType &size, Endianness mode=Endianness::BIG) override
 Deserialize a size value. More...
 
 DEPRECATED (SerializeStatus serialize(const LinearBufferBase &val), "Use serializeFrom(const SerialBufferBase& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(LinearBufferBase &val), "Use deserializeTo(SerialBufferBase& val) instead")
 
void resetSer () override
 Reset serialization pointer to beginning of buffer. More...
 
void resetDeser () override
 Reset deserialization pointer to beginning of buffer. More...
 
SerializeStatus moveSerToOffset (FwSizeType offset) override
 Move serialization pointer to specified offset. More...
 
SerializeStatus moveDeserToOffset (FwSizeType offset) override
 Move deserialization pointer to specified offset. More...
 
SerializeStatus serializeSkip (FwSizeType numBytesToSkip) override
 Skip specified number of bytes during serialization. More...
 
SerializeStatus deserializeSkip (FwSizeType numBytesToSkip) override
 Skip specified number of bytes during deserialization. More...
 
 DEPRECATED (Serializable::SizeType getBuffCapacity() const, "Use getCapacity() instead")
 
 DEPRECATED (Serializable::SizeType getBuffLength() const, "Use getSize() instead")
 
 DEPRECATED (Serializable::SizeType getBuffLeft(), "Use getDeserializeSizeLeft() instead")
 
Serializable::SizeType getSize () const override
 Get current buffer size. More...
 
Serializable::SizeType getDeserializeSizeLeft () const override
 Get remaining deserialization buffer size. More...
 
Serializable::SizeType getSerializeSizeLeft () const override
 Get remaining serialization buffer size. More...
 
const U8getBuffAddrLeft () const
 Get address of remaining non-deserialized data. More...
 
U8getBuffAddrSer ()
 Get address of end of serialization (DANGEROUS!) More...
 
SerializeStatus setBuff (const U8 *src, Serializable::SizeType length) override
 Set buffer contents from external source. More...
 
SerializeStatus setBuffLen (Serializable::SizeType length) override
 Set buffer length manually. More...
 
SerializeStatus copyRaw (SerialBufferBase &dest, Serializable::SizeType size) override
 Copy raw bytes from this buffer to destination and advance source offset. More...
 
SerializeStatus copyRawOffset (SerialBufferBase &dest, Serializable::SizeType size) override
 Append raw bytes to destination from this buffer and advance source offset. More...
 
 DEPRECATED (SerializeStatus serialize(U8 val), "Use serializeFrom(U8 val) instead")
 
 DEPRECATED (SerializeStatus serialize(I8 val), "Use serializeFrom(I8 val) instead")
 
 DEPRECATED (SerializeStatus serialize(F32 val), "Use serializeFrom(F32 val) instead")
 
 DEPRECATED (SerializeStatus serialize(F64 val), "Use serializeFrom(F64 val) instead")
 
 DEPRECATED (SerializeStatus serialize(bool val), "Use serializeFrom(bool val) instead")
 
 DEPRECATED (SerializeStatus serialize(const void *val), "Use serializeFrom(const void* val) instead")
 
 DEPRECATED (SerializeStatus serialize(const U8 *buff, FwSizeType length, bool noLength), "Use serialize(const U8* buff, FwSizeType length, Serialization::t mode) instead")
 
 DEPRECATED (SerializeStatus serialize(const U8 *buff, FwSizeType length), "Use serializeFrom(const U8* buff, FwSizeType length) instead")
 
 DEPRECATED (SerializeStatus serialize(const U8 *buff, FwSizeType length, Serialization::t mode), "Use serializeFrom(const U8* buff, FwSizeType length, Serialization::t mode) instead")
 
 DEPRECATED (SerializeStatus serialize(const Serializable &val), "Use serializeFrom(const Serializable& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(U8 &val), "Use deserializeTo(U8& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(I8 &val), "Use deserializeTo(I8& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(F32 &val), "Use deserializeTo(F32& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(F64 &val), "Use deserializeTo(F64& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(bool &val), "Use deserializeTo(bool& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(void *&val), "Use deserializeTo(void*& val) instead")
 
 DEPRECATED (SerializeStatus deserialize(U8 *buff, FwSizeType &length, bool noLength), "Use deserialize(U8* buff, FwSizeType& length, Serialization::t mode) instead")
 
 DEPRECATED (SerializeStatus deserialize(U8 *buff, FwSizeType &length), "Use deserializeTo(U8* buff, FwSizeType& length) instead")
 
 DEPRECATED (SerializeStatus deserialize(U8 *buff, FwSizeType &length, Serialization::t mode), "Use deserializeTo(U8* buff, FwSizeType& length, Serialization::t mode) instead")
 
 DEPRECATED (SerializeStatus deserialize(Serializable &val), "Use deserializeTo(Serializable& val) instead")
 
- Public Member Functions inherited from Fw::SerialBufferBase
virtual ~SerialBufferBase ()
 Virtual destructor. More...
 

Static Public Attributes

static constexpr FwSizeType CAPACITY
 

Additional Inherited Members

- Static Public Member Functions inherited from Fw::LinearBufferBase
static constexpr Serializable::SizeType STATIC_SERIALIZED_SIZE (Serializable::SizeType maxSize)
 Get the static serialized size of a buffer This is the max size of the buffer data plus the size of the stored size. More...
 
- Protected Member Functions inherited from Fw::LinearBufferBase
LinearBufferBaseoperator= (const LinearBufferBase &src)
 Copy assignment operator. More...
 
 LinearBufferBase ()
 Default constructor. More...
 
 LinearBufferBase (const LinearBufferBase &src)
 Copy constructor (protected) More...
 
void copyFrom (const LinearBufferBase &src)
 Copy data from source buffer. More...
 
- Protected Attributes inherited from Fw::LinearBufferBase
Serializable::SizeType m_serLoc
 current offset in buffer of serialized data More...
 
Serializable::SizeType m_deserLoc
 current offset for deserialization More...
 

Detailed Description

Serialization buffer for Cmd port Port for sending commands

Definition at line 24 of file CmdPortAc.hpp.

Member Function Documentation

◆ getBuffAddr() [1/2]

U8* Fw::CmdPortBuffer::getBuffAddr ( )
inlineoverridevirtual

Get the buffer address (non-const)

Returns
The buffer address

Implements Fw::LinearBufferBase.

Definition at line 55 of file CmdPortAc.hpp.

◆ getBuffAddr() [2/2]

const U8* Fw::CmdPortBuffer::getBuffAddr ( ) const
inlineoverridevirtual

Get the buffer address (const)

Returns
The buffer address

Implements Fw::LinearBufferBase.

Definition at line 61 of file CmdPortAc.hpp.

◆ getCapacity()

Fw::Serializable::SizeType Fw::CmdPortBuffer::getCapacity ( ) const
inlineoverridevirtual

Get the capacity of the buffer

Returns
The capacity

Implements Fw::LinearBufferBase.

Definition at line 49 of file CmdPortAc.hpp.

Member Data Documentation

◆ CAPACITY

constexpr FwSizeType Fw::CmdPortBuffer::CAPACITY
static
Initial value:

The buffer capacity. This is the sum of the static serialized sizes of the port arguments.

Definition at line 36 of file CmdPortAc.hpp.


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