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

Describes the frame trailer format for a Telemetry (TM) Transfer Frame. More...

#include <Svc/Ccsds/Types/TMTrailerSerializableAc.hpp>

Inheritance diagram for Svc::Ccsds::TMTrailer:
Fw::Serializable

Public Types

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

Public Member Functions

 TMTrailer ()
 Constructor (default value) More...
 
 TMTrailer (U16 fecf)
 Member constructor. More...
 
 TMTrailer (const TMTrailer &obj)
 Copy constructor. More...
 
TMTraileroperator= (const TMTrailer &obj)
 Copy assignment operator. More...
 
bool operator== (const TMTrailer &obj) const
 Equality operator. More...
 
bool operator!= (const TMTrailer &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...
 
U16 get_fecf () const
 Get member fecf. More...
 
void set (U16 fecf)
 Set all members. More...
 
void set_fecf (U16 fecf)
 Set member fecf. 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

U16 m_fecf
 

Additional Inherited Members

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

Detailed Description

Describes the frame trailer format for a Telemetry (TM) Transfer Frame.

Definition at line 20 of file TMTrailerSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 30 of file TMTrailerSerializableAc.hpp.

Constructor & Destructor Documentation

◆ TMTrailer() [1/3]

Svc::Ccsds::TMTrailer::TMTrailer ( )

Constructor (default value)

Definition at line 19 of file TMTrailerSerializableAc.cpp.

◆ TMTrailer() [2/3]

Svc::Ccsds::TMTrailer::TMTrailer ( U16  fecf)

Member constructor.

Definition at line 27 of file TMTrailerSerializableAc.cpp.

◆ TMTrailer() [3/3]

Svc::Ccsds::TMTrailer::TMTrailer ( const TMTrailer obj)

Copy constructor.

Parameters
objThe source object

Definition at line 35 of file TMTrailerSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::Ccsds::TMTrailer::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 101 of file TMTrailerSerializableAc.cpp.

◆ get_fecf()

U16 Svc::Ccsds::TMTrailer::get_fecf ( ) const
inline

Get member fecf.

Definition at line 119 of file TMTrailerSerializableAc.hpp.

◆ operator!=()

bool Svc::Ccsds::TMTrailer::operator!= ( const TMTrailer obj) const

Inequality operator.

Parameters
objThe other object

Definition at line 64 of file TMTrailerSerializableAc.cpp.

◆ operator=()

TMTrailer & Svc::Ccsds::TMTrailer::operator= ( const TMTrailer obj)

Copy assignment operator.

Parameters
objThe source object

Definition at line 47 of file TMTrailerSerializableAc.cpp.

◆ operator==()

bool Svc::Ccsds::TMTrailer::operator== ( const TMTrailer obj) const

Equality operator.

Parameters
objThe other object

Definition at line 58 of file TMTrailerSerializableAc.cpp.

◆ serializedSize()

FwSizeType Svc::Ccsds::TMTrailer::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 117 of file TMTrailerSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::Ccsds::TMTrailer::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 85 of file TMTrailerSerializableAc.cpp.

◆ set()

void Svc::Ccsds::TMTrailer::set ( U16  fecf)

Set all members.

Definition at line 146 of file TMTrailerSerializableAc.cpp.

◆ set_fecf()

void Svc::Ccsds::TMTrailer::set_fecf ( U16  fecf)

Set member fecf.

Definition at line 152 of file TMTrailerSerializableAc.cpp.

Member Data Documentation

◆ m_fecf

U16 Svc::Ccsds::TMTrailer::m_fecf
protected

Definition at line 140 of file TMTrailerSerializableAc.hpp.


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