Type used to pass context info between components during framing/deframing. More...

#include <default/config/FrameContextSerializableAc.hpp>

Inheritance diagram for ComCfg::FrameContext:

Public Types
enum	{ SERIALIZED_SIZE }

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

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

	FrameContext (FwIndexType comQueueIndex, ComCfg::Apid::T apid, ComCfg::SppPacketType::T pktType, bool hasSecHdr, U8 sequenceFlags, U16 sequenceCount, U8 vcId, ComCfg::Pvn::T pvn, bool sendNow, U16 saIndex, U16 firstHeaderPointer)
	Member constructor. More...

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

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

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

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

FwIndexType	get_comQueueIndex () const
	Get member comQueueIndex. More...

ComCfg::Apid::T	get_apid () const
	Get member apid. More...

ComCfg::SppPacketType::T	get_pktType () const
	Get member pktType. More...

bool	get_hasSecHdr () const
	Get member hasSecHdr. More...

U8	get_sequenceFlags () const
	Get member sequenceFlags. More...

U16	get_sequenceCount () const
	Get member sequenceCount. More...

U8	get_vcId () const
	Get member vcId. More...

ComCfg::Pvn::T	get_pvn () const
	Get member pvn. More...

bool	get_sendNow () const
	Get member sendNow. More...

U16	get_saIndex () const
	Get member saIndex. More...

U16	get_firstHeaderPointer () const
	Get member firstHeaderPointer. More...

void	set (FwIndexType comQueueIndex, ComCfg::Apid::T apid, ComCfg::SppPacketType::T pktType, bool hasSecHdr, U8 sequenceFlags, U16 sequenceCount, U8 vcId, ComCfg::Pvn::T pvn, bool sendNow, U16 saIndex, U16 firstHeaderPointer)
	Set all members. More...

void	set_comQueueIndex (FwIndexType comQueueIndex)
	Set member comQueueIndex. More...

void	set_apid (ComCfg::Apid::T apid)
	Set member apid. More...

void	set_pktType (ComCfg::SppPacketType::T pktType)
	Set member pktType. More...

void	set_hasSecHdr (bool hasSecHdr)
	Set member hasSecHdr. More...

void	set_sequenceFlags (U8 sequenceFlags)
	Set member sequenceFlags. More...

void	set_sequenceCount (U16 sequenceCount)
	Set member sequenceCount. More...

void	set_vcId (U8 vcId)
	Set member vcId. More...

void	set_pvn (ComCfg::Pvn::T pvn)
	Set member pvn. More...

void	set_sendNow (bool sendNow)
	Set member sendNow. More...

void	set_saIndex (U16 saIndex)
	Set member saIndex. 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
FwIndexType	m_comQueueIndex

ComCfg::Apid	m_apid

ComCfg::SppPacketType	m_pktType

bool	m_hasSecHdr

U8	m_sequenceFlags

U16	m_sequenceCount

U8	m_vcId

ComCfg::Pvn	m_pvn

bool	m_sendNow

U16	m_saIndex

U16	m_firstHeaderPointer

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...

virtual	~Serializable ()
	Virtual destructor. More...

Detailed Description

Type used to pass context info between components during framing/deframing.

Definition at line 22 of file FrameContextSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 32 of file FrameContextSerializableAc.hpp.

Constructor & Destructor Documentation

◆ FrameContext() [1/3]

ComCfg::FrameContext::FrameContext ( )

Constructor (default value)

Definition at line 17 of file FrameContextSerializableAc.cpp.

◆ FrameContext() [2/3]

ComCfg::FrameContext::FrameContext	(	FwIndexType	comQueueIndex,
		ComCfg::Apid::T	apid,
		ComCfg::SppPacketType::T	pktType,
		bool	hasSecHdr,
		U8	sequenceFlags,
		U16	sequenceCount,
		U8	vcId,
		ComCfg::Pvn::T	pvn,
		bool	sendNow,
		U16	saIndex,
		U16	firstHeaderPointer
	)

Member constructor.

Definition at line 35 of file FrameContextSerializableAc.cpp.

