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

Telemetry send policy (send state + rates), shared by the per-group config and per-packet override. More...

#include <Svc/TlmPacketizer/TlmSendConfigSerializableAc.hpp>

Inheritance diagram for Svc::TlmSendConfig:
Fw::Serializable

Public Types

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

Public Member Functions

 TlmSendConfig ()
 Constructor (default value) More...
 
 TlmSendConfig (Svc::TlmSendState::T sendState, const Svc::RateConfig &rates)
 Member constructor. More...
 
 TlmSendConfig (const TlmSendConfig &obj)
 Copy constructor. More...
 
TlmSendConfig & operator= (const TlmSendConfig &obj)
 Copy assignment operator. More...
 
bool operator== (const TlmSendConfig &obj) const
 Equality operator. More...
 
bool operator!= (const TlmSendConfig &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::TlmSendState::T get_sendState () const
 Get member sendState. More...
 
Svc::RateConfig & get_rates ()
 Get member rates. More...
 
const Svc::RateConfig & get_rates () const
 Get member rates (const) More...
 
void set (Svc::TlmSendState::T sendState, const Svc::RateConfig &rates)
 Set all members. More...
 
void set_sendState (Svc::TlmSendState::T sendState)
 Set member sendState. More...
 
void set_rates (const Svc::RateConfig &rates)
 Set member rates. 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::TlmSendState m_sendState
 
Svc::RateConfig m_rates
 

Additional Inherited Members

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

Detailed Description

Telemetry send policy (send state + rates), shared by the per-group config and per-packet override.

Definition at line 20 of file TlmSendConfigSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 30 of file TlmSendConfigSerializableAc.hpp.

Constructor & Destructor Documentation

◆ TlmSendConfig() [1/3]

Svc::TlmSendConfig::TlmSendConfig ( )

Constructor (default value)

Definition at line 17 of file TlmSendConfigSerializableAc.cpp.

◆ TlmSendConfig() [2/3]

Svc::TlmSendConfig::TlmSendConfig ( Svc::TlmSendState::T  sendState,
const Svc::RateConfig &  rates 
)

Member constructor.

Definition at line 26 of file TlmSendConfigSerializableAc.cpp.

◆ TlmSendConfig() [3/3]

Svc::TlmSendConfig::TlmSendConfig ( const TlmSendConfig &  obj)

Copy constructor.

Parameters
objThe source object

Definition at line 38 of file TlmSendConfigSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::TlmSendConfig::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 TlmSendConfigSerializableAc.cpp.

◆ get_rates() [1/2]

Svc::RateConfig& Svc::TlmSendConfig::get_rates ( )
inline

Get member rates.

Definition at line 129 of file TlmSendConfigSerializableAc.hpp.

◆ get_rates() [2/2]

const Svc::RateConfig& Svc::TlmSendConfig::get_rates ( ) const
inline

Get member rates (const)

Definition at line 135 of file TlmSendConfigSerializableAc.hpp.

◆ get_sendState()

Svc::TlmSendState::T Svc::TlmSendConfig::get_sendState ( ) const
inline

Get member sendState.

Definition at line 123 of file TlmSendConfigSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 72 of file TlmSendConfigSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 51 of file TlmSendConfigSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 62 of file TlmSendConfigSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::TlmSendConfig::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 133 of file TlmSendConfigSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::TlmSendConfig::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 TlmSendConfigSerializableAc.cpp.

◆ set()

void Svc::TlmSendConfig::set ( Svc::TlmSendState::T  sendState,
const Svc::RateConfig &  rates 
)

Set all members.

Definition at line 169 of file TlmSendConfigSerializableAc.cpp.

◆ set_rates()

void Svc::TlmSendConfig::set_rates ( const Svc::RateConfig &  rates)

Set member rates.

Definition at line 185 of file TlmSendConfigSerializableAc.cpp.

◆ set_sendState()

void Svc::TlmSendConfig::set_sendState ( Svc::TlmSendState::T  sendState)

Set member sendState.

Definition at line 179 of file TlmSendConfigSerializableAc.cpp.

Member Data Documentation

◆ m_rates

Svc::RateConfig Svc::TlmSendConfig::m_rates
protected

Definition at line 163 of file TlmSendConfigSerializableAc.hpp.

◆ m_sendState

Svc::TlmSendState Svc::TlmSendConfig::m_sendState
protected

Definition at line 162 of file TlmSendConfigSerializableAc.hpp.


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