Auto-generated base for SeqDispatcher component. More...

#include <Svc/SeqDispatcher/SeqDispatcherComponentAc.hpp>

Inheritance diagram for Svc::SeqDispatcherComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize SeqDispatcherComponentBase object. More...

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

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

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

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

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

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

void	regCommands ()
	Register commands with the Command Dispatcher. More...

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_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 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::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...

U32	getIdBase () const

Protected Types
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 Member Functions
	SeqDispatcherComponentBase (const char *compName="")
	Construct SeqDispatcherComponentBase object. More...

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

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)

virtual void	seqDoneIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0
	Handler for input port seqDoneIn. More...

virtual void	seqRunIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=0
	Handler for input port seqRunIn. More...

virtual void	seqStartIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=0
	Handler for input port seqStartIn. More...

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

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

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

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

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

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

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

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

virtual void	RUN_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName, Fw::Wait block)=0

virtual void	LOG_STATUS_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0

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

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

void	log_WARNING_HI_InvalidSequencer (U16 idx) const
	Log event InvalidSequencer. More...

void	log_WARNING_HI_NoAvailableSequencers () const
	Log event NoAvailableSequencers. More...

void	log_WARNING_LO_UnknownSequenceFinished (U16 idx) const
	Log event UnknownSequenceFinished. More...

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

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

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

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 () const

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

virtual	~ActiveComponentBase ()
	Destructor. More...

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

virtual void	preamble ()
	A function that will be called before the event loop is entered. 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)

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

Friends
class	SeqDispatcherTesterBase
	Friend class tester to support autocoded test harness. More...

class	SeqDispatcherTester
	Friend class tester implementation to support white-box testing. More...

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

Auto-generated base for SeqDispatcher component.

Dispatches command sequences to available command sequencers

Definition at line 38 of file SeqDispatcherComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 58 of file SeqDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_SEQDONEIN_INPUT_PORTS
NUM_SEQRUNIN_INPUT_PORTS
NUM_SEQSTARTIN_INPUT_PORTS

Definition at line 63 of file SeqDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_LOGOUT_OUTPUT_PORTS
NUM_LOGTEXTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 70 of file SeqDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_SEQRUNOUT_OUTPUT_PORTS

Definition at line 80 of file SeqDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_RUN	Dispatches a sequence to the first available sequencer.
OPCODE_LOG_STATUS	Logs via Events the state of each connected command sequencer.

Definition at line 85 of file SeqDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_INVALIDSEQUENCER
EVENTID_NOAVAILABLESEQUENCERS
EVENTID_UNKNOWNSEQUENCEFINISHED
EVENTID_CONFLICTINGSEQUENCESTARTED
EVENTID_UNEXPECTEDSEQUENCESTARTED
EVENTID_LOGSEQUENCERSTATUS

Definition at line 91 of file SeqDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_DISPATCHEDCOUNT	Channel ID for dispatchedCount.
CHANNELID_ERRORCOUNT	Channel ID for errorCount.
CHANNELID_SEQUENCERSAVAILABLE	Channel ID for sequencersAvailable.

Definition at line 101 of file SeqDispatcherComponentAc.hpp.

Constructor & Destructor Documentation

◆ SeqDispatcherComponentBase()

Svc::SeqDispatcherComponentBase::SeqDispatcherComponentBase ( const char * compName = "" )

protected

Construct SeqDispatcherComponentBase object.

Parameters

compName The component name

Definition at line 629 of file SeqDispatcherComponentAc.cpp.

◆ ~SeqDispatcherComponentBase()

Svc::SeqDispatcherComponentBase::~SeqDispatcherComponentBase ( )

protectedvirtual

Destroy SeqDispatcherComponentBase object.

Definition at line 636 of file SeqDispatcherComponentAc.cpp.

Member Function Documentation

◆ cmdResponse_out()

void Svc::SeqDispatcherComponentBase::cmdResponse_out	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdResponse	response
	)

