Svc::FpySequencerComponentBase Class Reference

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

#include <Svc/FpySequencer/FpySequencerComponentAc.hpp>

Inheritance diagram for Svc::FpySequencerComponentBase:

Classes
class	Svc_FpySequencer_SequencerStateMachine
	Implementation of state machine Svc_FpySequencer_SequencerStateMachine. More...

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize FpySequencerComponentBase object. More...
Fw::InputCmdPort *	get_cmdIn_InputPort (FwIndexType portNum)
Svc::InputSchedPort *	get_checkTimers_InputPort (FwIndexType portNum)
Fw::InputCmdResponsePort *	get_cmdResponseIn_InputPort (FwIndexType portNum)
Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)
Svc::InputCmdSeqInPort *	get_seqRunIn_InputPort (FwIndexType portNum)
Svc::InputSchedPort *	get_tlmWrite_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_prmGet_OutputPort (FwIndexType portNum, Fw::InputPrmGetPort *port)
	Connect port to prmGet[portNum]. More...
void	set_prmSet_OutputPort (FwIndexType portNum, Fw::InputPrmSetPort *port)
	Connect port to prmSet[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_cmdOut_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
	Connect port to cmdOut[portNum]. More...
void	set_getParam_OutputPort (FwIndexType portNum, Fw::InputPrmGetPort *port)
	Connect port to getParam[portNum]. More...
void	set_getTlmChan_OutputPort (FwIndexType portNum, Fw::InputTlmGetPort *port)
	Connect port to getTlmChan[portNum]. More...
void	set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...
void	regCommands ()
	Register commands with the Command Dispatcher. More...
void	loadParameters ()
	Load the parameters from a parameter source. 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::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...
FwIdType	getIdBase () const

Protected Types
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...
enum	{   NUM_CHECKTIMERS_INPUT_PORTS = 1, NUM_CMDRESPONSEIN_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1, NUM_SEQRUNIN_INPUT_PORTS = 1,   NUM_TLMWRITE_INPUT_PORTS = 1 }
	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_PRMGET_OUTPUT_PORTS = 1, NUM_PRMSET_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1, NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...
enum	{ NUM_CMDOUT_OUTPUT_PORTS = 1, NUM_GETPARAM_OUTPUT_PORTS = 1, NUM_GETTLMCHAN_OUTPUT_PORTS = 1, NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...
enum	{   OPCODE_RUN = 0x0, OPCODE_VALIDATE = 0x1, OPCODE_RUN_VALIDATED = 0x2, OPCODE_CANCEL = 0x3,   OPCODE_DEBUG_SET_BREAKPOINT = 0x4, OPCODE_DEBUG_BREAK = 0x5, OPCODE_DEBUG_CONTINUE = 0x6, OPCODE_DEBUG_CLEAR_BREAKPOINT = 0x7,   OPCODE_STATEMENT_TIMEOUT_SECS_SET = 0x8, OPCODE_STATEMENT_TIMEOUT_SECS_SAVE = 0x9 }
	Command opcodes. More...
enum	{   EVENTID_INVALIDCOMMAND = 0x0, EVENTID_INVALIDSEQRUNCALL = 0x1, EVENTID_FILEOPENERROR = 0x2, EVENTID_FILEREADERROR = 0x3,   EVENTID_ENDOFFILEERROR = 0x4, EVENTID_FILEREADDESERIALIZEERROR = 0x5, EVENTID_WRONGSCHEMAVERSION = 0x6, EVENTID_WRONGCRC = 0x7,   EVENTID_EXTRABYTESINSEQUENCE = 0x8, EVENTID_INSUFFICIENTBUFFERSPACE = 0x9, EVENTID_STATEMENTFAILED = 0xa, EVENTID_SEQUENCEDONE = 0xb,   EVENTID_SEQUENCECANCELLED = 0xc, EVENTID_UNKNOWNSEQUENCERDIRECTIVE = 0xd, EVENTID_COMMANDSERIALIZEERROR = 0xe, EVENTID_CMDRESPONSEWHILENOTRUNNINGSEQUENCE = 0xf,   EVENTID_CMDRESPONSEFROMOLDSEQUENCE = 0x10, EVENTID_CMDRESPONSEWHILENOTAWAITING = 0x11, EVENTID_WRONGCMDRESPONSEOPCODE = 0x12, EVENTID_WRONGCMDRESPONSEINDEX = 0x13,   EVENTID_DIRECTIVEDESERIALIZEERROR = 0x14, EVENTID_MISMATCHEDTIMEBASE = 0x15, EVENTID_MISMATCHEDTIMECONTEXT = 0x16, EVENTID_STATEMENTTIMEDOUT = 0x17,   EVENTID_TOOMANYSEQUENCEARGS = 0x18, EVENTID_TOOMANYSEQUENCESTATEMENTS = 0x19, EVENTID_DEBUGBROKEN = 0x1a, EVENTID_DEBUGBREAKPOINTSET = 0x1b,   EVENTID_DEBUGBREAKPOINTCLEARED = 0x1c }
	Event IDs. More...
enum	{   CHANNELID_STATE = 0x0, CHANNELID_SEQUENCESSUCCEEDED = 0x1, CHANNELID_SEQUENCESFAILED = 0x2, CHANNELID_SEQUENCESCANCELLED = 0x3,   CHANNELID_STATEMENTSDISPATCHED = 0x4, CHANNELID_STATEMENTSFAILED = 0x5, CHANNELID_SEQPATH = 0x6, CHANNELID_DEBUGBREAKPOINTIDX = 0x7,   CHANNELID_DEBUG = 0x8, CHANNELID_STATEMENT_TIMEOUT_SECS = 0x9 }
	Channel IDs. More...
enum	{ PARAMID_STATEMENT_TIMEOUT_SECS = 0x0 }
	Parameter IDs. More...
enum	SmId : FwEnumStoreType { SmId::sequencer }
	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
	FpySequencerComponentBase (const char *compName="")
	Construct FpySequencerComponentBase object. More...
virtual	~FpySequencerComponentBase ()
	Destroy FpySequencerComponentBase object. More...
FwIndexType	getNum_cmdIn_InputPorts () const
FwIndexType	getNum_checkTimers_InputPorts () const
FwIndexType	getNum_cmdResponseIn_InputPorts () const
FwIndexType	getNum_pingIn_InputPorts () const
FwIndexType	getNum_seqRunIn_InputPorts () const
FwIndexType	getNum_tlmWrite_InputPorts () const
FwIndexType	getNum_cmdRegOut_OutputPorts () const
FwIndexType	getNum_cmdResponseOut_OutputPorts () const
FwIndexType	getNum_logOut_OutputPorts () const
FwIndexType	getNum_prmGet_OutputPorts () const
FwIndexType	getNum_prmSet_OutputPorts () const
FwIndexType	getNum_timeCaller_OutputPorts () const
FwIndexType	getNum_tlmOut_OutputPorts () const
FwIndexType	getNum_cmdOut_OutputPorts () const
FwIndexType	getNum_getParam_OutputPorts () const
FwIndexType	getNum_getTlmChan_OutputPorts () const
FwIndexType	getNum_pingOut_OutputPorts () const
bool	isConnected_cmdRegOut_OutputPort (FwIndexType portNum)
bool	isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)
bool	isConnected_logOut_OutputPort (FwIndexType portNum)
bool	isConnected_prmGet_OutputPort (FwIndexType portNum)
bool	isConnected_prmSet_OutputPort (FwIndexType portNum)
bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)
bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)
bool	isConnected_cmdOut_OutputPort (FwIndexType portNum)
bool	isConnected_getParam_OutputPort (FwIndexType portNum)
bool	isConnected_getTlmChan_OutputPort (FwIndexType portNum)
bool	isConnected_pingOut_OutputPort (FwIndexType portNum)
virtual void	checkTimers_handler (FwIndexType portNum, U32 context)=0
	Handler for input port checkTimers. More...
virtual void	cmdResponseIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0
	Handler for input port cmdResponseIn. More...
virtual void	pingIn_handler (FwIndexType portNum, U32 key)=0
	Handler for input port pingIn. More...
virtual void	seqRunIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=0
	Handler for input port seqRunIn. More...
virtual void	tlmWrite_handler (FwIndexType portNum, U32 context)=0
	Handler for input port tlmWrite. More...
void	checkTimers_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port checkTimers. More...
void	cmdResponseIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Handler base-class function for input port cmdResponseIn. More...
void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...
void	seqRunIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename)
	Handler base-class function for input port seqRunIn. More...
void	tlmWrite_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port tlmWrite. More...
virtual void	checkTimers_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port checkTimers. More...
virtual void	cmdResponseIn_preMsgHook (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
	Pre-message hook for async input port cmdResponseIn. More...
virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...
virtual void	seqRunIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename)
	Pre-message hook for async input port seqRunIn. More...
