#include <Svc/ComAggregator/ComAggregator.hpp>

Inheritance diagram for Svc::ComAggregator:

Public Member Functions
	ComAggregator (const char *const compName)
	Construct ComAggregator object. More...

	~ComAggregator ()
	Destroy ComAggregator object. More...

void	preamble () override
	A function that will be called before the event loop is entered. More...

Public Member Functions inherited from Svc::ComAggregatorComponentBase
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize ComAggregatorComponentBase object. More...

Fw::InputSuccessConditionPort *	get_comStatusIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataReturnIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_timeout_InputPort (FwIndexType portNum)

void	set_comStatusOut_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
	Connect port to comStatusOut[portNum]. More...

void	set_dataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataOut[portNum]. More...

void	set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataReturnOut[portNum]. More...

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(Os::Task::TASK_DEFAULT))
	called by instantiator when task is to be started More...

void	exit ()
	exit task in active component More...

Os::Task::Status	join ()
	Join the thread. More...

	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. More...

Public Member Functions inherited from Fw::QueuedComponentBase
void	deinit () override
	Allows de-initialization on teardown. More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...

FwIdType	getIdBase () const

Friends
class	ComAggregatorTester

Additional Inherited Members
Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }

Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT }

Protected Types inherited from Svc::ComAggregatorComponentBase
enum	{ NUM_COMSTATUSIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1, NUM_TIMEOUT_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_COMSTATUSOUT_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	SmId : FwEnumStoreType { SmId::aggregationMachine }
	State machine identifiers. More...

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

Protected Member Functions inherited from Svc::ComAggregatorComponentBase
	ComAggregatorComponentBase (const char *compName="")
	Construct ComAggregatorComponentBase object. More...

virtual	~ComAggregatorComponentBase ()
	Destroy ComAggregatorComponentBase object. More...

bool	isConnected_comStatusOut_OutputPort (FwIndexType portNum)

bool	isConnected_dataOut_OutputPort (FwIndexType portNum)

bool	isConnected_dataReturnOut_OutputPort (FwIndexType portNum)

void	comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition)
	Handler base-class function for input port comStatusIn. More...

void	dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Handler base-class function for input port dataIn. More...

void	dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Handler base-class function for input port dataReturnIn. More...

void	timeout_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port timeout. More...

void	comStatusOut_out (FwIndexType portNum, Fw::Success &condition)
	Invoke output port comStatusOut. More...

void	dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Invoke output port dataOut. More...

void	dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Invoke output port dataReturnOut. More...

Svc_AggregationMachine::State	aggregationMachine_getState () const
	Get the state of state machine instance aggregationMachine. More...

void	aggregationMachine_sendSignal_timeout ()
	Send signal timeout to state machine aggregationMachine. More...

void	aggregationMachine_sendSignal_fill (const Svc::ComDataContextPair &value)
	Send signal fill to state machine aggregationMachine. More...

void	aggregationMachine_sendSignal_status (const Fw::Success &value)
	Send signal status to state machine aggregationMachine. More...

virtual void	Svc_AggregationMachine_action_doClear (SmId smId, Svc_AggregationMachine::Signal signal)=0

virtual void	Svc_AggregationMachine_action_doFill (SmId smId, Svc_AggregationMachine::Signal signal, const Svc::ComDataContextPair &value)=0

virtual void	Svc_AggregationMachine_action_doSend (SmId smId, Svc_AggregationMachine::Signal signal)=0

virtual void	Svc_AggregationMachine_action_doHold (SmId smId, Svc_AggregationMachine::Signal signal, const Svc::ComDataContextPair &value)=0

virtual void	Svc_AggregationMachine_action_assertNoStatus (SmId smId, Svc_AggregationMachine::Signal signal)=0

virtual bool	Svc_AggregationMachine_guard_isFull (SmId smId, Svc_AggregationMachine::Signal signal, const Svc::ComDataContextPair &value) const =0

virtual bool	Svc_AggregationMachine_guard_willFill (SmId smId, Svc_AggregationMachine::Signal signal, const Svc::ComDataContextPair &value) const =0

virtual bool	Svc_AggregationMachine_guard_isNotEmpty (SmId smId, Svc_AggregationMachine::Signal signal) const =0

virtual bool	Svc_AggregationMachine_guard_isGood (SmId smId, Svc_AggregationMachine::Signal signal, const Fw::Success &value) const =0

Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	initialization code More...

MsgDispatchStatus	dispatch ()
	The function that will dispatching messages. More...

virtual void	finalizer ()
	A function that will be called after exiting the loop. More...

Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...

virtual	~QueuedComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	initialization function More...

Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)

MsgDispatchStatus	dispatchAvailableMessages ()
	dispatches all messages currently in the queue, returning status of the dispatch More...

FwSizeType	getNumMsgsDropped ()
	return number of messages dropped More...

void	incNumMsgDropped ()
	increment the number of messages dropped More...

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	Initialization function. More...

FwEnumStoreType	getInstance () const

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Static Protected Member Functions inherited from Svc::ComAggregatorComponentBase
static constexpr FwIndexType	getNum_comStatusIn_InputPorts ()

static constexpr FwIndexType	getNum_dataIn_InputPorts ()

static constexpr FwIndexType	getNum_dataReturnIn_InputPorts ()

static constexpr FwIndexType	getNum_timeout_InputPorts ()

static constexpr FwIndexType	getNum_comStatusOut_OutputPorts ()

static constexpr FwIndexType	getNum_dataOut_OutputPorts ()

static constexpr FwIndexType	getNum_dataReturnOut_OutputPorts ()

Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component More...

Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component More...

Detailed Description

Definition at line 16 of file ComAggregator.hpp.

Constructor & Destructor Documentation

◆ ComAggregator()

Svc::ComAggregator::ComAggregator ( const char *const compName )

Construct ComAggregator object.

Parameters

compName The component name

Definition at line 15 of file ComAggregator.cpp.

◆ ~ComAggregator()

Svc::ComAggregator::~ComAggregator ( )

Destroy ComAggregator object.

Definition at line 22 of file ComAggregator.cpp.

Member Function Documentation

◆ preamble()

void Svc::ComAggregator::preamble ( )

overridevirtual

A function that will be called before the event loop is entered.

Reimplemented from Fw::ActiveComponentBase.

Definition at line 24 of file ComAggregator.cpp.

Friends And Related Function Documentation

◆ ComAggregatorTester

friend class ComAggregatorTester

friend

Definition at line 17 of file ComAggregator.hpp.

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

Svc/ComAggregator/ComAggregator.hpp
Svc/ComAggregator/ComAggregator.cpp

Public Member Functions

Friends

Additional Inherited Members