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

Describes the header format for a Advanced Orbiting Systems (AOS) Space Data Link (SDL) multiplex protocol data unit (M_PDU) More...

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

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

Public Types

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

Public Member Functions

 M_PDUHeader ()
 Constructor (default value) More...
 
 M_PDUHeader (U16 firstHeaderPointer)
 Member constructor. More...
 
 M_PDUHeader (const M_PDUHeader &obj)
 Copy constructor. More...
 
M_PDUHeaderoperator= (const M_PDUHeader &obj)
 Copy assignment operator. More...
 
bool operator== (const M_PDUHeader &obj) const
 Equality operator. More...
 
bool operator!= (const M_PDUHeader &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_firstHeaderPointer () const
 Get member firstHeaderPointer. More...
 
void set (U16 firstHeaderPointer)
 Set all members. More...
 
void set_firstHeaderPointer (U16 firstHeaderPointer)
 Set member firstHeaderPointer. 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_firstHeaderPointer
 

Additional Inherited Members

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

Detailed Description

Describes the header format for a Advanced Orbiting Systems (AOS) Space Data Link (SDL) multiplex protocol data unit (M_PDU)

Definition at line 20 of file M_PDUHeaderSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 30 of file M_PDUHeaderSerializableAc.hpp.

Constructor & Destructor Documentation

◆ M_PDUHeader() [1/3]

Svc::Ccsds::M_PDUHeader::M_PDUHeader ( )

Constructor (default value)

Definition at line 19 of file M_PDUHeaderSerializableAc.cpp.

◆ M_PDUHeader() [2/3]

Svc::Ccsds::M_PDUHeader::M_PDUHeader ( U16  firstHeaderPointer)

Member constructor.

Definition at line 27 of file M_PDUHeaderSerializableAc.cpp.

◆ M_PDUHeader() [3/3]

Svc::Ccsds::M_PDUHeader::M_PDUHeader ( const M_PDUHeader obj)

Copy constructor.

Parameters
objThe source object

Definition at line 35 of file M_PDUHeaderSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::Ccsds::M_PDUHeader::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 M_PDUHeaderSerializableAc.cpp.

◆ get_firstHeaderPointer()

U16 Svc::Ccsds::M_PDUHeader::get_firstHeaderPointer ( ) const
inline

Get member firstHeaderPointer.

Definition at line 119 of file M_PDUHeaderSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 64 of file M_PDUHeaderSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 47 of file M_PDUHeaderSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 58 of file M_PDUHeaderSerializableAc.cpp.

◆ serializedSize()

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

Get the dynamic serialized size of the struct.

Definition at line 117 of file M_PDUHeaderSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::Ccsds::M_PDUHeader::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 M_PDUHeaderSerializableAc.cpp.

◆ set()

void Svc::Ccsds::M_PDUHeader::set ( U16  firstHeaderPointer)

Set all members.

Definition at line 146 of file M_PDUHeaderSerializableAc.cpp.

◆ set_firstHeaderPointer()

void Svc::Ccsds::M_PDUHeader::set_firstHeaderPointer ( U16  firstHeaderPointer)

Set member firstHeaderPointer.

Definition at line 152 of file M_PDUHeaderSerializableAc.cpp.

Member Data Documentation

◆ m_firstHeaderPointer

U16 Svc::Ccsds::M_PDUHeader::m_firstHeaderPointer
protected

Definition at line 140 of file M_PDUHeaderSerializableAc.hpp.


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