◆ FrameContext() [3/3]

ComCfg::FrameContext::FrameContext ( const FrameContext & obj )

Copy constructor.

Parameters

obj	The source object

Definition at line 65 of file FrameContextSerializableAc.cpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus ComCfg::FrameContext::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 194 of file FrameContextSerializableAc.cpp.

◆ get_apid()

ComCfg::Apid::T ComCfg::FrameContext::get_apid ( ) const

inline

Get member apid.

Definition at line 149 of file FrameContextSerializableAc.hpp.

◆ get_comQueueIndex()

FwIndexType ComCfg::FrameContext::get_comQueueIndex ( ) const

inline

Get member comQueueIndex.

Definition at line 143 of file FrameContextSerializableAc.hpp.

◆ get_firstHeaderPointer()

U16 ComCfg::FrameContext::get_firstHeaderPointer ( ) const

inline

Get member firstHeaderPointer.

Definition at line 203 of file FrameContextSerializableAc.hpp.

◆ get_hasSecHdr()

bool ComCfg::FrameContext::get_hasSecHdr ( ) const

inline

Get member hasSecHdr.

Definition at line 161 of file FrameContextSerializableAc.hpp.

◆ get_pktType()

ComCfg::SppPacketType::T ComCfg::FrameContext::get_pktType ( ) const

inline

Get member pktType.

Definition at line 155 of file FrameContextSerializableAc.hpp.

◆ get_pvn()

ComCfg::Pvn::T ComCfg::FrameContext::get_pvn ( ) const

inline

Get member pvn.

Definition at line 185 of file FrameContextSerializableAc.hpp.

◆ get_saIndex()

U16 ComCfg::FrameContext::get_saIndex ( ) const

inline

Get member saIndex.

Definition at line 197 of file FrameContextSerializableAc.hpp.

◆ get_sendNow()

bool ComCfg::FrameContext::get_sendNow ( ) const

inline

Get member sendNow.

Definition at line 191 of file FrameContextSerializableAc.hpp.

◆ get_sequenceCount()

U16 ComCfg::FrameContext::get_sequenceCount ( ) const

inline

Get member sequenceCount.

Definition at line 173 of file FrameContextSerializableAc.hpp.

◆ get_sequenceFlags()

U8 ComCfg::FrameContext::get_sequenceFlags ( ) const

inline

Get member sequenceFlags.

Definition at line 167 of file FrameContextSerializableAc.hpp.

◆ get_vcId()

U8 ComCfg::FrameContext::get_vcId ( ) const

inline

Get member vcId.

Definition at line 179 of file FrameContextSerializableAc.hpp.

◆ operator!=()

bool ComCfg::FrameContext::operator!= ( const FrameContext & obj ) const

Inequality operator.

Parameters

obj	The other object

Definition at line 117 of file FrameContextSerializableAc.cpp.

◆ operator=()

FrameContext & ComCfg::FrameContext::operator= ( const FrameContext & obj )

Copy assignment operator.

Parameters

obj	The source object

Definition at line 87 of file FrameContextSerializableAc.cpp.

◆ operator==()

bool ComCfg::FrameContext::operator== ( const FrameContext & obj ) const

Equality operator.

Parameters

obj	The other object

Definition at line 98 of file FrameContextSerializableAc.cpp.

◆ serializedSize()

FwSizeType ComCfg::FrameContext::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 250 of file FrameContextSerializableAc.cpp.

◆ serializeTo()

Fw::SerializeStatus ComCfg::FrameContext::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 138 of file FrameContextSerializableAc.cpp.

◆ set()

void ComCfg::FrameContext::set	(	FwIndexType	comQueueIndex,
		ComCfg::Apid::T	apid,
		ComCfg::SppPacketType::T	pktType,
		bool	hasSecHdr,
		U8	sequenceFlags,
		U16	sequenceCount,
		U8	vcId,
		ComCfg::Pvn::T	pvn,
		bool	sendNow,
		U16	saIndex,
		U16	firstHeaderPointer
	)