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

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

Inheritance diagram for Svc::Ccsds::TMHeader:

Public Types
enum	{ SERIALIZED_SIZE }

Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	TMHeader ()
	Constructor (default value) More...

	TMHeader (U16 globalVcId, U8 masterFrameCount, U8 virtualFrameCount, U16 dataFieldStatus)
	Member constructor. More...

	TMHeader (const TMHeader &obj)
	Copy constructor. More...

TMHeader &	operator= (const TMHeader &obj)
	Copy assignment operator. More...

bool	operator== (const TMHeader &obj) const
	Equality operator. More...

bool	operator!= (const TMHeader &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...

U8	get_masterFrameCount () const
	Get member masterFrameCount. More...

U8	get_virtualFrameCount () const
	Get member virtualFrameCount. More...

U16	get_dataFieldStatus () const
	Get member dataFieldStatus. More...

void	set (U16 globalVcId, U8 masterFrameCount, U8 virtualFrameCount, U16 dataFieldStatus)
	Set all members. More...

void	set_globalVcId (U16 globalVcId)
	Set member globalVcId. More...

void	set_masterFrameCount (U8 masterFrameCount)
	Set member masterFrameCount. More...

void	set_virtualFrameCount (U8 virtualFrameCount)
	Set member virtualFrameCount. More...

void	set_dataFieldStatus (U16 dataFieldStatus)
	Set member dataFieldStatus. 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

U8	m_masterFrameCount

U8	m_virtualFrameCount

U16	m_dataFieldStatus

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 Telemetry (TM) Transfer Frame.

Definition at line 20 of file TMHeaderSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 30 of file TMHeaderSerializableAc.hpp.

Constructor & Destructor Documentation

◆ TMHeader() [1/3]

Svc::Ccsds::TMHeader::TMHeader ( )

Constructor (default value)

Definition at line 19 of file TMHeaderSerializableAc.cpp.

◆ TMHeader() [2/3]

Svc::Ccsds::TMHeader::TMHeader	(	U16	globalVcId,
		U8	masterFrameCount,
		U8	virtualFrameCount,
		U16	dataFieldStatus
	)

Member constructor.

Definition at line 30 of file TMHeaderSerializableAc.cpp.

◆ TMHeader() [3/3]

Svc::Ccsds::TMHeader::TMHeader ( const TMHeader & obj )

Copy constructor.

Parameters

obj	The source object

Definition at line 46 of file TMHeaderSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::Ccsds::TMHeader::deserializeFrom	(	Fw::SerialBufferBase &	buffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)

virtual

Deserialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 133 of file TMHeaderSerializableAc.cpp.

◆ get_dataFieldStatus()

U16 Svc::Ccsds::TMHeader::get_dataFieldStatus ( ) const

inline

Get member dataFieldStatus.

Definition at line 145 of file TMHeaderSerializableAc.hpp.

◆ get_globalVcId()

U16 Svc::Ccsds::TMHeader::get_globalVcId ( ) const

inline

Get member globalVcId.

Definition at line 127 of file TMHeaderSerializableAc.hpp.

◆ get_masterFrameCount()

U8 Svc::Ccsds::TMHeader::get_masterFrameCount ( ) const

inline

Get member masterFrameCount.

Definition at line 133 of file TMHeaderSerializableAc.hpp.

◆ get_virtualFrameCount()

U8 Svc::Ccsds::TMHeader::get_virtualFrameCount ( ) const

inline

Get member virtualFrameCount.

Definition at line 139 of file TMHeaderSerializableAc.hpp.

◆ operator!=()

bool Svc::Ccsds::TMHeader::operator!= ( const TMHeader & obj ) const

Inequality operator.

Parameters

obj	The other object

Definition at line 84 of file TMHeaderSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters

obj	The source object

Definition at line 61 of file TMHeaderSerializableAc.cpp.

◆ operator==()

bool Svc::Ccsds::TMHeader::operator== ( const TMHeader & obj ) const

Equality operator.

Parameters

obj	The other object

Definition at line 72 of file TMHeaderSerializableAc.cpp.

◆ serializedSize()

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

Get the dynamic serialized size of the struct.

Definition at line 161 of file TMHeaderSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus Svc::Ccsds::TMHeader::serializeTo	(	Fw::SerialBufferBase &	buffer,
		Fw::Endianness	mode = `Fw::Endianness::BIG`
	)		const

virtual

Serialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 105 of file TMHeaderSerializableAc.cpp.

◆ set()

void Svc::Ccsds::TMHeader::set	(	U16	globalVcId,
		U8	masterFrameCount,
		U8	virtualFrameCount,
		U16	dataFieldStatus
	)

Set all members.

Definition at line 211 of file TMHeaderSerializableAc.cpp.

◆ set_dataFieldStatus()

void Svc::Ccsds::TMHeader::set_dataFieldStatus ( U16 dataFieldStatus )

Set member dataFieldStatus.

Definition at line 243 of file TMHeaderSerializableAc.cpp.

◆ set_globalVcId()

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

Set member globalVcId.

Definition at line 225 of file TMHeaderSerializableAc.cpp.

◆ set_masterFrameCount()

void Svc::Ccsds::TMHeader::set_masterFrameCount ( U8 masterFrameCount )

Set member masterFrameCount.

Definition at line 231 of file TMHeaderSerializableAc.cpp.

◆ set_virtualFrameCount()

void Svc::Ccsds::TMHeader::set_virtualFrameCount ( U8 virtualFrameCount )

Set member virtualFrameCount.

Definition at line 237 of file TMHeaderSerializableAc.cpp.

Member Data Documentation

◆ m_dataFieldStatus

U16 Svc::Ccsds::TMHeader::m_dataFieldStatus

protected

Definition at line 183 of file TMHeaderSerializableAc.hpp.

◆ m_globalVcId

U16 Svc::Ccsds::TMHeader::m_globalVcId

protected

Definition at line 180 of file TMHeaderSerializableAc.hpp.

◆ m_masterFrameCount

U8 Svc::Ccsds::TMHeader::m_masterFrameCount

protected

Definition at line 181 of file TMHeaderSerializableAc.hpp.

◆ m_virtualFrameCount

U8 Svc::Ccsds::TMHeader::m_virtualFrameCount

protected

Definition at line 182 of file TMHeaderSerializableAc.hpp.

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

Svc/Ccsds/Types/TMHeaderSerializableAc.hpp
Svc/Ccsds/Types/TMHeaderSerializableAc.cpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TMHeader() [1/3]

◆ TMHeader() [2/3]

◆ TMHeader() [3/3]

Member Function Documentation

◆ deserializeFrom()

◆ get_dataFieldStatus()

◆ get_globalVcId()

◆ get_masterFrameCount()

◆ get_virtualFrameCount()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ serializedSize()

◆ serializeTo()

◆ set()

◆ set_dataFieldStatus()

◆ set_globalVcId()

◆ set_masterFrameCount()

◆ set_virtualFrameCount()

Member Data Documentation

◆ m_dataFieldStatus

◆ m_globalVcId

◆ m_masterFrameCount

◆ m_virtualFrameCount