protected

Emit command response.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 1065 of file SeqDispatcherComponentAc.cpp.

◆ get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::SeqDispatcherComponentBase::get_cmdIn_InputPort ( FwIndexType portNum )

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 331 of file SeqDispatcherComponentAc.cpp.

◆ get_seqDoneIn_InputPort()

Fw::InputCmdResponsePort * Svc::SeqDispatcherComponentBase::get_seqDoneIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: seqDoneIn[portNum]

Parameters

portNum The port number

Definition at line 346 of file SeqDispatcherComponentAc.cpp.

◆ get_seqRunIn_InputPort()

Svc::InputCmdSeqInPort * Svc::SeqDispatcherComponentBase::get_seqRunIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: seqRunIn[portNum]

Parameters

portNum The port number

Definition at line 357 of file SeqDispatcherComponentAc.cpp.

◆ get_seqStartIn_InputPort()

Svc::InputCmdSeqInPort * Svc::SeqDispatcherComponentBase::get_seqStartIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: seqStartIn[portNum]

Parameters

portNum The port number

Definition at line 368 of file SeqDispatcherComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 646 of file SeqDispatcherComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 678 of file SeqDispatcherComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 684 of file SeqDispatcherComponentAc.cpp.

◆ getNum_logOut_OutputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_logOut_OutputPorts ( ) const

protected

Get the number of logOut output ports

Returns: The number of logOut output ports

Definition at line 690 of file SeqDispatcherComponentAc.cpp.

◆ getNum_seqDoneIn_InputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_seqDoneIn_InputPorts ( ) const

protected

Get the number of seqDoneIn input ports

Returns: The number of seqDoneIn input ports

Definition at line 656 of file SeqDispatcherComponentAc.cpp.

◆ getNum_seqRunIn_InputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_seqRunIn_InputPorts ( ) const

protected

Get the number of seqRunIn input ports

Returns: The number of seqRunIn input ports

Definition at line 662 of file SeqDispatcherComponentAc.cpp.

◆ getNum_seqRunOut_OutputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_seqRunOut_OutputPorts ( ) const

protected

Get the number of seqRunOut output ports

Returns: The number of seqRunOut output ports

Definition at line 722 of file SeqDispatcherComponentAc.cpp.

◆ getNum_seqStartIn_InputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_seqStartIn_InputPorts ( ) const

protected

Get the number of seqStartIn input ports

Returns: The number of seqStartIn input ports

Definition at line 668 of file SeqDispatcherComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 706 of file SeqDispatcherComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

FwIndexType Svc::SeqDispatcherComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 712 of file SeqDispatcherComponentAc.cpp.

◆ getTime()

Fw::Time Svc::SeqDispatcherComponentBase::getTime ( ) const

protected

Get the time

\return The current time

Definition at line 1875 of file SeqDispatcherComponentAc.cpp.

◆ init()

void Svc::SeqDispatcherComponentBase::init	(	FwSizeType	queueDepth,
		FwEnumStoreType	instance = `0`
	)

Initialize SeqDispatcherComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 76 of file SeqDispatcherComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::SeqDispatcherComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType portNum )

protected

Check whether port cmdRegOut is connected

Returns: Whether port cmdRegOut is connected

Parameters

portNum The port number

Definition at line 732 of file SeqDispatcherComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::SeqDispatcherComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType portNum )

protected

Check whether port cmdResponseOut is connected

Returns: Whether port cmdResponseOut is connected

Parameters

portNum The port number

Definition at line 743 of file SeqDispatcherComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::SeqDispatcherComponentBase::isConnected_logOut_OutputPort ( FwIndexType portNum )

protected

Check whether port logOut is connected

Returns: Whether port logOut is connected

Parameters

portNum The port number

Definition at line 754 of file SeqDispatcherComponentAc.cpp.

