#include <Svc/SeqDispatcher/SeqDispatcher.hpp>

Inheritance diagram for Svc::SeqDispatcher:

Public Member Functions
	SeqDispatcher (const char *const compName)

	~SeqDispatcher ()

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

Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)

Fw::InputCmdResponsePort *	get_seqDoneIn_InputPort (FwIndexType portNum)

Svc::InputCmdSeqInPort *	get_seqRunIn_InputPort (FwIndexType portNum)

Svc::InputCmdSeqInPort *	get_seqStartIn_InputPort (FwIndexType portNum)

void	set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum].

void	set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum].

void	set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to logOut[portNum].

void	set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum].

void	set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum].

void	set_seqRunOut_OutputPort (FwIndexType portNum, Svc::InputCmdSeqInPort *port)
	Connect port to seqRunOut[portNum].

void	regCommands ()
	Register commands with the Command Dispatcher.

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started

void	exit ()
	exit task in active component

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

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

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

U32	getIdBase () const

Protected Member Functions
void	seqDoneIn_handler (NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Handler for input port seqDoneIn.

void	seqStartIn_handler (NATIVE_INT_TYPE portNum, const Fw::StringBase &fileName)
	Handler for input port seqStartIn.

void	seqRunIn_handler (NATIVE_INT_TYPE portNum, const Fw::StringBase &fileName)
	Handler for input port seqRunIn.

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

virtual	~SeqDispatcherComponentBase ()
	Destroy SeqDispatcherComponentBase object.

FwIndexType	getNum_cmdIn_InputPorts () const

FwIndexType	getNum_seqDoneIn_InputPorts () const

FwIndexType	getNum_seqRunIn_InputPorts () const

FwIndexType	getNum_seqStartIn_InputPorts () const

FwIndexType	getNum_cmdRegOut_OutputPorts () const

FwIndexType	getNum_cmdResponseOut_OutputPorts () const

FwIndexType	getNum_logOut_OutputPorts () const

FwIndexType	getNum_timeCaller_OutputPorts () const

FwIndexType	getNum_tlmOut_OutputPorts () const

FwIndexType	getNum_seqRunOut_OutputPorts () const

bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum)

bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)

bool	isConnected_logOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)

bool	isConnected_seqRunOut_OutputPort (FwIndexType portNum)

void	seqDoneIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Handler base-class function for input port seqDoneIn.

void	seqRunIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename)
	Handler base-class function for input port seqRunIn.

void	seqStartIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename)
	Handler base-class function for input port seqStartIn.

virtual void	seqDoneIn_preMsgHook (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Pre-message hook for async input port seqDoneIn.

virtual void	seqRunIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename)
	Pre-message hook for async input port seqRunIn.

virtual void	seqStartIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename)
	Pre-message hook for async input port seqStartIn.

void	seqRunOut_out (FwIndexType portNum, const Fw::StringBase &filename)
	Invoke output port seqRunOut.

void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response.

void	RUN_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	LOG_STATUS_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

virtual void	RUN_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command RUN.

virtual void	LOG_STATUS_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command LOG_STATUS.

void	log_WARNING_HI_InvalidSequencer (U16 idx) const
	Log event InvalidSequencer.

void	log_WARNING_HI_NoAvailableSequencers () const
	Log event NoAvailableSequencers.

void	log_WARNING_LO_UnknownSequenceFinished (U16 idx) const
	Log event UnknownSequenceFinished.

void	log_WARNING_HI_ConflictingSequenceStarted (U16 idx, const Fw::StringBase &newSequence, const Fw::StringBase &sequenceInInternalState) const
	Log event ConflictingSequenceStarted.

void	log_WARNING_LO_UnexpectedSequenceStarted (U16 idx, const Fw::StringBase &newSequence) const
	Log event UnexpectedSequenceStarted.

void	log_ACTIVITY_LO_LogSequencerStatus (U16 idx, Svc::SeqDispatcher_CmdSequencerState state, const Fw::StringBase &filename) const
	Log event LogSequencerStatus.

void	tlmWrite_dispatchedCount (U32 arg, Fw::Time _tlmTime=Fw::Time()) const