virtual void	tlmWrite_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port tlmWrite. More...
void	cmdOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Invoke output port cmdOut. More...
Fw::ParamValid	getParam_out (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
	Invoke output port getParam. More...
Fw::TlmValid	getTlmChan_out (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
	Invoke output port getTlmChan. More...
void	pingOut_out (FwIndexType portNum, U32 key)
	Invoke output port pingOut. More...
virtual void	directive_getPrm_internalInterfaceHandler (const Svc::FpySequencer_GetPrmDirective &directive)=0
	Internal interface handler for directive_getPrm. More...
virtual void	directive_getTlm_internalInterfaceHandler (const Svc::FpySequencer_GetTlmDirective &directive)=0
	Internal interface handler for directive_getTlm. More...
virtual void	directive_goto_internalInterfaceHandler (const Svc::FpySequencer_GotoDirective &directive)=0
	Internal interface handler for directive_goto. More...
virtual void	directive_if_internalInterfaceHandler (const Svc::FpySequencer_IfDirective &directive)=0
	Internal interface handler for directive_if. More...
virtual void	directive_noOp_internalInterfaceHandler (const Svc::FpySequencer_NoOpDirective &directive)=0
	Internal interface handler for directive_noOp. More...
virtual void	directive_setLocalVar_internalInterfaceHandler (const Svc::FpySequencer_SetLocalVarDirective &directive)=0
	Internal interface handler for directive_setLocalVar. More...
virtual void	directive_waitAbs_internalInterfaceHandler (const Svc::FpySequencer_WaitAbsDirective &directive)=0
	Internal interface handler for directive_waitAbs. More...
virtual void	directive_waitRel_internalInterfaceHandler (const Svc::FpySequencer_WaitRelDirective &directive)=0
	Internal interface handler for directive_waitRel. More...
void	directive_getPrm_internalInterfaceInvoke (const Svc::FpySequencer_GetPrmDirective &directive)
	Internal interface base-class function for directive_getPrm. More...
void	directive_getTlm_internalInterfaceInvoke (const Svc::FpySequencer_GetTlmDirective &directive)
	Internal interface base-class function for directive_getTlm. More...
void	directive_goto_internalInterfaceInvoke (const Svc::FpySequencer_GotoDirective &directive)
	Internal interface base-class function for directive_goto. More...
void	directive_if_internalInterfaceInvoke (const Svc::FpySequencer_IfDirective &directive)
	Internal interface base-class function for directive_if. More...
void	directive_noOp_internalInterfaceInvoke (const Svc::FpySequencer_NoOpDirective &directive)
	Internal interface base-class function for directive_noOp. More...
void	directive_setLocalVar_internalInterfaceInvoke (const Svc::FpySequencer_SetLocalVarDirective &directive)
	Internal interface base-class function for directive_setLocalVar. More...
void	directive_waitAbs_internalInterfaceInvoke (const Svc::FpySequencer_WaitAbsDirective &directive)
	Internal interface base-class function for directive_waitAbs. More...
void	directive_waitRel_internalInterfaceInvoke (const Svc::FpySequencer_WaitRelDirective &directive)
	Internal interface base-class function for directive_waitRel. More...
Svc_FpySequencer_SequencerStateMachine::State	sequencer_getState () const
	Get the state of state machine instance sequencer. More...
void	sequencer_sendSignal_cmd_VALIDATE (const Svc::FpySequencer_SequenceExecutionArgs &value)
	Send signal cmd_VALIDATE to state machine sequencer. More...
void	sequencer_sendSignal_cmd_RUN (const Svc::FpySequencer_SequenceExecutionArgs &value)
	Send signal cmd_RUN to state machine sequencer. More...
void	sequencer_sendSignal_cmd_RUN_VALIDATED (const Svc::FpySequencer_SequenceExecutionArgs &value)
	Send signal cmd_RUN_VALIDATED to state machine sequencer. More...
void	sequencer_sendSignal_cmd_CANCEL ()
	Send signal cmd_CANCEL to state machine sequencer. More...
void	sequencer_sendSignal_cmd_DEBUG_SET_BREAKPOINT (const Svc::FpySequencer_DebugBreakpointArgs &value)
	Send signal cmd_DEBUG_SET_BREAKPOINT to state machine sequencer. More...
void	sequencer_sendSignal_cmd_DEBUG_CLEAR_BREAKPOINT ()
	Send signal cmd_DEBUG_CLEAR_BREAKPOINT to state machine sequencer. More...
void	sequencer_sendSignal_result_failure ()
	Send signal result_failure to state machine sequencer. More...
void	sequencer_sendSignal_result_success ()
	Send signal result_success to state machine sequencer. More...
void	sequencer_sendSignal_entered ()
	Send signal entered to state machine sequencer. More...
void	sequencer_sendSignal_result_dispatchStatement_success ()
	Send signal result_dispatchStatement_success to state machine sequencer. More...
void	sequencer_sendSignal_result_dispatchStatement_failure ()
	Send signal result_dispatchStatement_failure to state machine sequencer. More...
void	sequencer_sendSignal_result_dispatchStatement_noMoreStatements ()
	Send signal result_dispatchStatement_noMoreStatements to state machine sequencer. More...
void	sequencer_sendSignal_checkTimersIn ()
	Send signal checkTimersIn to state machine sequencer. More...
void	sequencer_sendSignal_result_checkShouldWake_wakeup ()
	Send signal result_checkShouldWake_wakeup to state machine sequencer. More...
void	sequencer_sendSignal_result_checkShouldWake_keepSleeping ()
	Send signal result_checkShouldWake_keepSleeping to state machine sequencer. More...
void	sequencer_sendSignal_result_timeOpFailed ()
	Send signal result_timeOpFailed to state machine sequencer. More...
void	sequencer_sendSignal_stmtResponse_beginSleep ()
	Send signal stmtResponse_beginSleep to state machine sequencer. More...
void	sequencer_sendSignal_stmtResponse_success ()
	Send signal stmtResponse_success to state machine sequencer. More...
void	sequencer_sendSignal_stmtResponse_failure ()
	Send signal stmtResponse_failure to state machine sequencer. More...
void	sequencer_sendSignal_stmtResponse_unexpected ()
	Send signal stmtResponse_unexpected to state machine sequencer. More...
void	sequencer_sendSignal_result_checkStatementTimeout_statementTimeout ()
	Send signal result_checkStatementTimeout_statementTimeout to state machine sequencer. More...
void	sequencer_sendSignal_result_checkStatementTimeout_noTimeout ()
	Send signal result_checkStatementTimeout_noTimeout to state machine sequencer. More...
void	sequencer_sendSignal_cmd_DEBUG_CONTINUE ()
	Send signal cmd_DEBUG_CONTINUE to state machine sequencer. More...
void	sequencer_sendSignal_cmd_DEBUG_BREAK (const Svc::FpySequencer_DebugBreakpointArgs &value)
	Send signal cmd_DEBUG_BREAK to state machine sequencer. More...
virtual void	Svc_FpySequencer_SequencerStateMachine_action_signalEntered (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_setSequenceFilePath (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal, const Svc::FpySequencer_SequenceExecutionArgs &value)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_setSequenceBlockState (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal, const Svc::FpySequencer_SequenceExecutionArgs &value)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_validate (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_report_seqSucceeded (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_report_seqCancelled (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_setGoalState_RUNNING (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_setGoalState_VALID (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_setGoalState_IDLE (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_sendCmdResponse_OK (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_sendCmdResponse_EXECUTION_ERROR (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_clearSequenceFile (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_clearDebugBreakpoint (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_checkShouldWake (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_dispatchStatement (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_resetRuntime (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_checkStatementTimeout (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_incrementSequenceCounter (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_report_debugBroken (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
virtual void	Svc_FpySequencer_SequencerStateMachine_action_setDebugBreakpoint (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal, const Svc::FpySequencer_DebugBreakpointArgs &value)=0
virtual bool	Svc_FpySequencer_SequencerStateMachine_guard_goalStateIs_RUNNING (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const =0
virtual bool	Svc_FpySequencer_SequencerStateMachine_guard_shouldDebugBreak (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const =0
virtual bool	Svc_FpySequencer_SequencerStateMachine_guard_debugBreakOnce (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const =0
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, Svc::FpySequencer_BlockState block)=0
virtual void	VALIDATE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName)=0
virtual void	RUN_VALIDATED_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::FpySequencer_BlockState block)=0
virtual void	CANCEL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	DEBUG_SET_BREAKPOINT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 stmtIdx, bool breakOnce)=0
virtual void	DEBUG_BREAK_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, bool breakOnce)=0
virtual void	DEBUG_CONTINUE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
virtual void	DEBUG_CLEAR_BREAKPOINT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
void	RUN_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	VALIDATE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	RUN_VALIDATED_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	CANCEL_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	DEBUG_SET_BREAKPOINT_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	DEBUG_BREAK_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	DEBUG_CONTINUE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
void	DEBUG_CLEAR_BREAKPOINT_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	VALIDATE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command VALIDATE. More...
virtual void	RUN_VALIDATED_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command RUN_VALIDATED. More...
virtual void	CANCEL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command CANCEL. More...
virtual void	DEBUG_SET_BREAKPOINT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command DEBUG_SET_BREAKPOINT. More...
virtual void	DEBUG_BREAK_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command DEBUG_BREAK. More...
virtual void	DEBUG_CONTINUE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command DEBUG_CONTINUE. More...
virtual void	DEBUG_CLEAR_BREAKPOINT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command DEBUG_CLEAR_BREAKPOINT. More...
void	log_WARNING_HI_InvalidCommand (I32 state) const
	Log event InvalidCommand. More...
void	log_WARNING_HI_InvalidSeqRunCall (I32 state) const
	Log event InvalidSeqRunCall. More...
void	log_WARNING_HI_FileOpenError (const Fw::StringBase &filePath, I32 errorCode) const
	Log event FileOpenError. More...
void	log_WARNING_HI_FileReadError (const Fw::StringBase &filePath, I32 errorCode) const
	Log event FileReadError. More...
void	log_WARNING_HI_EndOfFileError (const Fw::StringBase &filePath) const
	Log event EndOfFileError. More...
void	log_WARNING_HI_FileReadDeserializeError (const Fw::StringBase &filePath, I32 errorCode, U64 buffLeft, U64 buffLength) const
	Log event FileReadDeserializeError. More...
void	log_WARNING_HI_WrongSchemaVersion (U8 expected, U8 actual) const
	Log event WrongSchemaVersion. More...
void	log_WARNING_HI_WrongCRC (U32 expected, U32 actual) const
	Log event WrongCRC. More...
void	log_WARNING_HI_ExtraBytesInSequence (U32 remaining) const
	Log event ExtraBytesInSequence. More...
void	log_WARNING_HI_InsufficientBufferSpace (U64 bufferSize, const Fw::StringBase &filePath) const
	Log event InsufficientBufferSpace. More...
void	log_WARNING_HI_StatementFailed (Svc::Fpy::StatementType stmtType, FwOpcodeType stmtOpcode, U32 stmtIdx, const Fw::StringBase &filePath, Fw::CmdResponse response) const
	Log event StatementFailed. More...
void	log_ACTIVITY_HI_SequenceDone (const Fw::StringBase &filePath) const
	Log event SequenceDone. More...
void	log_ACTIVITY_HI_SequenceCancelled (const Fw::StringBase &filePath) const
	Log event SequenceCancelled. More...
void	log_WARNING_HI_UnknownSequencerDirective (FwOpcodeType opcode, U32 stmtIdx, const Fw::StringBase &filePath) const
	Log event UnknownSequencerDirective. More...
void	log_WARNING_HI_CommandSerializeError (FwOpcodeType cmdOpcode, U64 bufCapacity, U64 curPos, U64 writeSize, U8 errorCode, U32 stmtIdx) const
	Log event CommandSerializeError. More...
void	log_WARNING_LO_CmdResponseWhileNotRunningSequence (I32 state, FwOpcodeType opcode, Fw::CmdResponse response) const
	Log event CmdResponseWhileNotRunningSequence. More...
void	log_WARNING_LO_CmdResponseFromOldSequence (FwOpcodeType opcode, Fw::CmdResponse response, U16 oldSequenceIdx, U16 currentSequenceIdx) const
	Log event CmdResponseFromOldSequence. More...
void	log_WARNING_HI_CmdResponseWhileNotAwaiting (FwOpcodeType opcode, Fw::CmdResponse response) const
	Log event CmdResponseWhileNotAwaiting. More...
void	log_WARNING_HI_WrongCmdResponseOpcode (FwOpcodeType opcode, Fw::CmdResponse response, FwOpcodeType expectedOpcode) const
	Log event WrongCmdResponseOpcode. More...
void	log_WARNING_HI_WrongCmdResponseIndex (FwOpcodeType opcode, Fw::CmdResponse response, U16 actualCmdIdx, U16 expectedCmdIdx) const
	Log event WrongCmdResponseIndex. More...
void	log_WARNING_HI_DirectiveDeserializeError (FwOpcodeType opcode, U32 stmtIdx, I32 errorCode, U64 buffLeft, U64 buffLength) const
	Log event DirectiveDeserializeError. More...
void	log_WARNING_HI_MismatchedTimeBase (I32 internalTimeBase, I32 otherTimeBase) const
	Log event MismatchedTimeBase. More...
void	log_WARNING_HI_MismatchedTimeContext (I32 internalTimeContext, I32 otherTimeContext) const
	Log event MismatchedTimeContext. More...
void	log_WARNING_HI_StatementTimedOut (Svc::Fpy::StatementType stmtType, FwOpcodeType stmtOpcode, U32 stmtIdx, const Fw::StringBase &filePath) const
	Log event StatementTimedOut. More...
void	log_WARNING_HI_TooManySequenceArgs (U8 count, U8 max) const
	Log event TooManySequenceArgs. More...
void	log_WARNING_HI_TooManySequenceStatements (U16 count, U16 max) const
	Log event TooManySequenceStatements. More...
void	log_ACTIVITY_HI_DebugBroken (U32 stmtIdx, bool breakOnce) const
	Log event DebugBroken. More...
void	log_ACTIVITY_HI_DebugBreakpointSet (U32 breakpointIdx, bool breakOnce) const
	Log event DebugBreakpointSet. More...
void	log_ACTIVITY_HI_DebugBreakpointCleared () const
	Log event DebugBreakpointCleared. More...
void	tlmWrite_State (I32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_SequencesSucceeded (U64 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_SequencesFailed (U64 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_SequencesCancelled (U64 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_StatementsDispatched (U64 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_StatementsFailed (U64 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_SeqPath (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_DebugBreakpointIdx (U32 arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_Debug (const Svc::FpySequencer_DebugTelemetry &arg, Fw::Time _tlmTime=Fw::Time())
void	tlmWrite_STATEMENT_TIMEOUT_SECS (F32 arg, Fw::Time _tlmTime=Fw::Time())
virtual void	parameterUpdated (FwPrmIdType id)
	Called whenever a parameter is updated. More...
virtual void	parametersLoaded ()
	Called whenever parameters are loaded. More...
F32	paramGet_STATEMENT_TIMEOUT_SECS (Fw::ParamValid &valid)
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	FpySequencerTesterBase
	Friend class tester to support autocoded test harness. More...
class	FpySequencerTester
	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 FpySequencer component.

Dispatches command sequences to available command sequencers

Definition at line 66 of file FpySequencerComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 86 of file FpySequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CHECKTIMERS_INPUT_PORTS
NUM_CMDRESPONSEIN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS
NUM_SEQRUNIN_INPUT_PORTS
NUM_TLMWRITE_INPUT_PORTS

Definition at line 91 of file FpySequencerComponentAc.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_PRMGET_OUTPUT_PORTS
NUM_PRMSET_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 100 of file FpySequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_CMDOUT_OUTPUT_PORTS
NUM_GETPARAM_OUTPUT_PORTS
NUM_GETTLMCHAN_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 112 of file FpySequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_RUN	Loads, validates and runs a sequence.
OPCODE_VALIDATE	Loads and validates a sequence.
OPCODE_RUN_VALIDATED	Must be called after VALIDATE. Runs the sequence that was validated.
OPCODE_CANCEL	Cancels a running or validated sequence. After running CANCEL, the sequencer should return to IDLE
OPCODE_DEBUG_SET_BREAKPOINT	Sets the debugging breakpoint which will pause the execution of the sequencer when reached, until unpaused by the DEBUG_CONTINUE command. Will pause just before dispatching the specified statement. This command is valid in all states. Debug settings are cleared after a sequence ends execution.
OPCODE_DEBUG_BREAK	Pauses the execution of the sequencer, just before it is about to dispatch the next statement, until unpaused by the DEBUG_CONTINUE command. This command is only valid in the RUNNING state. Debug settings are cleared after a sequence ends execution.
OPCODE_DEBUG_CONTINUE	Continues the execution of the sequence after it has been paused by a debug break. This command is only valid in the RUNNING.DEBUG_BROKEN state.
OPCODE_DEBUG_CLEAR_BREAKPOINT	Clears the debugging breakpoint, but does not continue executing the sequence. This command is valid in all states. This happens automatically when a sequence ends execution.
OPCODE_STATEMENT_TIMEOUT_SECS_SET	Opcode to set parameter STATEMENT_TIMEOUT_SECS.
OPCODE_STATEMENT_TIMEOUT_SECS_SAVE	Opcode to save parameter STATEMENT_TIMEOUT_SECS.

Definition at line 120 of file FpySequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_INVALIDCOMMAND
EVENTID_INVALIDSEQRUNCALL
EVENTID_FILEOPENERROR
EVENTID_FILEREADERROR
EVENTID_ENDOFFILEERROR
EVENTID_FILEREADDESERIALIZEERROR
EVENTID_WRONGSCHEMAVERSION
EVENTID_WRONGCRC
EVENTID_EXTRABYTESINSEQUENCE
EVENTID_INSUFFICIENTBUFFERSPACE
EVENTID_STATEMENTFAILED
EVENTID_SEQUENCEDONE
EVENTID_SEQUENCECANCELLED
EVENTID_UNKNOWNSEQUENCERDIRECTIVE
EVENTID_COMMANDSERIALIZEERROR
EVENTID_CMDRESPONSEWHILENOTRUNNINGSEQUENCE
EVENTID_CMDRESPONSEFROMOLDSEQUENCE
EVENTID_CMDRESPONSEWHILENOTAWAITING
EVENTID_WRONGCMDRESPONSEOPCODE
EVENTID_WRONGCMDRESPONSEINDEX
EVENTID_DIRECTIVEDESERIALIZEERROR
EVENTID_MISMATCHEDTIMEBASE
EVENTID_MISMATCHEDTIMECONTEXT
EVENTID_STATEMENTTIMEDOUT
EVENTID_TOOMANYSEQUENCEARGS
EVENTID_TOOMANYSEQUENCESTATEMENTS
EVENTID_DEBUGBROKEN
EVENTID_DEBUGBREAKPOINTSET
EVENTID_DEBUGBREAKPOINTCLEARED

Definition at line 142 of file FpySequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_STATE	Channel ID for State.
CHANNELID_SEQUENCESSUCCEEDED	Channel ID for SequencesSucceeded.
CHANNELID_SEQUENCESFAILED	Channel ID for SequencesFailed.
CHANNELID_SEQUENCESCANCELLED	Channel ID for SequencesCancelled.
CHANNELID_STATEMENTSDISPATCHED	Channel ID for StatementsDispatched.
CHANNELID_STATEMENTSFAILED	Channel ID for StatementsFailed.
CHANNELID_SEQPATH	Channel ID for SeqPath.
CHANNELID_DEBUGBREAKPOINTIDX	Channel ID for DebugBreakpointIdx.
CHANNELID_DEBUG	Channel ID for Debug.
CHANNELID_STATEMENT_TIMEOUT_SECS	Channel ID for STATEMENT_TIMEOUT_SECS.

Definition at line 175 of file FpySequencerComponentAc.hpp.

anonymous enum

anonymous enum

protected

Parameter IDs.

Enumerator
PARAMID_STATEMENT_TIMEOUT_SECS	the number of seconds to wait before giving up on a directive or command. if <= 0 or greater than U32 max, never time out. accuracy of this timeout is determined by the rate group driving this component. it will be rounded up

Definition at line 189 of file FpySequencerComponentAc.hpp.

SmId

enum Svc::FpySequencerComponentBase::SmId : FwEnumStoreType

strongprotected

State machine identifiers.

Enumerator
sequencer

Definition at line 197 of file FpySequencerComponentAc.hpp.

Constructor & Destructor Documentation

FpySequencerComponentBase()

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

protected

Construct FpySequencerComponentBase object.

Parameters

compName

The component name

Definition at line 1216 of file FpySequencerComponentAc.cpp.

~FpySequencerComponentBase()

Svc::FpySequencerComponentBase::~FpySequencerComponentBase ( )

protectedvirtual

Destroy FpySequencerComponentBase object.

Definition at line 1262 of file FpySequencerComponentAc.cpp.

Member Function Documentation

CANCEL_cmdHandler()

virtual void Svc::FpySequencerComponentBase::CANCEL_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command CANCEL

Cancels a running or validated sequence. After running CANCEL, the sequencer should return to IDLE

Parameters

opCode	The opcode
cmdSeq	The command sequence number

CANCEL_cmdHandlerBase()

void Svc::FpySequencerComponentBase::CANCEL_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command CANCEL

Cancels a running or validated sequence. After running CANCEL, the sequencer should return to IDLE

Parameters

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

Definition at line 2735 of file FpySequencerComponentAc.cpp.

CANCEL_preMsgHook()

void Svc::FpySequencerComponentBase::CANCEL_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command CANCEL.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 3071 of file FpySequencerComponentAc.cpp.

checkTimers_handler()

virtual void Svc::FpySequencerComponentBase::checkTimers_handler ( FwIndexType  portNum, U32  context  )

protectedpure virtual

Handler for input port checkTimers.

Parameters

portNum	The port number
context	The call order

Implemented in Svc::FpySequencer.

checkTimers_handlerBase()

void Svc::FpySequencerComponentBase::checkTimers_handlerBase ( FwIndexType  portNum, U32  context  )

protected

Handler base-class function for input port checkTimers.

Parameters

portNum	The port number
context	The call order

Definition at line 1546 of file FpySequencerComponentAc.cpp.

checkTimers_preMsgHook()

void Svc::FpySequencerComponentBase::checkTimers_preMsgHook ( FwIndexType  portNum, U32  context  )

protectedvirtual

Pre-message hook for async input port checkTimers.

Parameters

portNum	The port number
context	The call order

Definition at line 1837 of file FpySequencerComponentAc.cpp.

cmdOut_out()

void Svc::FpySequencerComponentBase::cmdOut_out ( FwIndexType  portNum, Fw::ComBuffer &  data, U32  context  )

protected

Invoke output port cmdOut.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 1888 of file FpySequencerComponentAc.cpp.

cmdResponse_out()

void Svc::FpySequencerComponentBase::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 2541 of file FpySequencerComponentAc.cpp.

cmdResponseIn_handler()

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

protectedpure virtual

Handler for input port cmdResponseIn.

Parameters

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

Implemented in Svc::FpySequencer.

cmdResponseIn_handlerBase()

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

protected

Handler base-class function for input port cmdResponseIn.

Parameters

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

Definition at line 1599 of file FpySequencerComponentAc.cpp.

cmdResponseIn_preMsgHook()

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

protectedvirtual

Pre-message hook for async input port cmdResponseIn.

Parameters

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

Definition at line 1846 of file FpySequencerComponentAc.cpp.

DEBUG_BREAK_cmdHandler()

virtual void Svc::FpySequencerComponentBase::DEBUG_BREAK_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, bool  breakOnce  )

protectedpure virtual

Handler for command DEBUG_BREAK

Pauses the execution of the sequencer, just before it is about to dispatch the next statement, until unpaused by the DEBUG_CONTINUE command. This command is only valid in the RUNNING state. Debug settings are cleared after a sequence ends execution.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
breakOnce	Whether or not to break only once at this breakpoint

DEBUG_BREAK_cmdHandlerBase()

void Svc::FpySequencerComponentBase::DEBUG_BREAK_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command DEBUG_BREAK

Pauses the execution of the sequencer, just before it is about to dispatch the next statement, until unpaused by the DEBUG_CONTINUE command. This command is only valid in the RUNNING state. Debug settings are cleared after a sequence ends execution.

Parameters

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

Definition at line 2853 of file FpySequencerComponentAc.cpp.

DEBUG_BREAK_preMsgHook()

void Svc::FpySequencerComponentBase::DEBUG_BREAK_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command DEBUG_BREAK.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 3093 of file FpySequencerComponentAc.cpp.

DEBUG_CLEAR_BREAKPOINT_cmdHandler()

virtual void Svc::FpySequencerComponentBase::DEBUG_CLEAR_BREAKPOINT_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command DEBUG_CLEAR_BREAKPOINT

Clears the debugging breakpoint, but does not continue executing the sequence. This command is valid in all states. This happens automatically when a sequence ends execution.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

DEBUG_CLEAR_BREAKPOINT_cmdHandlerBase()

void Svc::FpySequencerComponentBase::DEBUG_CLEAR_BREAKPOINT_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command DEBUG_CLEAR_BREAKPOINT

Clears the debugging breakpoint, but does not continue executing the sequence. This command is valid in all states. This happens automatically when a sequence ends execution.

Parameters

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

Definition at line 2971 of file FpySequencerComponentAc.cpp.

DEBUG_CLEAR_BREAKPOINT_preMsgHook()

void Svc::FpySequencerComponentBase::DEBUG_CLEAR_BREAKPOINT_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command DEBUG_CLEAR_BREAKPOINT.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 3115 of file FpySequencerComponentAc.cpp.

DEBUG_CONTINUE_cmdHandler()

virtual void Svc::FpySequencerComponentBase::DEBUG_CONTINUE_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedpure virtual

Handler for command DEBUG_CONTINUE

Continues the execution of the sequence after it has been paused by a debug break. This command is only valid in the RUNNING.DEBUG_BROKEN state.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

DEBUG_CONTINUE_cmdHandlerBase()

void Svc::FpySequencerComponentBase::DEBUG_CONTINUE_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command DEBUG_CONTINUE

Continues the execution of the sequence after it has been paused by a debug break. This command is only valid in the RUNNING.DEBUG_BROKEN state.

Parameters

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

Definition at line 2912 of file FpySequencerComponentAc.cpp.

DEBUG_CONTINUE_preMsgHook()

void Svc::FpySequencerComponentBase::DEBUG_CONTINUE_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command DEBUG_CONTINUE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 3104 of file FpySequencerComponentAc.cpp.

DEBUG_SET_BREAKPOINT_cmdHandler()

virtual void Svc::FpySequencerComponentBase::DEBUG_SET_BREAKPOINT_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, U32  stmtIdx, bool  breakOnce  )

protectedpure virtual

Handler for command DEBUG_SET_BREAKPOINT

Sets the debugging breakpoint which will pause the execution of the sequencer when reached, until unpaused by the DEBUG_CONTINUE command. Will pause just before dispatching the specified statement. This command is valid in all states. Debug settings are cleared after a sequence ends execution.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
stmtIdx	The statement index to pause execution before.
breakOnce	Whether or not to break only once at this breakpoint

DEBUG_SET_BREAKPOINT_cmdHandlerBase()

void Svc::FpySequencerComponentBase::DEBUG_SET_BREAKPOINT_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command DEBUG_SET_BREAKPOINT

Sets the debugging breakpoint which will pause the execution of the sequencer when reached, until unpaused by the DEBUG_CONTINUE command. Will pause just before dispatching the specified statement. This command is valid in all states. Debug settings are cleared after a sequence ends execution.

Parameters

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

Definition at line 2794 of file FpySequencerComponentAc.cpp.

DEBUG_SET_BREAKPOINT_preMsgHook()

void Svc::FpySequencerComponentBase::DEBUG_SET_BREAKPOINT_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command DEBUG_SET_BREAKPOINT.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 3082 of file FpySequencerComponentAc.cpp.

directive_getPrm_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_getPrm_internalInterfaceHandler ( const Svc::FpySequencer_GetPrmDirective &  directive )

protectedpure virtual

Internal interface handler for directive_getPrm.

Implemented in Svc::FpySequencer.

directive_getPrm_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_getPrm_internalInterfaceInvoke ( const Svc::FpySequencer_GetPrmDirective &  directive )

protected

Internal interface base-class function for directive_getPrm.

Definition at line 1980 of file FpySequencerComponentAc.cpp.

directive_getTlm_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_getTlm_internalInterfaceHandler ( const Svc::FpySequencer_GetTlmDirective &  directive )

protectedpure virtual

Internal interface handler for directive_getTlm.

Implemented in Svc::FpySequencer.

directive_getTlm_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_getTlm_internalInterfaceInvoke ( const Svc::FpySequencer_GetTlmDirective &  directive )

protected

Internal interface base-class function for directive_getTlm.

Definition at line 2016 of file FpySequencerComponentAc.cpp.

directive_goto_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_goto_internalInterfaceHandler ( const Svc::FpySequencer_GotoDirective &  directive )

protectedpure virtual

Internal interface handler for directive_goto.

Implemented in Svc::FpySequencer.

directive_goto_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_goto_internalInterfaceInvoke ( const Svc::FpySequencer_GotoDirective &  directive )

protected

Internal interface base-class function for directive_goto.

Definition at line 2052 of file FpySequencerComponentAc.cpp.

directive_if_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_if_internalInterfaceHandler ( const Svc::FpySequencer_IfDirective &  directive )

protectedpure virtual

Internal interface handler for directive_if.

Implemented in Svc::FpySequencer.

directive_if_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_if_internalInterfaceInvoke ( const Svc::FpySequencer_IfDirective &  directive )

protected

Internal interface base-class function for directive_if.

Definition at line 2088 of file FpySequencerComponentAc.cpp.

directive_noOp_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_noOp_internalInterfaceHandler ( const Svc::FpySequencer_NoOpDirective &  directive )

protectedpure virtual

Internal interface handler for directive_noOp.

Implemented in Svc::FpySequencer.

directive_noOp_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_noOp_internalInterfaceInvoke ( const Svc::FpySequencer_NoOpDirective &  directive )

protected

Internal interface base-class function for directive_noOp.

Definition at line 2124 of file FpySequencerComponentAc.cpp.

directive_setLocalVar_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_setLocalVar_internalInterfaceHandler ( const Svc::FpySequencer_SetLocalVarDirective &  directive )

protectedpure virtual

Internal interface handler for directive_setLocalVar.

Implemented in Svc::FpySequencer.

directive_setLocalVar_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_setLocalVar_internalInterfaceInvoke ( const Svc::FpySequencer_SetLocalVarDirective &  directive )

protected

Internal interface base-class function for directive_setLocalVar.

Definition at line 2160 of file FpySequencerComponentAc.cpp.

directive_waitAbs_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_waitAbs_internalInterfaceHandler ( const Svc::FpySequencer_WaitAbsDirective &  directive )

protectedpure virtual

Internal interface handler for directive_waitAbs.

Implemented in Svc::FpySequencer.

directive_waitAbs_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_waitAbs_internalInterfaceInvoke ( const Svc::FpySequencer_WaitAbsDirective &  directive )

protected

Internal interface base-class function for directive_waitAbs.

Definition at line 2196 of file FpySequencerComponentAc.cpp.

directive_waitRel_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_waitRel_internalInterfaceHandler ( const Svc::FpySequencer_WaitRelDirective &  directive )

protectedpure virtual

Internal interface handler for directive_waitRel.

Implemented in Svc::FpySequencer.

directive_waitRel_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_waitRel_internalInterfaceInvoke ( const Svc::FpySequencer_WaitRelDirective &  directive )

protected

Internal interface base-class function for directive_waitRel.

Definition at line 2232 of file FpySequencerComponentAc.cpp.

get_checkTimers_InputPort()

Svc::InputSchedPort * Svc::FpySequencerComponentBase::get_checkTimers_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

checkTimers[portNum]

Parameters

portNum

The port number

Definition at line 734 of file FpySequencerComponentAc.cpp.

get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::FpySequencerComponentBase::get_cmdIn_InputPort

(

FwIndexType

portNum

)

Get special input port at index

Returns

cmdIn[portNum]

Parameters

portNum

The port number

Definition at line 719 of file FpySequencerComponentAc.cpp.

get_cmdResponseIn_InputPort()

Fw::InputCmdResponsePort * Svc::FpySequencerComponentBase::get_cmdResponseIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

cmdResponseIn[portNum]

Parameters

portNum

The port number

Definition at line 745 of file FpySequencerComponentAc.cpp.

get_pingIn_InputPort()

Svc::InputPingPort * Svc::FpySequencerComponentBase::get_pingIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

pingIn[portNum]

Parameters

portNum

The port number

Definition at line 756 of file FpySequencerComponentAc.cpp.

get_seqRunIn_InputPort()

Svc::InputCmdSeqInPort * Svc::FpySequencerComponentBase::get_seqRunIn_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

seqRunIn[portNum]

Parameters

portNum

The port number

Definition at line 767 of file FpySequencerComponentAc.cpp.

get_tlmWrite_InputPort()

Svc::InputSchedPort * Svc::FpySequencerComponentBase::get_tlmWrite_InputPort

(

FwIndexType

portNum

)

Get typed input port at index

Returns

tlmWrite[portNum]

Parameters

portNum

The port number

Definition at line 778 of file FpySequencerComponentAc.cpp.

getNum_checkTimers_InputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_checkTimers_InputPorts ( ) const

protected

Get the number of checkTimers input ports

Returns

The number of checkTimers input ports

Definition at line 1282 of file FpySequencerComponentAc.cpp.

getNum_cmdIn_InputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns

The number of cmdIn input ports

Definition at line 1272 of file FpySequencerComponentAc.cpp.

getNum_cmdOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_cmdOut_OutputPorts ( ) const

protected

Get the number of cmdOut output ports

Returns

The number of cmdOut output ports

Definition at line 1372 of file FpySequencerComponentAc.cpp.

getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns

The number of cmdRegOut output ports

Definition at line 1316 of file FpySequencerComponentAc.cpp.

getNum_cmdResponseIn_InputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_cmdResponseIn_InputPorts ( ) const

protected

Get the number of cmdResponseIn input ports

Returns

The number of cmdResponseIn input ports

Definition at line 1288 of file FpySequencerComponentAc.cpp.

getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns

The number of cmdResponseOut output ports

Definition at line 1322 of file FpySequencerComponentAc.cpp.

getNum_getParam_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_getParam_OutputPorts ( ) const

protected

Get the number of getParam output ports

Returns

The number of getParam output ports

Definition at line 1378 of file FpySequencerComponentAc.cpp.

getNum_getTlmChan_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_getTlmChan_OutputPorts ( ) const

protected

Get the number of getTlmChan output ports

Returns

The number of getTlmChan output ports

Definition at line 1384 of file FpySequencerComponentAc.cpp.

getNum_logOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_logOut_OutputPorts ( ) const

protected

Get the number of logOut output ports

Returns

The number of logOut output ports

Definition at line 1328 of file FpySequencerComponentAc.cpp.

getNum_pingIn_InputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns

The number of pingIn input ports

Definition at line 1294 of file FpySequencerComponentAc.cpp.

getNum_pingOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns

The number of pingOut output ports

Definition at line 1390 of file FpySequencerComponentAc.cpp.

getNum_prmGet_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_prmGet_OutputPorts ( ) const

protected

Get the number of prmGet output ports

Returns

The number of prmGet output ports

Definition at line 1344 of file FpySequencerComponentAc.cpp.

getNum_prmSet_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_prmSet_OutputPorts ( ) const

protected

Get the number of prmSet output ports

Returns

The number of prmSet output ports

Definition at line 1350 of file FpySequencerComponentAc.cpp.

getNum_seqRunIn_InputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_seqRunIn_InputPorts ( ) const

protected

Get the number of seqRunIn input ports

Returns

The number of seqRunIn input ports

Definition at line 1300 of file FpySequencerComponentAc.cpp.

getNum_timeCaller_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns

The number of timeCaller output ports

Definition at line 1356 of file FpySequencerComponentAc.cpp.

getNum_tlmOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns

The number of tlmOut output ports

Definition at line 1362 of file FpySequencerComponentAc.cpp.

getNum_tlmWrite_InputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_tlmWrite_InputPorts ( ) const

protected

Get the number of tlmWrite input ports

Returns

The number of tlmWrite input ports

Definition at line 1306 of file FpySequencerComponentAc.cpp.

getParam_out()

Fw::ParamValid Svc::FpySequencerComponentBase::getParam_out ( FwIndexType  portNum, FwPrmIdType  id, Fw::ParamBuffer &  val  )

protected

Invoke output port getParam.

Parameters

portNum	The port number
id	Parameter ID
val	Buffer containing serialized parameter value. Unmodified if param not found.

Definition at line 1910 of file FpySequencerComponentAc.cpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 6751 of file FpySequencerComponentAc.cpp.

getTlmChan_out()

Fw::TlmValid Svc::FpySequencerComponentBase::getTlmChan_out ( FwIndexType  portNum, FwChanIdType  id, Fw::Time &  timeTag, Fw::TlmBuffer &  val  )

protected

Invoke output port getTlmChan.

Parameters

portNum	The port number
id	Telemetry Channel ID
timeTag	Time Tag
val	Buffer containing serialized telemetry value. Size set to 0 if channel not found, or if no value has been received for this channel yet.

Definition at line 1932 of file FpySequencerComponentAc.cpp.

init()

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

Initialize FpySequencerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 318 of file FpySequencerComponentAc.cpp.

isConnected_cmdOut_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_cmdOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port cmdOut is connected

Returns

Whether port cmdOut is connected

Parameters

portNum

The port number

Definition at line 1496 of file FpySequencerComponentAc.cpp.

isConnected_cmdRegOut_OutputPort()

bool Svc::FpySequencerComponentBase::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 1400 of file FpySequencerComponentAc.cpp.

isConnected_cmdResponseOut_OutputPort()

bool Svc::FpySequencerComponentBase::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 1411 of file FpySequencerComponentAc.cpp.

isConnected_getParam_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_getParam_OutputPort ( FwIndexType  portNum )

protected

Check whether port getParam is connected

Returns

Whether port getParam is connected

Parameters

portNum

The port number

Definition at line 1507 of file FpySequencerComponentAc.cpp.

isConnected_getTlmChan_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_getTlmChan_OutputPort ( FwIndexType  portNum )

protected

Check whether port getTlmChan is connected

Returns

Whether port getTlmChan is connected

Parameters

portNum

The port number

Definition at line 1518 of file FpySequencerComponentAc.cpp.

isConnected_logOut_OutputPort()

bool Svc::FpySequencerComponentBase::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 1422 of file FpySequencerComponentAc.cpp.

isConnected_pingOut_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_pingOut_OutputPort ( FwIndexType  portNum )

protected

Check whether port pingOut is connected

Returns

Whether port pingOut is connected

Parameters

portNum

The port number

Definition at line 1529 of file FpySequencerComponentAc.cpp.

isConnected_prmGet_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_prmGet_OutputPort ( FwIndexType  portNum )

protected

Check whether port prmGet is connected

Returns

Whether port prmGet is connected

Parameters

portNum

The port number

Definition at line 1448 of file FpySequencerComponentAc.cpp.

isConnected_prmSet_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_prmSet_OutputPort ( FwIndexType  portNum )

protected

Check whether port prmSet is connected

Returns

Whether port prmSet is connected

Parameters

portNum

The port number

Definition at line 1459 of file FpySequencerComponentAc.cpp.

isConnected_timeCaller_OutputPort()

bool Svc::FpySequencerComponentBase::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 1470 of file FpySequencerComponentAc.cpp.

isConnected_tlmOut_OutputPort()

bool Svc::FpySequencerComponentBase::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 1481 of file FpySequencerComponentAc.cpp.

loadParameters()

void Svc::FpySequencerComponentBase::loadParameters

(

)

Load the parameters from a parameter source.

Connect the parameter first

Definition at line 1169 of file FpySequencerComponentAc.cpp.

log_ACTIVITY_HI_DebugBreakpointCleared()

void Svc::FpySequencerComponentBase::log_ACTIVITY_HI_DebugBreakpointCleared ( ) const

protected

Log event DebugBreakpointCleared.

Definition at line 6167 of file FpySequencerComponentAc.cpp.

log_ACTIVITY_HI_DebugBreakpointSet()

void Svc::FpySequencerComponentBase::log_ACTIVITY_HI_DebugBreakpointSet ( U32  breakpointIdx, bool  breakOnce  ) const

protected

Log event DebugBreakpointSet.

Definition at line 6065 of file FpySequencerComponentAc.cpp.

log_ACTIVITY_HI_DebugBroken()

void Svc::FpySequencerComponentBase::log_ACTIVITY_HI_DebugBroken ( U32  stmtIdx, bool  breakOnce  ) const

protected

Log event DebugBroken.

Definition at line 5963 of file FpySequencerComponentAc.cpp.

log_ACTIVITY_HI_SequenceCancelled()

void Svc::FpySequencerComponentBase::log_ACTIVITY_HI_SequenceCancelled ( const Fw::StringBase &  filePath ) const

protected

Log event SequenceCancelled.

Definition at line 4279 of file FpySequencerComponentAc.cpp.

log_ACTIVITY_HI_SequenceDone()

void Svc::FpySequencerComponentBase::log_ACTIVITY_HI_SequenceDone ( const Fw::StringBase &  filePath ) const

protected

Log event SequenceDone.

Definition at line 4207 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_CmdResponseWhileNotAwaiting()

void Svc::FpySequencerComponentBase::log_WARNING_HI_CmdResponseWhileNotAwaiting ( FwOpcodeType  opcode, Fw::CmdResponse  response  ) const

protected

Log event CmdResponseWhileNotAwaiting.

Definition at line 4899 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_CommandSerializeError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_CommandSerializeError ( FwOpcodeType  cmdOpcode, U64  bufCapacity, U64  curPos, U64  writeSize, U8  errorCode, U32  stmtIdx  ) const

protected

Log event CommandSerializeError.

Definition at line 4461 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_DirectiveDeserializeError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_DirectiveDeserializeError ( FwOpcodeType  opcode, U32  stmtIdx, I32  errorCode, U64  buffLeft, U64  buffLength  ) const

protected

Log event DirectiveDeserializeError.

Definition at line 5268 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_EndOfFileError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_EndOfFileError ( const Fw::StringBase &  filePath ) const

protected

Log event EndOfFileError.

Definition at line 3478 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_ExtraBytesInSequence()

void Svc::FpySequencerComponentBase::log_WARNING_HI_ExtraBytesInSequence ( U32  remaining ) const

protected

Log event ExtraBytesInSequence.

Definition at line 3882 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_FileOpenError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_FileOpenError ( const Fw::StringBase &  filePath, I32  errorCode  ) const

protected

Log event FileOpenError.

Definition at line 3294 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_FileReadDeserializeError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_FileReadDeserializeError ( const Fw::StringBase &  filePath, I32  errorCode, U64  buffLeft, U64  buffLength  ) const

protected

Log event FileReadDeserializeError.

Definition at line 3550 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_FileReadError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_FileReadError ( const Fw::StringBase &  filePath, I32  errorCode  ) const

protected

Log event FileReadError.

Definition at line 3386 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_InsufficientBufferSpace()

void Svc::FpySequencerComponentBase::log_WARNING_HI_InsufficientBufferSpace ( U64  bufferSize, const Fw::StringBase &  filePath  ) const

protected

Log event InsufficientBufferSpace.

Definition at line 3964 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_InvalidCommand()

void Svc::FpySequencerComponentBase::log_WARNING_HI_InvalidCommand ( I32  state ) const

protected

Log event InvalidCommand.

Definition at line 3130 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_InvalidSeqRunCall()

void Svc::FpySequencerComponentBase::log_WARNING_HI_InvalidSeqRunCall ( I32  state ) const

protected

Log event InvalidSeqRunCall.

Definition at line 3212 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_MismatchedTimeBase()

void Svc::FpySequencerComponentBase::log_WARNING_HI_MismatchedTimeBase ( I32  internalTimeBase, I32  otherTimeBase  ) const

protected

Log event MismatchedTimeBase.

Definition at line 5424 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_MismatchedTimeContext()

void Svc::FpySequencerComponentBase::log_WARNING_HI_MismatchedTimeContext ( I32  internalTimeContext, I32  otherTimeContext  ) const

protected

Log event MismatchedTimeContext.

Definition at line 5526 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_StatementFailed()

void Svc::FpySequencerComponentBase::log_WARNING_HI_StatementFailed ( Svc::Fpy::StatementType  stmtType, FwOpcodeType  stmtOpcode, U32  stmtIdx, const Fw::StringBase &  filePath, Fw::CmdResponse  response  ) const

protected

Log event StatementFailed.

Definition at line 4056 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_StatementTimedOut()

void Svc::FpySequencerComponentBase::log_WARNING_HI_StatementTimedOut ( Svc::Fpy::StatementType  stmtType, FwOpcodeType  stmtOpcode, U32  stmtIdx, const Fw::StringBase &  filePath  ) const

protected

Log event StatementTimedOut.

Definition at line 5628 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_TooManySequenceArgs()

void Svc::FpySequencerComponentBase::log_WARNING_HI_TooManySequenceArgs ( U8  count, U8  max  ) const

protected

Log event TooManySequenceArgs.

Definition at line 5759 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_TooManySequenceStatements()

void Svc::FpySequencerComponentBase::log_WARNING_HI_TooManySequenceStatements ( U16  count, U16  max  ) const

protected

Log event TooManySequenceStatements.

Definition at line 5861 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_UnknownSequencerDirective()

void Svc::FpySequencerComponentBase::log_WARNING_HI_UnknownSequencerDirective ( FwOpcodeType  opcode, U32  stmtIdx, const Fw::StringBase &  filePath  ) const

protected

Log event UnknownSequencerDirective.

Definition at line 4351 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_WrongCmdResponseIndex()

void Svc::FpySequencerComponentBase::log_WARNING_HI_WrongCmdResponseIndex ( FwOpcodeType  opcode, Fw::CmdResponse  response, U16  actualCmdIdx, U16  expectedCmdIdx  ) const

protected

Log event WrongCmdResponseIndex.

Definition at line 5127 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_WrongCmdResponseOpcode()

void Svc::FpySequencerComponentBase::log_WARNING_HI_WrongCmdResponseOpcode ( FwOpcodeType  opcode, Fw::CmdResponse  response, FwOpcodeType  expectedOpcode  ) const

protected

Log event WrongCmdResponseOpcode.

Definition at line 5004 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_WrongCRC()

void Svc::FpySequencerComponentBase::log_WARNING_HI_WrongCRC ( U32  expected, U32  actual  ) const

protected

Log event WrongCRC.

Definition at line 3780 of file FpySequencerComponentAc.cpp.

log_WARNING_HI_WrongSchemaVersion()

void Svc::FpySequencerComponentBase::log_WARNING_HI_WrongSchemaVersion ( U8  expected, U8  actual  ) const

protected

Log event WrongSchemaVersion.

Definition at line 3678 of file FpySequencerComponentAc.cpp.

log_WARNING_LO_CmdResponseFromOldSequence()

void Svc::FpySequencerComponentBase::log_WARNING_LO_CmdResponseFromOldSequence ( FwOpcodeType  opcode, Fw::CmdResponse  response, U16  oldSequenceIdx, U16  currentSequenceIdx  ) const

protected

Log event CmdResponseFromOldSequence.

Definition at line 4758 of file FpySequencerComponentAc.cpp.

log_WARNING_LO_CmdResponseWhileNotRunningSequence()

void Svc::FpySequencerComponentBase::log_WARNING_LO_CmdResponseWhileNotRunningSequence ( I32  state, FwOpcodeType  opcode, Fw::CmdResponse  response  ) const

protected

Log event CmdResponseWhileNotRunningSequence.

Definition at line 4635 of file FpySequencerComponentAc.cpp.

parametersLoaded()

void Svc::FpySequencerComponentBase::parametersLoaded ( )

protectedvirtual

Called whenever parameters are loaded.

This function does nothing by default. You may override it.

Reimplemented in Svc::FpySequencer.

Definition at line 6726 of file FpySequencerComponentAc.cpp.

parameterUpdated()

void Svc::FpySequencerComponentBase::parameterUpdated ( FwPrmIdType  id )

protectedvirtual

Called whenever a parameter is updated.

This function does nothing by default. You may override it.

Parameters

id	The parameter ID

Reimplemented in Svc::FpySequencer.

Definition at line 6720 of file FpySequencerComponentAc.cpp.

paramGet_STATEMENT_TIMEOUT_SECS()

F32 Svc::FpySequencerComponentBase::paramGet_STATEMENT_TIMEOUT_SECS ( Fw::ParamValid &  valid )

protected

Get parameter STATEMENT_TIMEOUT_SECS

Returns

The parameter value

the number of seconds to wait before giving up on a directive or command. if <= 0 or greater than U32 max, never time out. accuracy of this timeout is determined by the rate group driving this component. it will be rounded up

Parameters

valid

Whether the parameter is valid

Definition at line 6736 of file FpySequencerComponentAc.cpp.

pingIn_handler()

virtual void Svc::FpySequencerComponentBase::pingIn_handler ( FwIndexType  portNum, U32  key  )

protectedpure virtual

Handler for input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Implemented in Svc::FpySequencer.

pingIn_handlerBase()

void Svc::FpySequencerComponentBase::pingIn_handlerBase ( FwIndexType  portNum, U32  key  )

protected

Handler base-class function for input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1670 of file FpySequencerComponentAc.cpp.

pingIn_preMsgHook()

void Svc::FpySequencerComponentBase::pingIn_preMsgHook ( FwIndexType  portNum, U32  key  )

protectedvirtual

Pre-message hook for async input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1857 of file FpySequencerComponentAc.cpp.

pingOut_out()

void Svc::FpySequencerComponentBase::pingOut_out ( FwIndexType  portNum, U32  key  )

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1956 of file FpySequencerComponentAc.cpp.

regCommands()

void Svc::FpySequencerComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 1119 of file FpySequencerComponentAc.cpp.

RUN_cmdHandler()

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

protectedpure virtual

Handler for command RUN

Loads, validates and runs a sequence

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::FpySequencerComponentBase::RUN_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command RUN

Loads, validates and runs a sequence

Parameters

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

Definition at line 2558 of file FpySequencerComponentAc.cpp.

RUN_preMsgHook()

void Svc::FpySequencerComponentBase::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 3038 of file FpySequencerComponentAc.cpp.

RUN_VALIDATED_cmdHandler()

virtual void Svc::FpySequencerComponentBase::RUN_VALIDATED_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, Svc::FpySequencer_BlockState  block  )

protectedpure virtual

Handler for command RUN_VALIDATED

Must be called after VALIDATE. Runs the sequence that was validated.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
block	Return command status when complete or not

RUN_VALIDATED_cmdHandlerBase()

void Svc::FpySequencerComponentBase::RUN_VALIDATED_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command RUN_VALIDATED

Must be called after VALIDATE. Runs the sequence that was validated.

Parameters

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

Definition at line 2676 of file FpySequencerComponentAc.cpp.

RUN_VALIDATED_preMsgHook()

void Svc::FpySequencerComponentBase::RUN_VALIDATED_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command RUN_VALIDATED.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 3060 of file FpySequencerComponentAc.cpp.

seqRunIn_handler()

virtual void Svc::FpySequencerComponentBase::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::FpySequencer.

seqRunIn_handlerBase()

void Svc::FpySequencerComponentBase::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 1723 of file FpySequencerComponentAc.cpp.

seqRunIn_preMsgHook()

void Svc::FpySequencerComponentBase::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 1866 of file FpySequencerComponentAc.cpp.

sequencer_getState()

FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine::State Svc::FpySequencerComponentBase::sequencer_getState ( ) const

protected

Get the state of state machine instance sequencer.

Definition at line 2272 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_checkTimersIn()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_checkTimersIn ( )

protected

Send signal checkTimersIn to state machine sequencer.

Definition at line 2414 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_CANCEL()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_CANCEL ( )

protected

Send signal cmd_CANCEL to state machine sequencer.

Definition at line 2321 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_DEBUG_BREAK()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_DEBUG_BREAK ( const Svc::FpySequencer_DebugBreakpointArgs &  value )

protected

Send signal cmd_DEBUG_BREAK to state machine sequencer.

Parameters

value

The value

Definition at line 2524 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_DEBUG_CLEAR_BREAKPOINT()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_DEBUG_CLEAR_BREAKPOINT ( )

protected

Send signal cmd_DEBUG_CLEAR_BREAKPOINT to state machine sequencer.

Definition at line 2344 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_DEBUG_CONTINUE()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_DEBUG_CONTINUE ( )

protected

Send signal cmd_DEBUG_CONTINUE to state machine sequencer.

Definition at line 2514 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_DEBUG_SET_BREAKPOINT()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_DEBUG_SET_BREAKPOINT ( const Svc::FpySequencer_DebugBreakpointArgs &  value )

protected

Send signal cmd_DEBUG_SET_BREAKPOINT to state machine sequencer.

Parameters

value

The value

Definition at line 2331 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_RUN()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_RUN ( const Svc::FpySequencer_SequenceExecutionArgs &  value )

protected

Send signal cmd_RUN to state machine sequencer.

Parameters

value

The value

Definition at line 2295 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_RUN_VALIDATED()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_RUN_VALIDATED ( const Svc::FpySequencer_SequenceExecutionArgs &  value )

protected

Send signal cmd_RUN_VALIDATED to state machine sequencer.

Parameters

value

The value

Definition at line 2308 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_cmd_VALIDATE()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_VALIDATE ( const Svc::FpySequencer_SequenceExecutionArgs &  value )

protected

Send signal cmd_VALIDATE to state machine sequencer.

Parameters

value

The value

Definition at line 2282 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_entered()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_entered ( )

protected

Send signal entered to state machine sequencer.

Definition at line 2374 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_checkShouldWake_keepSleeping()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_checkShouldWake_keepSleeping ( )

protected

Send signal result_checkShouldWake_keepSleeping to state machine sequencer.

Definition at line 2434 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_checkShouldWake_wakeup()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_checkShouldWake_wakeup ( )

protected

Send signal result_checkShouldWake_wakeup to state machine sequencer.

Definition at line 2424 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_checkStatementTimeout_noTimeout()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_checkStatementTimeout_noTimeout ( )

protected

Send signal result_checkStatementTimeout_noTimeout to state machine sequencer.

Definition at line 2504 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_checkStatementTimeout_statementTimeout()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_checkStatementTimeout_statementTimeout ( )

protected

Send signal result_checkStatementTimeout_statementTimeout to state machine sequencer.

Definition at line 2494 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_dispatchStatement_failure()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_dispatchStatement_failure ( )

protected

Send signal result_dispatchStatement_failure to state machine sequencer.

Definition at line 2394 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_dispatchStatement_noMoreStatements()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_dispatchStatement_noMoreStatements ( )

protected

Send signal result_dispatchStatement_noMoreStatements to state machine sequencer.

Definition at line 2404 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_dispatchStatement_success()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_dispatchStatement_success ( )

protected

Send signal result_dispatchStatement_success to state machine sequencer.

Definition at line 2384 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_failure()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_failure ( )

protected

Send signal result_failure to state machine sequencer.

Definition at line 2354 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_success()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_success ( )

protected

Send signal result_success to state machine sequencer.

Definition at line 2364 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_result_timeOpFailed()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_result_timeOpFailed ( )

protected

Send signal result_timeOpFailed to state machine sequencer.

Definition at line 2444 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_stmtResponse_beginSleep()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_stmtResponse_beginSleep ( )

protected

Send signal stmtResponse_beginSleep to state machine sequencer.

Definition at line 2454 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_stmtResponse_failure()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_stmtResponse_failure ( )

protected

Send signal stmtResponse_failure to state machine sequencer.

Definition at line 2474 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_stmtResponse_success()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_stmtResponse_success ( )

protected

Send signal stmtResponse_success to state machine sequencer.

Definition at line 2464 of file FpySequencerComponentAc.cpp.

sequencer_sendSignal_stmtResponse_unexpected()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_stmtResponse_unexpected ( )

protected

Send signal stmtResponse_unexpected to state machine sequencer.

Definition at line 2484 of file FpySequencerComponentAc.cpp.

set_cmdOut_OutputPort()

void Svc::FpySequencerComponentBase::set_cmdOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputComPort *	port
	)

Connect port to cmdOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 913 of file FpySequencerComponentAc.cpp.

set_cmdRegOut_OutputPort()

void Svc::FpySequencerComponentBase::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 793 of file FpySequencerComponentAc.cpp.

set_cmdResponseOut_OutputPort()

void Svc::FpySequencerComponentBase::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 807 of file FpySequencerComponentAc.cpp.

set_getParam_OutputPort()

void Svc::FpySequencerComponentBase::set_getParam_OutputPort	(	FwIndexType	portNum,
		Fw::InputPrmGetPort *	port
	)

Connect port to getParam[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 927 of file FpySequencerComponentAc.cpp.

set_getTlmChan_OutputPort()

void Svc::FpySequencerComponentBase::set_getTlmChan_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmGetPort *	port
	)

Connect port to getTlmChan[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 941 of file FpySequencerComponentAc.cpp.

set_logOut_OutputPort()

void Svc::FpySequencerComponentBase::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 821 of file FpySequencerComponentAc.cpp.

set_pingOut_OutputPort()

void Svc::FpySequencerComponentBase::set_pingOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputPingPort *	port
	)

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 955 of file FpySequencerComponentAc.cpp.

set_prmGet_OutputPort()

void Svc::FpySequencerComponentBase::set_prmGet_OutputPort	(	FwIndexType	portNum,
		Fw::InputPrmGetPort *	port
	)

Connect port to prmGet[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 853 of file FpySequencerComponentAc.cpp.

set_prmSet_OutputPort()

void Svc::FpySequencerComponentBase::set_prmSet_OutputPort	(	FwIndexType	portNum,
		Fw::InputPrmSetPort *	port
	)

Connect port to prmSet[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 867 of file FpySequencerComponentAc.cpp.

set_timeCaller_OutputPort()

void Svc::FpySequencerComponentBase::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 881 of file FpySequencerComponentAc.cpp.

set_tlmOut_OutputPort()

void Svc::FpySequencerComponentBase::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 895 of file FpySequencerComponentAc.cpp.

Svc_FpySequencer_SequencerStateMachine_action_checkShouldWake()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_checkShouldWake ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action checkShouldWake of state machine Svc_FpySequencer_SequencerStateMachine

checks if sequencer should wake from sleep

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_checkStatementTimeout()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_checkStatementTimeout ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action checkStatementTimeout of state machine Svc_FpySequencer_SequencerStateMachine

checks if the current statement has timed out

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_clearDebugBreakpoint()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_clearDebugBreakpoint ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action clearDebugBreakpoint of state machine Svc_FpySequencer_SequencerStateMachine

clears the debug breakpoint setting

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_clearSequenceFile()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_clearSequenceFile ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action clearSequenceFile of state machine Svc_FpySequencer_SequencerStateMachine

clears all variables related to the loading/validating of the sequence file

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_dispatchStatement()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_dispatchStatement ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action dispatchStatement of state machine Svc_FpySequencer_SequencerStateMachine

iterates to the next statement and dispatches it

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_incrementSequenceCounter()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_incrementSequenceCounter ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action incrementSequenceCounter of state machine Svc_FpySequencer_SequencerStateMachine

increments the m_sequencesStarted counter

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_report_debugBroken()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_report_debugBroken ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action report_debugBroken of state machine Svc_FpySequencer_SequencerStateMachine

reports that a debug breakpoint was hit

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_report_seqCancelled()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_report_seqCancelled ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action report_seqCancelled of state machine Svc_FpySequencer_SequencerStateMachine

reports that a sequence was cancelled

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_report_seqSucceeded()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_report_seqSucceeded ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action report_seqSucceeded of state machine Svc_FpySequencer_SequencerStateMachine

reports that a sequence succeeded

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_resetRuntime()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_resetRuntime ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action resetRuntime of state machine Svc_FpySequencer_SequencerStateMachine

resets the sequence runtime

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_sendCmdResponse_EXECUTION_ERROR()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_sendCmdResponse_EXECUTION_ERROR ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action sendCmdResponse_EXECUTION_ERROR of state machine Svc_FpySequencer_SequencerStateMachine

responds to the calling command with EXECUTION_ERROR

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_sendCmdResponse_OK()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_sendCmdResponse_OK ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action sendCmdResponse_OK of state machine Svc_FpySequencer_SequencerStateMachine

responds to the calling command with OK

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_setDebugBreakpoint()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_setDebugBreakpoint ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal, const Svc::FpySequencer_DebugBreakpointArgs &  value  )

protectedpure virtual

Implementation for action setDebugBreakpoint of state machine Svc_FpySequencer_SequencerStateMachine

sets the debug breakpoint to the provided args

Parameters

smId	The state machine id
signal	The signal
value	The value

Svc_FpySequencer_SequencerStateMachine_action_setGoalState_IDLE()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_setGoalState_IDLE ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action setGoalState_IDLE of state machine Svc_FpySequencer_SequencerStateMachine

sets the goal state to IDLE

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_setGoalState_RUNNING()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_setGoalState_RUNNING ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action setGoalState_RUNNING of state machine Svc_FpySequencer_SequencerStateMachine

sets the goal state to RUNNING

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_setGoalState_VALID()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_setGoalState_VALID ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action setGoalState_VALID of state machine Svc_FpySequencer_SequencerStateMachine

sets the goal state to VALID

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_setSequenceBlockState()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_setSequenceBlockState ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal, const Svc::FpySequencer_SequenceExecutionArgs &  value  )

protectedpure virtual

Implementation for action setSequenceBlockState of state machine Svc_FpySequencer_SequencerStateMachine

sets the block state of the sequence to be run

Parameters

smId	The state machine id
signal	The signal
value	The value

Svc_FpySequencer_SequencerStateMachine_action_setSequenceFilePath()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_setSequenceFilePath ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal, const Svc::FpySequencer_SequenceExecutionArgs &  value  )

protectedpure virtual

Implementation for action setSequenceFilePath of state machine Svc_FpySequencer_SequencerStateMachine

sets the current sequence file path member var

Parameters

smId	The state machine id
signal	The signal
value	The value

Svc_FpySequencer_SequencerStateMachine_action_signalEntered()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_signalEntered ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action signalEntered of state machine Svc_FpySequencer_SequencerStateMachine

simply raises the "entered" signal

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_action_validate()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_validate ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  )

protectedpure virtual

Implementation for action validate of state machine Svc_FpySequencer_SequencerStateMachine

performs all steps necessary for sequence validation, and raises a signal result_success or result_failure

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_guard_debugBreakOnce()

virtual bool Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_guard_debugBreakOnce ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  ) const

protectedpure virtual

Implementation for guard debugBreakOnce of state machine Svc_FpySequencer_SequencerStateMachine

return true if this debug breakpoint should only happen once

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_guard_goalStateIs_RUNNING()

virtual bool Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_guard_goalStateIs_RUNNING ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  ) const

protectedpure virtual

Implementation for guard goalStateIs_RUNNING of state machine Svc_FpySequencer_SequencerStateMachine

return true if the goal state is RUNNING

Parameters

smId	The state machine id
signal	The signal

Svc_FpySequencer_SequencerStateMachine_guard_shouldDebugBreak()

virtual bool Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_guard_shouldDebugBreak ( SmId  smId, Svc_FpySequencer_SequencerStateMachine::Signal  signal  ) const

protectedpure virtual

Implementation for guard shouldDebugBreak of state machine Svc_FpySequencer_SequencerStateMachine

return true if should debug break at this point in execution, before dispatching next stmt

Parameters

smId	The state machine id
signal	The signal

tlmWrite_Debug()

void Svc::FpySequencerComponentBase::tlmWrite_Debug ( const Svc::FpySequencer_DebugTelemetry &  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel Debug

debug-only telemetry only updated in the RUNNING.DEBUG_BROKEN state

Parameters

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

Definition at line 6620 of file FpySequencerComponentAc.cpp.

tlmWrite_DebugBreakpointIdx()

void Svc::FpySequencerComponentBase::tlmWrite_DebugBreakpointIdx ( U32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel DebugBreakpointIdx

the current debug breakpoint index

Parameters

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

Definition at line 6572 of file FpySequencerComponentAc.cpp.

tlmWrite_handler()

virtual void Svc::FpySequencerComponentBase::tlmWrite_handler ( FwIndexType  portNum, U32  context  )

protectedpure virtual

Handler for input port tlmWrite.

Parameters

portNum	The port number
context	The call order

Implemented in Svc::FpySequencer.

tlmWrite_handlerBase()

void Svc::FpySequencerComponentBase::tlmWrite_handlerBase ( FwIndexType  portNum, U32  context  )

protected

Handler base-class function for input port tlmWrite.

Parameters

portNum	The port number
context	The call order

Definition at line 1776 of file FpySequencerComponentAc.cpp.

tlmWrite_preMsgHook()

void Svc::FpySequencerComponentBase::tlmWrite_preMsgHook ( FwIndexType  portNum, U32  context  )

protectedvirtual

Pre-message hook for async input port tlmWrite.

Parameters

portNum	The port number
context	The call order

Definition at line 1875 of file FpySequencerComponentAc.cpp.

tlmWrite_SeqPath()

void Svc::FpySequencerComponentBase::tlmWrite_SeqPath ( const Fw::StringBase &  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel SeqPath

the currently running sequence

Parameters

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

Definition at line 6524 of file FpySequencerComponentAc.cpp.

tlmWrite_SequencesCancelled()

void Svc::FpySequencerComponentBase::tlmWrite_SequencesCancelled ( U64  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel SequencesCancelled

the number of sequences that were cancelled

Parameters

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

Definition at line 6380 of file FpySequencerComponentAc.cpp.

tlmWrite_SequencesFailed()

void Svc::FpySequencerComponentBase::tlmWrite_SequencesFailed ( U64  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel SequencesFailed

the number of sequences that failed to validate or execute

Parameters

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

Definition at line 6332 of file FpySequencerComponentAc.cpp.

tlmWrite_SequencesSucceeded()

void Svc::FpySequencerComponentBase::tlmWrite_SequencesSucceeded ( U64  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel SequencesSucceeded

the number of sequences successfully completed

Parameters

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

Definition at line 6284 of file FpySequencerComponentAc.cpp.

tlmWrite_State()

void Svc::FpySequencerComponentBase::tlmWrite_State ( I32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel State

the current state of the sequencer

Parameters

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

Definition at line 6236 of file FpySequencerComponentAc.cpp.

tlmWrite_STATEMENT_TIMEOUT_SECS()

void Svc::FpySequencerComponentBase::tlmWrite_STATEMENT_TIMEOUT_SECS ( F32  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel STATEMENT_TIMEOUT_SECS

value of prm STATEMENT_TIMEOUT_SECS

Parameters

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

Definition at line 6668 of file FpySequencerComponentAc.cpp.

tlmWrite_StatementsDispatched()

void Svc::FpySequencerComponentBase::tlmWrite_StatementsDispatched ( U64  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel StatementsDispatched

the number of statements dispatched (successfully or otherwise) total. Note this is distinct from the number of statements executed. This number just tracks how many we've sent out

Parameters

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

Definition at line 6428 of file FpySequencerComponentAc.cpp.

tlmWrite_StatementsFailed()

void Svc::FpySequencerComponentBase::tlmWrite_StatementsFailed ( U64  arg, Fw::Time  _tlmTime = Fw::Time()  )

protected

Write telemetry channel StatementsFailed

the number of statements that failed to execute

Parameters

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

Definition at line 6476 of file FpySequencerComponentAc.cpp.

VALIDATE_cmdHandler()

virtual void Svc::FpySequencerComponentBase::VALIDATE_cmdHandler ( FwOpcodeType  opCode, U32  cmdSeq, const Fw::CmdStringArg &  fileName  )

protectedpure virtual

Handler for command VALIDATE

Loads and validates a sequence

Parameters

opCode	The opcode
cmdSeq	The command sequence number
fileName	The name of the sequence file

VALIDATE_cmdHandlerBase()

void Svc::FpySequencerComponentBase::VALIDATE_cmdHandlerBase ( FwOpcodeType  opCode, U32  cmdSeq, Fw::CmdArgBuffer &  args  )

protected

Base-class handler function for command VALIDATE

Loads and validates a sequence

Parameters

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

Definition at line 2617 of file FpySequencerComponentAc.cpp.

VALIDATE_preMsgHook()

void Svc::FpySequencerComponentBase::VALIDATE_preMsgHook ( FwOpcodeType  opCode, U32  cmdSeq  )

protectedvirtual

Pre-message hook for command VALIDATE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 3049 of file FpySequencerComponentAc.cpp.

Friends And Related Function Documentation

FpySequencerTester

friend class FpySequencerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 77 of file FpySequencerComponentAc.hpp.

FpySequencerTesterBase

friend class FpySequencerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 75 of file FpySequencerComponentAc.hpp.

---

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

• Svc/FpySequencer/FpySequencerComponentAc.hpp
• Svc/FpySequencer/FpySequencerComponentAc.cpp