◆ isConnected_seqRunOut_OutputPort()

bool Svc::SeqDispatcherComponentBase::isConnected_seqRunOut_OutputPort ( FwIndexType portNum )

protected

Check whether port seqRunOut is connected

Returns: Whether port seqRunOut is connected

Parameters

portNum The port number

Definition at line 806 of file SeqDispatcherComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::SeqDispatcherComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType portNum )

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 780 of file SeqDispatcherComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::SeqDispatcherComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType portNum )

protected

Check whether port tlmOut is connected

Returns: Whether port tlmOut is connected

Parameters

portNum The port number

Definition at line 791 of file SeqDispatcherComponentAc.cpp.

◆ log_ACTIVITY_LO_LogSequencerStatus()

void Svc::SeqDispatcherComponentBase::log_ACTIVITY_LO_LogSequencerStatus	(	U16	idx,
		Svc::SeqDispatcher_CmdSequencerState	state,
		const Fw::StringBase &	filename
	)		const

protected

Log event LogSequencerStatus.

Definition at line 1655 of file SeqDispatcherComponentAc.cpp.

◆ LOG_STATUS_cmdHandler()

virtual void Svc::SeqDispatcherComponentBase::LOG_STATUS_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedpure virtual

Handler for command LOG_STATUS

Logs via Events the state of each connected command sequencer

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ LOG_STATUS_cmdHandlerBase()

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

protected

Base-class handler function for command LOG_STATUS

Logs via Events the state of each connected command sequencer

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1141 of file SeqDispatcherComponentAc.cpp.

◆ LOG_STATUS_preMsgHook()

void Svc::SeqDispatcherComponentBase::LOG_STATUS_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command LOG_STATUS.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1219 of file SeqDispatcherComponentAc.cpp.

◆ log_WARNING_HI_ConflictingSequenceStarted()

void Svc::SeqDispatcherComponentBase::log_WARNING_HI_ConflictingSequenceStarted	(	U16	idx,
		const Fw::StringBase &	newSequence,
		const Fw::StringBase &	sequenceInInternalState
	)		const

protected

Log event ConflictingSequenceStarted.

Definition at line 1463 of file SeqDispatcherComponentAc.cpp.

◆ log_WARNING_HI_InvalidSequencer()

void Svc::SeqDispatcherComponentBase::log_WARNING_HI_InvalidSequencer ( U16 idx ) const

protected

Log event InvalidSequencer.

Definition at line 1234 of file SeqDispatcherComponentAc.cpp.

◆ log_WARNING_HI_NoAvailableSequencers()

void Svc::SeqDispatcherComponentBase::log_WARNING_HI_NoAvailableSequencers ( ) const

protected

Log event NoAvailableSequencers.

Definition at line 1316 of file SeqDispatcherComponentAc.cpp.

◆ log_WARNING_LO_UnexpectedSequenceStarted()

void Svc::SeqDispatcherComponentBase::log_WARNING_LO_UnexpectedSequenceStarted	(	U16	idx,
		const Fw::StringBase &	newSequence
	)		const

protected

Log event UnexpectedSequenceStarted.

Definition at line 1563 of file SeqDispatcherComponentAc.cpp.

◆ log_WARNING_LO_UnknownSequenceFinished()

void Svc::SeqDispatcherComponentBase::log_WARNING_LO_UnknownSequenceFinished ( U16 idx ) const

protected

Log event UnknownSequenceFinished.

Definition at line 1381 of file SeqDispatcherComponentAc.cpp.

◆ regCommands()

void Svc::SeqDispatcherComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 611 of file SeqDispatcherComponentAc.cpp.

◆ RUN_cmdHandler()

virtual void Svc::SeqDispatcherComponentBase::RUN_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdStringArg &	fileName,
		Fw::Wait	block
	)

protectedpure virtual

Handler for command RUN

Dispatches a sequence to the first available sequencer

Parameters

