Svc::SeqDispatcherComponentBase Class Reference

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.
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 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.
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)
virtual void	seqDoneIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0
	Handler for input port seqDoneIn.
virtual void	seqRunIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=0
	Handler for input port seqRunIn.
virtual void	seqStartIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=0
	Handler for input port seqStartIn.
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.
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.
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.

Friends
class	SeqDispatcherComponentBaseFriend
	Friend class for white-box testing.

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
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component

Detailed Description

Auto-generated base for SeqDispatcher component.

Dispatches command sequences to available command sequencers

Definition at line 36 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 54 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 59 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 66 of file SeqDispatcherComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_SEQRUNOUT_OUTPUT_PORTS

Definition at line 76 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 81 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 87 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 97 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 628 of file SeqDispatcherComponentAc.cpp.

~SeqDispatcherComponentBase()

Svc::SeqDispatcherComponentBase::~SeqDispatcherComponentBase ( )

protectedvirtual

Destroy SeqDispatcherComponentBase object.

Definition at line 635 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 1059 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 330 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 345 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 356 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 367 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 645 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 677 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 683 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 689 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 655 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 661 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 721 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 667 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 705 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 711 of file SeqDispatcherComponentAc.cpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 1869 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 75 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 731 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 742 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 753 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 805 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 779 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 790 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 1649 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 1135 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 1213 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 1457 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 1228 of file SeqDispatcherComponentAc.cpp.

log_WARNING_HI_NoAvailableSequencers()

void Svc::SeqDispatcherComponentBase::log_WARNING_HI_NoAvailableSequencers ( ) const

protected

Log event NoAvailableSequencers.

Definition at line 1310 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 1557 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 1375 of file SeqDispatcherComponentAc.cpp.

regCommands()

void Svc::SeqDispatcherComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 610 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 1076 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 1202 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 822 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 1007 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 893 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 1018 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 1040 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 946 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 1027 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 382 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 396 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 410 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 474 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 442 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 456 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 1766 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 1799 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 1832 of file SeqDispatcherComponentAc.cpp.

Friends And Related Symbol Documentation

SeqDispatcherComponentBaseFriend

friend class SeqDispatcherComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 45 of file SeqDispatcherComponentAc.hpp.

---

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

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