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

Describes the frame header format for a Advanced Orbiting Systems (AOS) Space Data Link (SDL) Transfer Frame. More...

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

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

Public Types

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

Public Member Functions

 AOSHeader ()
 Constructor (default value) More...
 
 AOSHeader (U16 globalVcId, U32 frameCountAndSignaling)
 Member constructor. More...
 
 AOSHeader (const AOSHeader &obj)
 Copy constructor. More...
 
AOSHeaderoperator= (const AOSHeader &obj)
 Copy assignment operator. More...
 
bool operator== (const AOSHeader &obj) const
 Equality operator. More...
 
bool operator!= (const AOSHeader &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_globalVcId () const
 Get member globalVcId. More...
 
U32 get_frameCountAndSignaling () const
 Get member frameCountAndSignaling. More...
 
void set (U16 globalVcId, U32 frameCountAndSignaling)
 Set all members. More...
 
void set_globalVcId (U16 globalVcId)
 Set member globalVcId. More...
 
void set_frameCountAndSignaling (U32 frameCountAndSignaling)
 Set member frameCountAndSignaling. 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_globalVcId
 
U32 m_frameCountAndSignaling
 

Additional Inherited Members

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

Detailed Description

Describes the frame header format for a Advanced Orbiting Systems (AOS) Space Data Link (SDL) Transfer Frame.

Definition at line 20 of file AOSHeaderSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

Definition at line 30 of file AOSHeaderSerializableAc.hpp.

Constructor & Destructor Documentation

◆ AOSHeader() [1/3]

Svc::Ccsds::AOSHeader::AOSHeader ( )

Constructor (default value)

Definition at line 19 of file AOSHeaderSerializableAc.cpp.

◆ AOSHeader() [2/3]

Svc::Ccsds::AOSHeader::AOSHeader ( U16  globalVcId,
U32  frameCountAndSignaling 
)

Member constructor.

Definition at line 28 of file AOSHeaderSerializableAc.cpp.

◆ AOSHeader() [3/3]

Svc::Ccsds::AOSHeader::AOSHeader ( const AOSHeader obj)

Copy constructor.

Parameters
objThe source object

Definition at line 40 of file AOSHeaderSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::Ccsds::AOSHeader::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 115 of file AOSHeaderSerializableAc.cpp.

◆ get_frameCountAndSignaling()

U32 Svc::Ccsds::AOSHeader::get_frameCountAndSignaling ( ) const
inline

Get member frameCountAndSignaling.

Definition at line 129 of file AOSHeaderSerializableAc.hpp.

◆ get_globalVcId()

U16 Svc::Ccsds::AOSHeader::get_globalVcId ( ) const
inline

Get member globalVcId.

Definition at line 123 of file AOSHeaderSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters
objThe other object

Definition at line 74 of file AOSHeaderSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters
objThe source object

Definition at line 53 of file AOSHeaderSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters
objThe other object

Definition at line 64 of file AOSHeaderSerializableAc.cpp.

◆ serializedSize()

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

Get the dynamic serialized size of the struct.

Definition at line 135 of file AOSHeaderSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::Ccsds::AOSHeader::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 95 of file AOSHeaderSerializableAc.cpp.

◆ set()

void Svc::Ccsds::AOSHeader::set ( U16  globalVcId,
U32  frameCountAndSignaling 
)

Set all members.

Definition at line 171 of file AOSHeaderSerializableAc.cpp.

◆ set_frameCountAndSignaling()

void Svc::Ccsds::AOSHeader::set_frameCountAndSignaling ( U32  frameCountAndSignaling)

Set member frameCountAndSignaling.

Definition at line 187 of file AOSHeaderSerializableAc.cpp.

◆ set_globalVcId()

void Svc::Ccsds::AOSHeader::set_globalVcId ( U16  globalVcId)

Set member globalVcId.

Definition at line 181 of file AOSHeaderSerializableAc.cpp.

Member Data Documentation

◆ m_frameCountAndSignaling

U32 Svc::Ccsds::AOSHeader::m_frameCountAndSignaling
protected

Definition at line 157 of file AOSHeaderSerializableAc.hpp.

◆ m_globalVcId

U16 Svc::Ccsds::AOSHeader::m_globalVcId
protected

Definition at line 156 of file AOSHeaderSerializableAc.hpp.


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