Svc::Ccsds::TCHeader Class Reference

Describes the frame header format for a Telecommand (TC) Transfer Frame. More...

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

Inheritance diagram for Svc::Ccsds::TCHeader:

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

Public Member Functions
	TCHeader ()
	Constructor (default value) More...
	TCHeader (U16 flagsAndScId, U16 vcIdAndLength, U8 frameSequenceNum)
	Member constructor. More...
	TCHeader (const TCHeader &obj)
	Copy constructor. More...
TCHeader &	operator= (const TCHeader &obj)
	Copy assignment operator. More...
bool	operator== (const TCHeader &obj) const
	Equality operator. More...
bool	operator!= (const TCHeader &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_flagsAndScId () const
	Get member flagsAndScId. More...
U16	get_vcIdAndLength () const
	Get member vcIdAndLength. More...
U8	get_frameSequenceNum () const
	Get member frameSequenceNum. More...
void	set (U16 flagsAndScId, U16 vcIdAndLength, U8 frameSequenceNum)
	Set all members. More...
void	set_flagsAndScId (U16 flagsAndScId)
	Set member flagsAndScId. More...
void	set_vcIdAndLength (U16 vcIdAndLength)
	Set member vcIdAndLength. More...
void	set_frameSequenceNum (U8 frameSequenceNum)
	Set member frameSequenceNum. 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_flagsAndScId
U16	m_vcIdAndLength
U8	m_frameSequenceNum

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 Telecommand (TC) Transfer Frame.

Definition at line 20 of file TCHeaderSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 30 of file TCHeaderSerializableAc.hpp.

Constructor & Destructor Documentation

TCHeader() [1/3]

Svc::Ccsds::TCHeader::TCHeader

(

)

Constructor (default value)

Definition at line 19 of file TCHeaderSerializableAc.cpp.

TCHeader() [2/3]

Svc::Ccsds::TCHeader::TCHeader	(	U16	flagsAndScId,
		U16	vcIdAndLength,
		U8	frameSequenceNum
	)

Member constructor.

Definition at line 29 of file TCHeaderSerializableAc.cpp.

TCHeader() [3/3]

Svc::Ccsds::TCHeader::TCHeader

(

const TCHeader &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 43 of file TCHeaderSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::Ccsds::TCHeader::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 124 of file TCHeaderSerializableAc.cpp.

get_flagsAndScId()

U16 Svc::Ccsds::TCHeader::get_flagsAndScId ( ) const

inline

Get member flagsAndScId.

Definition at line 125 of file TCHeaderSerializableAc.hpp.

get_frameSequenceNum()

U8 Svc::Ccsds::TCHeader::get_frameSequenceNum ( ) const

inline

Get member frameSequenceNum.

Definition at line 137 of file TCHeaderSerializableAc.hpp.

get_vcIdAndLength()

U16 Svc::Ccsds::TCHeader::get_vcIdAndLength ( ) const

inline

Get member vcIdAndLength.

Definition at line 131 of file TCHeaderSerializableAc.hpp.

operator!=()

bool Svc::Ccsds::TCHeader::operator!=

(

const TCHeader &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 79 of file TCHeaderSerializableAc.cpp.

operator=()

TCHeader & Svc::Ccsds::TCHeader::operator=

(

const TCHeader &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 57 of file TCHeaderSerializableAc.cpp.

operator==()

bool Svc::Ccsds::TCHeader::operator==

(

const TCHeader &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 68 of file TCHeaderSerializableAc.cpp.

serializedSize()

FwSizeType Svc::Ccsds::TCHeader::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 148 of file TCHeaderSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::Ccsds::TCHeader::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 100 of file TCHeaderSerializableAc.cpp.

set()

void Svc::Ccsds::TCHeader::set	(	U16	flagsAndScId,
		U16	vcIdAndLength,
		U8	frameSequenceNum
	)

Set all members.

Definition at line 191 of file TCHeaderSerializableAc.cpp.

set_flagsAndScId()

void Svc::Ccsds::TCHeader::set_flagsAndScId

(

U16

flagsAndScId

)

Set member flagsAndScId.

Definition at line 203 of file TCHeaderSerializableAc.cpp.

set_frameSequenceNum()

void Svc::Ccsds::TCHeader::set_frameSequenceNum

(

U8

frameSequenceNum

)

Set member frameSequenceNum.

Definition at line 215 of file TCHeaderSerializableAc.cpp.

set_vcIdAndLength()

void Svc::Ccsds::TCHeader::set_vcIdAndLength

(

U16

vcIdAndLength

)

Set member vcIdAndLength.

Definition at line 209 of file TCHeaderSerializableAc.cpp.

Member Data Documentation

m_flagsAndScId

U16 Svc::Ccsds::TCHeader::m_flagsAndScId

protected

Definition at line 168 of file TCHeaderSerializableAc.hpp.

m_frameSequenceNum

U8 Svc::Ccsds::TCHeader::m_frameSequenceNum

protected

Definition at line 170 of file TCHeaderSerializableAc.hpp.

m_vcIdAndLength

U16 Svc::Ccsds::TCHeader::m_vcIdAndLength

protected

Definition at line 169 of file TCHeaderSerializableAc.hpp.

---

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

• Svc/Ccsds/Types/TCHeaderSerializableAc.hpp
• Svc/Ccsds/Types/TCHeaderSerializableAc.cpp