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

Per-packet override: which fields apply and their values. More...

#include <Svc/TlmPacketizer/PacketOverrideConfigSerializableAc.hpp>

Inheritance diagram for Svc::PacketOverrideConfig:
Fw::Serializable

Public Types

enum  { SERIALIZED_SIZE }
 
- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 

Public Member Functions

 PacketOverrideConfig ()
 Constructor (default value) More...
 
 PacketOverrideConfig (Svc::PacketOverrideType::T overrideType, const Svc::TlmSendConfig &sendConfig)
 Member constructor. More...
 
 PacketOverrideConfig (const PacketOverrideConfig &obj)
 Copy constructor. More...
 
PacketOverrideConfig & operator= (const PacketOverrideConfig &obj)
 Copy assignment operator. More...
 
bool operator== (const PacketOverrideConfig &obj) const
 Equality operator. More...
 
bool operator!= (const PacketOverrideConfig &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...
 
Svc::PacketOverrideType::T get_overrideType () const
 Get member overrideType. More...
 
Svc::TlmSendConfig & get_sendConfig ()
 Get member sendConfig. More...
 
const Svc::TlmSendConfig & get_sendConfig () const
 Get member sendConfig (const) More...
 
void set (Svc::PacketOverrideType::T overrideType, const Svc::TlmSendConfig &sendConfig)
 Set all members. More...
 
void set_overrideType (Svc::PacketOverrideType::T overrideType)
 Set member overrideType. More...
 
void set_sendConfig (const Svc::TlmSendConfig &sendConfig)
 Set member sendConfig. 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

Svc::PacketOverrideType m_overrideType
 
Svc::TlmSendConfig m_sendConfig
 

Additional Inherited Members

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

Detailed Description

Per-packet override: which fields apply and their values.

Definition at line 20 of file PacketOverrideConfigSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 30 of file PacketOverrideConfigSerializableAc.hpp.

Constructor & Destructor Documentation

◆ PacketOverrideConfig() [1/3]

Svc::PacketOverrideConfig::PacketOverrideConfig ( )

Constructor (default value)

Definition at line 17 of file PacketOverrideConfigSerializableAc.cpp.

◆ PacketOverrideConfig() [2/3]

Svc::PacketOverrideConfig::PacketOverrideConfig ( Svc::PacketOverrideType::T  overrideType,
const Svc::TlmSendConfig &  sendConfig 
)

Member constructor.

Definition at line 26 of file PacketOverrideConfigSerializableAc.cpp.

◆ PacketOverrideConfig() [3/3]

Svc::PacketOverrideConfig::PacketOverrideConfig ( const PacketOverrideConfig &  obj)

Copy constructor.

Parameters
objThe source object

Definition at line 38 of file PacketOverrideConfigSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::PacketOverrideConfig::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 113 of file PacketOverrideConfigSerializableAc.cpp.

◆ get_overrideType()

Svc::PacketOverrideType::T Svc::PacketOverrideConfig::get_overrideType ( ) const
inline

Get member overrideType.

Definition at line 123 of file PacketOverrideConfigSerializableAc.hpp.

◆ get_sendConfig() [1/2]

Svc::TlmSendConfig& Svc::PacketOverrideConfig::get_sendConfig ( )
inline

Get member sendConfig.

Definition at line 129 of file PacketOverrideConfigSerializableAc.hpp.

◆ get_sendConfig() [2/2]

const Svc::TlmSendConfig& Svc::PacketOverrideConfig::get_sendConfig ( ) const
inline

Get member sendConfig (const)

Definition at line 135 of file PacketOverrideConfigSerializableAc.hpp.

◆ operator!=()

bool Svc::PacketOverrideConfig::operator!= ( const PacketOverrideConfig &  obj) const

Inequality operator.

Parameters
objThe other object

Definition at line 72 of file PacketOverrideConfigSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 51 of file PacketOverrideConfigSerializableAc.cpp.

◆ operator==()

bool Svc::PacketOverrideConfig::operator== ( const PacketOverrideConfig &  obj) const

Equality operator.

Parameters
objThe other object

Definition at line 62 of file PacketOverrideConfigSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::PacketOverrideConfig::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 133 of file PacketOverrideConfigSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::PacketOverrideConfig::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 93 of file PacketOverrideConfigSerializableAc.cpp.

◆ set()

void Svc::PacketOverrideConfig::set ( Svc::PacketOverrideType::T  overrideType,
const Svc::TlmSendConfig &  sendConfig 
)

Set all members.

Definition at line 169 of file PacketOverrideConfigSerializableAc.cpp.

◆ set_overrideType()

void Svc::PacketOverrideConfig::set_overrideType ( Svc::PacketOverrideType::T  overrideType)

Set member overrideType.

Definition at line 179 of file PacketOverrideConfigSerializableAc.cpp.

◆ set_sendConfig()

void Svc::PacketOverrideConfig::set_sendConfig ( const Svc::TlmSendConfig &  sendConfig)

Set member sendConfig.

Definition at line 185 of file PacketOverrideConfigSerializableAc.cpp.

Member Data Documentation

◆ m_overrideType

Svc::PacketOverrideType Svc::PacketOverrideConfig::m_overrideType
protected

Definition at line 162 of file PacketOverrideConfigSerializableAc.hpp.

◆ m_sendConfig

Svc::TlmSendConfig Svc::PacketOverrideConfig::m_sendConfig
protected

Definition at line 163 of file PacketOverrideConfigSerializableAc.hpp.


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