opCode	The opcode
cmdSeq	The command sequence number
fileName	The name of the sequence file
block	Return command status when complete or not

◆ RUN_cmdHandlerBase()

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

protected

Base-class handler function for command RUN

Dispatches a sequence to the first available sequencer

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1082 of file SeqDispatcherComponentAc.cpp.

◆ RUN_preMsgHook()

void Svc::SeqDispatcherComponentBase::RUN_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command RUN.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1208 of file SeqDispatcherComponentAc.cpp.

◆ seqDoneIn_handler()

virtual void Svc::SeqDispatcherComponentBase::seqDoneIn_handler	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)

protectedpure virtual

Handler for input port seqDoneIn.

Parameters

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

Implemented in Svc::SeqDispatcher.

◆ seqDoneIn_handlerBase()

void Svc::SeqDispatcherComponentBase::seqDoneIn_handlerBase	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)

protected

Handler base-class function for input port seqDoneIn.

Parameters

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

Definition at line 823 of file SeqDispatcherComponentAc.cpp.

◆ seqDoneIn_preMsgHook()

void Svc::SeqDispatcherComponentBase::seqDoneIn_preMsgHook	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdResponse &	response
	)

protectedvirtual

Pre-message hook for async input port seqDoneIn.

Parameters

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

Definition at line 1008 of file SeqDispatcherComponentAc.cpp.

◆ seqRunIn_handler()

virtual void Svc::SeqDispatcherComponentBase::seqRunIn_handler	(	FwIndexType	portNum,
		const Fw::StringBase &	filename
	)

protectedpure virtual

Handler for input port seqRunIn.

Parameters

portNum	The port number
filename	The sequence file

Implemented in Svc::SeqDispatcher.

◆ seqRunIn_handlerBase()

void Svc::SeqDispatcherComponentBase::seqRunIn_handlerBase	(	FwIndexType	portNum,
		const Fw::StringBase &	filename
	)

protected

Handler base-class function for input port seqRunIn.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 894 of file SeqDispatcherComponentAc.cpp.

◆ seqRunIn_preMsgHook()

void Svc::SeqDispatcherComponentBase::seqRunIn_preMsgHook	(	FwIndexType	portNum,
		const Fw::StringBase &	filename
	)

protectedvirtual

Pre-message hook for async input port seqRunIn.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 1019 of file SeqDispatcherComponentAc.cpp.

◆ seqRunOut_out()

void Svc::SeqDispatcherComponentBase::seqRunOut_out	(	FwIndexType	portNum,
		const Fw::StringBase &	filename
	)

protected

Invoke output port seqRunOut.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 1041 of file SeqDispatcherComponentAc.cpp.

◆ seqStartIn_handler()

virtual void Svc::SeqDispatcherComponentBase::seqStartIn_handler	(	FwIndexType	portNum,
		const Fw::StringBase &	filename
	)

protectedpure virtual

Handler for input port seqStartIn.

Parameters

portNum	The port number
filename	The sequence file

Implemented in Svc::SeqDispatcher.

◆ seqStartIn_handlerBase()

void Svc::SeqDispatcherComponentBase::seqStartIn_handlerBase	(	FwIndexType	portNum,
		const Fw::StringBase &	filename
	)

protected

Handler base-class function for input port seqStartIn.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 947 of file SeqDispatcherComponentAc.cpp.

◆ seqStartIn_preMsgHook()

void Svc::SeqDispatcherComponentBase::seqStartIn_preMsgHook	(	FwIndexType	portNum,
		const Fw::StringBase &	filename
	)

protectedvirtual

Pre-message hook for async input port seqStartIn.

Parameters

portNum	The port number
filename	The sequence file

Definition at line 1028 of file SeqDispatcherComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::SeqDispatcherComponentBase::set_cmdRegOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdRegPort *	port
	)

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 383 of file SeqDispatcherComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::SeqDispatcherComponentBase::set_cmdResponseOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 397 of file SeqDispatcherComponentAc.cpp.

