F´ Flight Software - C/C++ Documentation: ComCfg::FrameContext Class Reference

F´ Flight Software - C/C++ Documentation

A framework for building embedded system applications to NASA flight quality standards.

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, U16 sequenceCount, U8 vcId, ComCfg::Pvn::T pvn, bool sendNow)
	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...

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...

void	set (FwIndexType comQueueIndex, ComCfg::Apid::T apid, U16 sequenceCount, U8 vcId, ComCfg::Pvn::T pvn, bool sendNow)
	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_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...

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

U16	m_sequenceCount

U8	m_vcId

ComCfg::Pvn	m_pvn

bool	m_sendNow

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 21 of file FrameContextSerializableAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 31 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,
		U16	sequenceCount,
		U8	vcId,
		ComCfg::Pvn::T	pvn,
		bool	sendNow
	)

Member constructor.

Definition at line 30 of file FrameContextSerializableAc.cpp.

◆ FrameContext() [3/3]

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

Copy constructor.

Parameters

obj	The source object

Definition at line 50 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 149 of file FrameContextSerializableAc.cpp.

◆ get_apid()

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

inline

Get member apid.

Definition at line 138 of file FrameContextSerializableAc.hpp.

◆ get_comQueueIndex()

FwIndexType ComCfg::FrameContext::get_comQueueIndex ( ) const

inline

Get member comQueueIndex.

Definition at line 132 of file FrameContextSerializableAc.hpp.

◆ get_pvn()

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

inline

Get member pvn.

Definition at line 156 of file FrameContextSerializableAc.hpp.

◆ get_sendNow()

bool ComCfg::FrameContext::get_sendNow ( ) const

inline

Get member sendNow.

Definition at line 162 of file FrameContextSerializableAc.hpp.

◆ get_sequenceCount()

U16 ComCfg::FrameContext::get_sequenceCount ( ) const

inline

Get member sequenceCount.

Definition at line 144 of file FrameContextSerializableAc.hpp.

◆ get_vcId()

U8 ComCfg::FrameContext::get_vcId ( ) const

inline

Get member vcId.

Definition at line 150 of file FrameContextSerializableAc.hpp.

◆ operator!=()

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

Inequality operator.

Parameters

obj	The other object

Definition at line 92 of file FrameContextSerializableAc.cpp.

◆ operator=()

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

Copy assignment operator.

Parameters

obj	The source object

Definition at line 67 of file FrameContextSerializableAc.cpp.

◆ operator==()

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

Equality operator.

Parameters

obj	The other object

Definition at line 78 of file FrameContextSerializableAc.cpp.

◆ serializedSize()

FwSizeType ComCfg::FrameContext::serializedSize ( ) const

Get the dynamic serialized size of the struct.

Definition at line 185 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 113 of file FrameContextSerializableAc.cpp.

◆ set()

void ComCfg::FrameContext::set	(	FwIndexType	comQueueIndex,
		ComCfg::Apid::T	apid,
		U16	sequenceCount,
		U8	vcId,
		ComCfg::Pvn::T	pvn,
		bool	sendNow
	)

Set all members.

Definition at line 249 of file FrameContextSerializableAc.cpp.

◆ set_apid()

void ComCfg::FrameContext::set_apid ( ComCfg::Apid::T apid )

Set member apid.

Definition at line 273 of file FrameContextSerializableAc.cpp.

◆ set_comQueueIndex()

void ComCfg::FrameContext::set_comQueueIndex ( FwIndexType comQueueIndex )

Set member comQueueIndex.

Definition at line 267 of file FrameContextSerializableAc.cpp.

◆ set_pvn()

void ComCfg::FrameContext::set_pvn ( ComCfg::Pvn::T pvn )

Set member pvn.

Definition at line 291 of file FrameContextSerializableAc.cpp.

◆ set_sendNow()

void ComCfg::FrameContext::set_sendNow ( bool sendNow )

Set member sendNow.

Definition at line 297 of file FrameContextSerializableAc.cpp.

◆ set_sequenceCount()

void ComCfg::FrameContext::set_sequenceCount ( U16 sequenceCount )

Set member sequenceCount.

Definition at line 279 of file FrameContextSerializableAc.cpp.

◆ set_vcId()

void ComCfg::FrameContext::set_vcId ( U8 vcId )

Set member vcId.

Definition at line 285 of file FrameContextSerializableAc.cpp.

Member Data Documentation

◆ m_apid

ComCfg::Apid ComCfg::FrameContext::m_apid

protected

Definition at line 206 of file FrameContextSerializableAc.hpp.

◆ m_comQueueIndex

FwIndexType ComCfg::FrameContext::m_comQueueIndex

protected

Definition at line 205 of file FrameContextSerializableAc.hpp.

◆ m_pvn

ComCfg::Pvn ComCfg::FrameContext::m_pvn

protected

Definition at line 209 of file FrameContextSerializableAc.hpp.

◆ m_sendNow

bool ComCfg::FrameContext::m_sendNow

protected

Definition at line 210 of file FrameContextSerializableAc.hpp.

◆ m_sequenceCount

U16 ComCfg::FrameContext::m_sequenceCount

protected

Definition at line 207 of file FrameContextSerializableAc.hpp.

◆ m_vcId

U8 ComCfg::FrameContext::m_vcId

protected

Definition at line 208 of file FrameContextSerializableAc.hpp.

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

default/config/FrameContextSerializableAc.hpp
default/config/FrameContextSerializableAc.cpp

ComCfg
FrameContext
Generated by 1.8.14