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

Rate policy. More...

#include <Svc/TlmPacketizer/RateConfigSerializableAc.hpp>

Inheritance diagram for Svc::RateConfig:
Fw::Serializable

Public Types

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

Public Member Functions

 RateConfig ()
 Constructor (default value) More...
 
 RateConfig (Svc::RateLogic::T rateLogic, U32 min, U32 max)
 Member constructor. More...
 
 RateConfig (const RateConfig &obj)
 Copy constructor. More...
 
RateConfig & operator= (const RateConfig &obj)
 Copy assignment operator. More...
 
bool operator== (const RateConfig &obj) const
 Equality operator. More...
 
bool operator!= (const RateConfig &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::RateLogic::T get_rateLogic () const
 Get member rateLogic. More...
 
U32 get_min () const
 Get member min. More...
 
U32 get_max () const
 Get member max. More...
 
void set (Svc::RateLogic::T rateLogic, U32 min, U32 max)
 Set all members. More...
 
void set_rateLogic (Svc::RateLogic::T rateLogic)
 Set member rateLogic. More...
 
void set_min (U32 min)
 Set member min. More...
 
void set_max (U32 max)
 Set member max. 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::RateLogic m_rateLogic
 
U32 m_min
 
U32 m_max
 

Additional Inherited Members

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

Detailed Description

Rate policy.

Definition at line 19 of file RateConfigSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 29 of file RateConfigSerializableAc.hpp.

Constructor & Destructor Documentation

◆ RateConfig() [1/3]

Svc::RateConfig::RateConfig ( )

Constructor (default value)

Definition at line 17 of file RateConfigSerializableAc.cpp.

◆ RateConfig() [2/3]

Svc::RateConfig::RateConfig ( Svc::RateLogic::T  rateLogic,
U32  min,
U32  max 
)

Member constructor.

Definition at line 27 of file RateConfigSerializableAc.cpp.

◆ RateConfig() [3/3]

Svc::RateConfig::RateConfig ( const RateConfig &  obj)

Copy constructor.

Parameters
objThe source object

Definition at line 41 of file RateConfigSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::RateConfig::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 122 of file RateConfigSerializableAc.cpp.

◆ get_max()

U32 Svc::RateConfig::get_max ( ) const
inline

Get member max.

Definition at line 136 of file RateConfigSerializableAc.hpp.

◆ get_min()

U32 Svc::RateConfig::get_min ( ) const
inline

Get member min.

Definition at line 130 of file RateConfigSerializableAc.hpp.

◆ get_rateLogic()

Svc::RateLogic::T Svc::RateConfig::get_rateLogic ( ) const
inline

Get member rateLogic.

Definition at line 124 of file RateConfigSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 77 of file RateConfigSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 55 of file RateConfigSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 66 of file RateConfigSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::RateConfig::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 146 of file RateConfigSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::RateConfig::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 98 of file RateConfigSerializableAc.cpp.

◆ set()

void Svc::RateConfig::set ( Svc::RateLogic::T  rateLogic,
U32  min,
U32  max 
)

Set all members.

Definition at line 189 of file RateConfigSerializableAc.cpp.

◆ set_max()

void Svc::RateConfig::set_max ( U32  max)

Set member max.

Definition at line 213 of file RateConfigSerializableAc.cpp.

◆ set_min()

void Svc::RateConfig::set_min ( U32  min)

Set member min.

Definition at line 207 of file RateConfigSerializableAc.cpp.

◆ set_rateLogic()

void Svc::RateConfig::set_rateLogic ( Svc::RateLogic::T  rateLogic)

Set member rateLogic.

Definition at line 201 of file RateConfigSerializableAc.cpp.

Member Data Documentation

◆ m_max

U32 Svc::RateConfig::m_max
protected

Definition at line 169 of file RateConfigSerializableAc.hpp.

◆ m_min

U32 Svc::RateConfig::m_min
protected

Definition at line 168 of file RateConfigSerializableAc.hpp.

◆ m_rateLogic

Svc::RateLogic Svc::RateConfig::m_rateLogic
protected

Definition at line 167 of file RateConfigSerializableAc.hpp.


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