void	tlmWrite_errorCount (U32 arg, Fw::Time _tlmTime=Fw::Time()) const

void	tlmWrite_sequencersAvailable (U32 arg, Fw::Time _tlmTime=Fw::Time()) const

Fw::Time	getTime ()

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

virtual	~ActiveComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	initialization code

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

MsgDispatchStatus	dispatch ()
	The function that will dispatching messages.

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

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

virtual	~QueuedComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	initialization function

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

NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped

void	incNumMsgDropped ()
	increment the number of messages dropped

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

virtual	~PassiveComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	Initialization function.

NATIVE_INT_TYPE	getInstance () const

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

virtual	~ObjBase ()
	Destructor.

void	init ()
	Object initializer.

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::SeqDispatcherComponentBase
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

enum	{ NUM_SEQDONEIN_INPUT_PORTS = 2 , NUM_SEQRUNIN_INPUT_PORTS = 1 , NUM_SEQSTARTIN_INPUT_PORTS = 2 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_LOGOUT_OUTPUT_PORTS = 1 , NUM_LOGTEXTOUT_OUTPUT_PORTS = 1 , NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_SEQRUNOUT_OUTPUT_PORTS = 2 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_RUN = 0x0 , OPCODE_LOG_STATUS = 0x1 }
	Command opcodes. More...

enum	{ EVENTID_INVALIDSEQUENCER = 0x0 , EVENTID_NOAVAILABLESEQUENCERS = 0x1 , EVENTID_UNKNOWNSEQUENCEFINISHED = 0x2 , EVENTID_CONFLICTINGSEQUENCESTARTED = 0x3 , EVENTID_UNEXPECTEDSEQUENCESTARTED = 0x4 , EVENTID_LOGSEQUENCERSTATUS = 0x5 }
	Event IDs. More...

enum	{ CHANNELID_DISPATCHEDCOUNT = 0x0 , CHANNELID_ERRORCOUNT = 0x1 , CHANNELID_SEQUENCERSAVAILABLE = 0x2 }
	Channel IDs. More...

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

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

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

Detailed Description

Definition at line 18 of file SeqDispatcher.hpp.

Constructor & Destructor Documentation

◆ SeqDispatcher()

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

Construct object SeqDispatcher

Parameters

compName The component name

Definition at line 15 of file SeqDispatcher.cpp.

◆ ~SeqDispatcher()

Svc::SeqDispatcher::~SeqDispatcher ( )

Destroy object SeqDispatcher

Definition at line 18 of file SeqDispatcher.cpp.

Member Function Documentation

◆ seqDoneIn_handler()

void Svc::SeqDispatcher::seqDoneIn_handler	(	NATIVE_INT_TYPE	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)

protectedvirtual

Handler for input port seqDoneIn.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Implements Svc::SeqDispatcherComponentBase.

Definition at line 93 of file SeqDispatcher.cpp.

◆ seqRunIn_handler()

void Svc::SeqDispatcher::seqRunIn_handler	(	NATIVE_INT_TYPE	portNum,
		const Fw::StringBase &	fileName
	)

protectedvirtual

Handler for input port seqRunIn.

Parameters

portNum	The port number
fileName	The sequence file

Implements Svc::SeqDispatcherComponentBase.

Definition at line 139 of file SeqDispatcher.cpp.

◆ seqStartIn_handler()

void Svc::SeqDispatcher::seqStartIn_handler	(	NATIVE_INT_TYPE	portNum,
		const Fw::StringBase &	fileName
	)

protectedvirtual

Handler for input port seqStartIn.

Parameters

portNum	The port number
fileName	The sequence file

Implements Svc::SeqDispatcherComponentBase.

Definition at line 60 of file SeqDispatcher.cpp.

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

Svc/SeqDispatcher/SeqDispatcher.hpp
Svc/SeqDispatcher/SeqDispatcher.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SeqDispatcher()

◆ ~SeqDispatcher()

Member Function Documentation

◆ seqDoneIn_handler()

◆ seqRunIn_handler()

◆ seqStartIn_handler()