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

A single per-packet override record: mirrored on packetOverrideOut, reloaded from packetOverrideIn, reported by GET_PACKET_CONFIG. More...

#include <Svc/TlmPacketizer/PacketConfigEntrySerializableAc.hpp>

Inheritance diagram for Svc::PacketConfigEntry:
Fw::Serializable

Public Types

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

Public Member Functions

 PacketConfigEntry ()
 Constructor (default value) More...
 
 PacketConfigEntry (U32 packetId, Svc::TelemetrySection::T section, const Svc::PacketOverrideConfig &override)
 Member constructor. More...
 
 PacketConfigEntry (const PacketConfigEntry &obj)
 Copy constructor. More...
 
PacketConfigEntry & operator= (const PacketConfigEntry &obj)
 Copy assignment operator. More...
 
bool operator== (const PacketConfigEntry &obj) const
 Equality operator. More...
 
bool operator!= (const PacketConfigEntry &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...
 
U32 get_packetId () const
 Get member packetId. More...
 
Svc::TelemetrySection::T get_section () const
 Get member section. More...
 
Svc::PacketOverrideConfig & get_override ()
 Get member override. More...
 
const Svc::PacketOverrideConfig & get_override () const
 Get member override (const) More...
 
void set (U32 packetId, Svc::TelemetrySection::T section, const Svc::PacketOverrideConfig &override)
 Set all members. More...
 
void set_packetId (U32 packetId)
 Set member packetId. More...
 
void set_section (Svc::TelemetrySection::T section)
 Set member section. More...
 
void set_override (const Svc::PacketOverrideConfig &override)
 Set member override. 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

U32 m_packetId
 
Svc::TelemetrySection m_section
 
Svc::PacketOverrideConfig m_override
 

Additional Inherited Members

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

Detailed Description

A single per-packet override record: mirrored on packetOverrideOut, reloaded from packetOverrideIn, reported by GET_PACKET_CONFIG.

Definition at line 20 of file PacketConfigEntrySerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 30 of file PacketConfigEntrySerializableAc.hpp.

Constructor & Destructor Documentation

◆ PacketConfigEntry() [1/3]

Svc::PacketConfigEntry::PacketConfigEntry ( )

Constructor (default value)

Definition at line 17 of file PacketConfigEntrySerializableAc.cpp.

◆ PacketConfigEntry() [2/3]

Svc::PacketConfigEntry::PacketConfigEntry ( U32  packetId,
Svc::TelemetrySection::T  section,
const Svc::PacketOverrideConfig &  override 
)

Member constructor.

Definition at line 27 of file PacketConfigEntrySerializableAc.cpp.

◆ PacketConfigEntry() [3/3]

Svc::PacketConfigEntry::PacketConfigEntry ( const PacketConfigEntry &  obj)

Copy constructor.

Parameters
objThe source object

Definition at line 41 of file PacketConfigEntrySerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::PacketConfigEntry::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 PacketConfigEntrySerializableAc.cpp.

◆ get_override() [1/2]

Svc::PacketOverrideConfig& Svc::PacketConfigEntry::get_override ( )
inline

Get member override.

Definition at line 137 of file PacketConfigEntrySerializableAc.hpp.

◆ get_override() [2/2]

const Svc::PacketOverrideConfig& Svc::PacketConfigEntry::get_override ( ) const
inline

Get member override (const)

Definition at line 143 of file PacketConfigEntrySerializableAc.hpp.

◆ get_packetId()

U32 Svc::PacketConfigEntry::get_packetId ( ) const
inline

Get member packetId.

Definition at line 125 of file PacketConfigEntrySerializableAc.hpp.

◆ get_section()

Svc::TelemetrySection::T Svc::PacketConfigEntry::get_section ( ) const
inline

Get member section.

Definition at line 131 of file PacketConfigEntrySerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 77 of file PacketConfigEntrySerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 55 of file PacketConfigEntrySerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 66 of file PacketConfigEntrySerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::PacketConfigEntry::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 146 of file PacketConfigEntrySerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::PacketConfigEntry::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 PacketConfigEntrySerializableAc.cpp.

◆ set()

void Svc::PacketConfigEntry::set ( U32  packetId,
Svc::TelemetrySection::T  section,
const Svc::PacketOverrideConfig &  override 
)

Set all members.

Definition at line 189 of file PacketConfigEntrySerializableAc.cpp.

◆ set_override()

void Svc::PacketConfigEntry::set_override ( const Svc::PacketOverrideConfig &  override)

Set member override.

Definition at line 213 of file PacketConfigEntrySerializableAc.cpp.

◆ set_packetId()

void Svc::PacketConfigEntry::set_packetId ( U32  packetId)

Set member packetId.

Definition at line 201 of file PacketConfigEntrySerializableAc.cpp.

◆ set_section()

void Svc::PacketConfigEntry::set_section ( Svc::TelemetrySection::T  section)

Set member section.

Definition at line 207 of file PacketConfigEntrySerializableAc.cpp.

Member Data Documentation

◆ m_override

Svc::PacketOverrideConfig Svc::PacketConfigEntry::m_override
protected

Definition at line 176 of file PacketConfigEntrySerializableAc.hpp.

◆ m_packetId

U32 Svc::PacketConfigEntry::m_packetId
protected

Definition at line 174 of file PacketConfigEntrySerializableAc.hpp.

◆ m_section

Svc::TelemetrySection Svc::PacketConfigEntry::m_section
protected

Definition at line 175 of file PacketConfigEntrySerializableAc.hpp.


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