Svc::Ccsds::SpacePacketHeader Class Reference

Describes the frame header format for the SpacePacket communications protocol. More...

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

Inheritance diagram for Svc::Ccsds::SpacePacketHeader:

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

Public Member Functions
	SpacePacketHeader ()
	Constructor (default value) More...
	SpacePacketHeader (U16 packetIdentification, U16 packetSequenceControl, U16 packetDataLength)
	Member constructor. More...
	SpacePacketHeader (const SpacePacketHeader &obj)
	Copy constructor. More...
SpacePacketHeader &	operator= (const SpacePacketHeader &obj)
	Copy assignment operator. More...
bool	operator== (const SpacePacketHeader &obj) const
	Equality operator. More...
bool	operator!= (const SpacePacketHeader &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_packetIdentification () const
	Get member packetIdentification. More...
U16	get_packetSequenceControl () const
	Get member packetSequenceControl. More...
U16	get_packetDataLength () const
	Get member packetDataLength. More...
void	set (U16 packetIdentification, U16 packetSequenceControl, U16 packetDataLength)
	Set all members. More...
void	set_packetIdentification (U16 packetIdentification)
	Set member packetIdentification. More...
void	set_packetSequenceControl (U16 packetSequenceControl)
	Set member packetSequenceControl. More...
void	set_packetDataLength (U16 packetDataLength)
	Set member packetDataLength. 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_packetIdentification
U16	m_packetSequenceControl
U16	m_packetDataLength

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 the SpacePacket communications protocol.

Definition at line 20 of file SpacePacketHeaderSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 30 of file SpacePacketHeaderSerializableAc.hpp.

Constructor & Destructor Documentation

SpacePacketHeader() [1/3]

Svc::Ccsds::SpacePacketHeader::SpacePacketHeader

(

)

Constructor (default value)

Definition at line 19 of file SpacePacketHeaderSerializableAc.cpp.

SpacePacketHeader() [2/3]

Svc::Ccsds::SpacePacketHeader::SpacePacketHeader	(	U16	packetIdentification,
		U16	packetSequenceControl,
		U16	packetDataLength
	)

Member constructor.

Definition at line 29 of file SpacePacketHeaderSerializableAc.cpp.

SpacePacketHeader() [3/3]

Svc::Ccsds::SpacePacketHeader::SpacePacketHeader

(

const SpacePacketHeader &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 43 of file SpacePacketHeaderSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::Ccsds::SpacePacketHeader::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 SpacePacketHeaderSerializableAc.cpp.

get_packetDataLength()

U16 Svc::Ccsds::SpacePacketHeader::get_packetDataLength ( ) const

inline

Get member packetDataLength.

Definition at line 137 of file SpacePacketHeaderSerializableAc.hpp.

get_packetIdentification()

U16 Svc::Ccsds::SpacePacketHeader::get_packetIdentification ( ) const

inline

Get member packetIdentification.

Definition at line 125 of file SpacePacketHeaderSerializableAc.hpp.

get_packetSequenceControl()

U16 Svc::Ccsds::SpacePacketHeader::get_packetSequenceControl ( ) const

inline

Get member packetSequenceControl.

Definition at line 131 of file SpacePacketHeaderSerializableAc.hpp.

operator!=()

bool Svc::Ccsds::SpacePacketHeader::operator!=

(

const SpacePacketHeader &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 79 of file SpacePacketHeaderSerializableAc.cpp.

operator=()

SpacePacketHeader & Svc::Ccsds::SpacePacketHeader::operator=

(

const SpacePacketHeader &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 57 of file SpacePacketHeaderSerializableAc.cpp.

operator==()

bool Svc::Ccsds::SpacePacketHeader::operator==

(

const SpacePacketHeader &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 68 of file SpacePacketHeaderSerializableAc.cpp.

serializedSize()

FwSizeType Svc::Ccsds::SpacePacketHeader::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 148 of file SpacePacketHeaderSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::Ccsds::SpacePacketHeader::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 SpacePacketHeaderSerializableAc.cpp.

set()

void Svc::Ccsds::SpacePacketHeader::set	(	U16	packetIdentification,
		U16	packetSequenceControl,
		U16	packetDataLength
	)

Set all members.

Definition at line 191 of file SpacePacketHeaderSerializableAc.cpp.

set_packetDataLength()

void Svc::Ccsds::SpacePacketHeader::set_packetDataLength

(

U16

packetDataLength

)

Set member packetDataLength.

Definition at line 215 of file SpacePacketHeaderSerializableAc.cpp.

set_packetIdentification()

void Svc::Ccsds::SpacePacketHeader::set_packetIdentification

(

U16

packetIdentification

)

Set member packetIdentification.

Definition at line 203 of file SpacePacketHeaderSerializableAc.cpp.

set_packetSequenceControl()

void Svc::Ccsds::SpacePacketHeader::set_packetSequenceControl

(

U16

packetSequenceControl

)

Set member packetSequenceControl.

Definition at line 209 of file SpacePacketHeaderSerializableAc.cpp.

Member Data Documentation

m_packetDataLength

U16 Svc::Ccsds::SpacePacketHeader::m_packetDataLength

protected

Definition at line 170 of file SpacePacketHeaderSerializableAc.hpp.

m_packetIdentification

U16 Svc::Ccsds::SpacePacketHeader::m_packetIdentification

protected

Definition at line 168 of file SpacePacketHeaderSerializableAc.hpp.

m_packetSequenceControl

U16 Svc::Ccsds::SpacePacketHeader::m_packetSequenceControl

protected

Definition at line 169 of file SpacePacketHeaderSerializableAc.hpp.

---

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

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