◆ set_logOut_OutputPort()

void Svc::SeqDispatcherComponentBase::set_logOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to logOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 411 of file SeqDispatcherComponentAc.cpp.

◆ set_seqRunOut_OutputPort()

void Svc::SeqDispatcherComponentBase::set_seqRunOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputCmdSeqInPort *	port
	)

Connect port to seqRunOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 475 of file SeqDispatcherComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::SeqDispatcherComponentBase::set_timeCaller_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 443 of file SeqDispatcherComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::SeqDispatcherComponentBase::set_tlmOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 457 of file SeqDispatcherComponentAc.cpp.

◆ tlmWrite_dispatchedCount()

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

protected

Write telemetry channel dispatchedCount

Number of sequences dispatched

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1772 of file SeqDispatcherComponentAc.cpp.

◆ tlmWrite_errorCount()

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

protected

Write telemetry channel errorCount

Number of sequences dispatched that returned an error. Note: if a sequence was run in non-blocking mode, even if the sequence errors out, this error count will never increase

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1805 of file SeqDispatcherComponentAc.cpp.

◆ tlmWrite_sequencersAvailable()

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

protected

Write telemetry channel sequencersAvailable

Number of sequencers in an available state

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1838 of file SeqDispatcherComponentAc.cpp.

Friends And Related Function Documentation

◆ SeqDispatcherTester

friend class SeqDispatcherTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 49 of file SeqDispatcherComponentAc.hpp.

◆ SeqDispatcherTesterBase

friend class SeqDispatcherTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 47 of file SeqDispatcherComponentAc.hpp.

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

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

Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ SeqDispatcherComponentBase()

◆ ~SeqDispatcherComponentBase()

Member Function Documentation

◆ cmdResponse_out()

◆ get_cmdIn_InputPort()

◆ get_seqDoneIn_InputPort()

◆ get_seqRunIn_InputPort()

◆ get_seqStartIn_InputPort()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegOut_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_logOut_OutputPorts()

◆ getNum_seqDoneIn_InputPorts()

◆ getNum_seqRunIn_InputPorts()

◆ getNum_seqRunOut_OutputPorts()

◆ getNum_seqStartIn_InputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_cmdRegOut_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_logOut_OutputPort()

◆ isConnected_seqRunOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ log_ACTIVITY_LO_LogSequencerStatus()

◆ LOG_STATUS_cmdHandler()

◆ LOG_STATUS_cmdHandlerBase()

◆ LOG_STATUS_preMsgHook()

◆ log_WARNING_HI_ConflictingSequenceStarted()

◆ log_WARNING_HI_InvalidSequencer()

◆ log_WARNING_HI_NoAvailableSequencers()

◆ log_WARNING_LO_UnexpectedSequenceStarted()

◆ log_WARNING_LO_UnknownSequenceFinished()

◆ regCommands()

◆ RUN_cmdHandler()

◆ RUN_cmdHandlerBase()

◆ RUN_preMsgHook()

◆ seqDoneIn_handler()

◆ seqDoneIn_handlerBase()

◆ seqDoneIn_preMsgHook()

◆ seqRunIn_handler()

◆ seqRunIn_handlerBase()

◆ seqRunIn_preMsgHook()

◆ seqRunOut_out()

◆ seqStartIn_handler()

◆ seqStartIn_handlerBase()

◆ seqStartIn_preMsgHook()

◆ set_cmdRegOut_OutputPort()

◆ set_cmdResponseOut_OutputPort()

◆ set_logOut_OutputPort()

◆ set_seqRunOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ set_tlmOut_OutputPort()

◆ tlmWrite_dispatchedCount()

◆ tlmWrite_errorCount()

◆ tlmWrite_sequencersAvailable()

Friends And Related Function Documentation

◆ SeqDispatcherTester

◆ SeqDispatcherTesterBase