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

#include <Svc/Seq/SeqArgsSerializableAc.hpp>

Inheritance diagram for Svc::SeqArgs:
Fw::Serializable

Public Types

enum  { SERIALIZED_SIZE }
 
using Type_of_buffer = U8[255]
 The type of buffer. More...
 
- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 

Public Member Functions

 SeqArgs ()
 Constructor (default value) More...
 
 SeqArgs (FwSizeType size, const Type_of_buffer &buffer)
 Member constructor. More...
 
 SeqArgs (const SeqArgs &obj)
 Copy constructor. More...
 
 SeqArgs (FwSizeType size, U8 buffer)
 Member constructor (scalar values for arrays) More...
 
SeqArgsoperator= (const SeqArgs &obj)
 Copy assignment operator. More...
 
bool operator== (const SeqArgs &obj) const
 Equality operator. More...
 
bool operator!= (const SeqArgs &obj) const
 Inequality operator. More...
 
Fw::SerializeStatus serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
 Serialization. More...
 
Fw::SerializeStatus deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
 Deserialization. More...
 
FwSizeType serializedSize () const
 Get the dynamic serialized size of the struct. More...
 
FwSizeType get_size () const
 Get member size. More...
 
Type_of_bufferget_buffer ()
 Get member buffer. More...
 
const Type_of_bufferget_buffer () const
 Get member buffer (const) More...
 
void set (FwSizeType size, const Type_of_buffer &buffer)
 Set all members. More...
 
void set_size (FwSizeType size)
 Set member size. More...
 
void set_buffer (const Type_of_buffer &buffer)
 Set member buffer. More...
 
- Public Member Functions inherited from Fw::Serializable
 DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
 
 DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")
 

Protected Attributes

FwSizeType m_size
 
U8 m_buffer [255]
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 Virtual destructor. More...
 

Detailed Description

Definition at line 18 of file SeqArgsSerializableAc.hpp.

Member Typedef Documentation

◆ Type_of_buffer

The type of buffer.

Definition at line 29 of file SeqArgsSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 37 of file SeqArgsSerializableAc.hpp.

Constructor & Destructor Documentation

◆ SeqArgs() [1/4]

Svc::SeqArgs::SeqArgs ( )

Constructor (default value)

Definition at line 17 of file SeqArgsSerializableAc.cpp.

◆ SeqArgs() [2/4]

Svc::SeqArgs::SeqArgs ( FwSizeType  size,
const Type_of_buffer buffer 
)

Member constructor.

Definition at line 26 of file SeqArgsSerializableAc.cpp.

◆ SeqArgs() [3/4]

Svc::SeqArgs::SeqArgs ( const SeqArgs obj)

Copy constructor.

Parameters
objThe source object

Definition at line 39 of file SeqArgsSerializableAc.cpp.

◆ SeqArgs() [4/4]

Svc::SeqArgs::SeqArgs ( FwSizeType  size,
U8  buffer 
)

Member constructor (scalar values for arrays)

Definition at line 49 of file SeqArgsSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::SeqArgs::deserializeFrom ( Fw::SerialBufferBase buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
)
virtual

Deserialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 140 of file SeqArgsSerializableAc.cpp.

◆ get_buffer() [1/2]

Type_of_buffer& Svc::SeqArgs::get_buffer ( )
inline

Get member buffer.

Definition at line 142 of file SeqArgsSerializableAc.hpp.

◆ get_buffer() [2/2]

const Type_of_buffer& Svc::SeqArgs::get_buffer ( ) const
inline

Get member buffer (const)

Definition at line 148 of file SeqArgsSerializableAc.hpp.

◆ get_size()

FwSizeType Svc::SeqArgs::get_size ( ) const
inline

Get member size.

Definition at line 136 of file SeqArgsSerializableAc.hpp.

◆ operator!=()

bool Svc::SeqArgs::operator!= ( const SeqArgs obj) const

Inequality operator.

Parameters
objThe other object

Definition at line 97 of file SeqArgsSerializableAc.cpp.

◆ operator=()

SeqArgs & Svc::SeqArgs::operator= ( const SeqArgs obj)

Copy assignment operator.

Parameters
objThe source object

Definition at line 66 of file SeqArgsSerializableAc.cpp.

◆ operator==()

bool Svc::SeqArgs::operator== ( const SeqArgs obj) const

Equality operator.

Parameters
objThe other object

Definition at line 77 of file SeqArgsSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::SeqArgs::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 162 of file SeqArgsSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::SeqArgs::serializeTo ( Fw::SerialBufferBase buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
) const
virtual

Serialization.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 118 of file SeqArgsSerializableAc.cpp.

◆ set()

void Svc::SeqArgs::set ( FwSizeType  size,
const Type_of_buffer buffer 
)

Set all members.

Definition at line 205 of file SeqArgsSerializableAc.cpp.

◆ set_buffer()

void Svc::SeqArgs::set_buffer ( const Type_of_buffer buffer)

Set member buffer.

Definition at line 224 of file SeqArgsSerializableAc.cpp.

◆ set_size()

void Svc::SeqArgs::set_size ( FwSizeType  size)

Set member size.

Definition at line 218 of file SeqArgsSerializableAc.cpp.

Member Data Documentation

◆ m_buffer

U8 Svc::SeqArgs::m_buffer[255]
protected

Definition at line 176 of file SeqArgsSerializableAc.hpp.

◆ m_size

FwSizeType Svc::SeqArgs::m_size
protected

Definition at line 175 of file SeqArgsSerializableAc.hpp.


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