ComCfg::FrameContext Class Reference

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

#include <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)
	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	serialize (Fw::SerializeBufferBase &buffer) const
	Serialization. More...
Fw::SerializeStatus	deserialize (Fw::SerializeBufferBase &buffer)
	Deserialization. More...
FwIndexType	getcomQueueIndex () const
	Get member comQueueIndex. More...
void	set (FwIndexType comQueueIndex)
	Set all members. More...
void	setcomQueueIndex (FwIndexType comQueueIndex)
	Set member comQueueIndex. More...

Protected Attributes
FwIndexType	m_comQueueIndex

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

Detailed Description

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

Definition at line 19 of file FrameContextSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 29 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

)

Member constructor.

Definition at line 25 of file FrameContextSerializableAc.cpp.

FrameContext() [3/3]

ComCfg::FrameContext::FrameContext

(

const FrameContext &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 33 of file FrameContextSerializableAc.cpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus ComCfg::FrameContext::deserialize ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 96 of file FrameContextSerializableAc.cpp.

getcomQueueIndex()

FwIndexType ComCfg::FrameContext::getcomQueueIndex ( ) const

inline

Get member comQueueIndex.

Definition at line 113 of file FrameContextSerializableAc.hpp.

operator!=()

bool ComCfg::FrameContext::operator!=

(

const FrameContext &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 62 of file FrameContextSerializableAc.cpp.

operator=()

FrameContext & ComCfg::FrameContext::operator=

(

const FrameContext &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 45 of file FrameContextSerializableAc.cpp.

operator==()

bool ComCfg::FrameContext::operator==

(

const FrameContext &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 56 of file FrameContextSerializableAc.cpp.

serialize()

Fw::SerializeStatus ComCfg::FrameContext::serialize ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 83 of file FrameContextSerializableAc.cpp.

set()

void ComCfg::FrameContext::set

(

FwIndexType

comQueueIndex

)

Set all members.

Definition at line 131 of file FrameContextSerializableAc.cpp.

setcomQueueIndex()

void ComCfg::FrameContext::setcomQueueIndex

(

FwIndexType

comQueueIndex

)

Set member comQueueIndex.

Definition at line 137 of file FrameContextSerializableAc.cpp.

Member Data Documentation

m_comQueueIndex

FwIndexType ComCfg::FrameContext::m_comQueueIndex

protected

Definition at line 134 of file FrameContextSerializableAc.hpp.

---

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

• config/FrameContextSerializableAc.hpp
• config/FrameContextSerializableAc.cpp