F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Svc::FpySequencerComponentBase Class Referenceabstract

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

#include <Svc/FpySequencer/FpySequencerComponentAc.hpp>

Inheritance diagram for Svc::FpySequencerComponentBase:
Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::FpySequencer

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::InputCmdPortget_cmdIn_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_checkTimers_InputPort (FwIndexType portNum)
 
Fw::InputCmdResponsePortget_cmdResponseIn_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_pingIn_InputPort (FwIndexType portNum)
 
Svc::InputCmdSeqInPortget_seqRunIn_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_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 set_seqDoneOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to seqDoneOut[portNum]. More...
 
void set_seqStartOut_OutputPort (FwIndexType portNum, Svc::InputCmdSeqInPort *port)
 Connect port to seqStartOut[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,
  NUM_SEQDONEOUT_OUTPUT_PORTS = 1, NUM_SEQSTARTOUT_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_SET_BREAKPOINT = 0x4, OPCODE_BREAK = 0x5, OPCODE_CONTINUE = 0x6, OPCODE_CLEAR_BREAKPOINT = 0x7,
  OPCODE_STEP = 0x8, OPCODE_STATEMENT_TIMEOUT_SECS_SET = 0x9, OPCODE_STATEMENT_TIMEOUT_SECS_SAVE = 0xa
}
 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_COMMANDFAILED = 0xa, EVENTID_SEQUENCEDONE = 0xb,
  EVENTID_SEQUENCECANCELLED = 0xc, EVENTID_UNKNOWNSEQUENCERDIRECTIVE = 0xd, EVENTID_CMDRESPONSEWHILENOTRUNNINGSEQUENCE = 0xe, EVENTID_CMDRESPONSEFROMOLDSEQUENCE = 0xf,
  EVENTID_CMDRESPONSEWHILENOTAWAITING = 0x10, EVENTID_CMDRESPONSEWHILEAWAITINGDIRECTIVE = 0x11, EVENTID_WRONGCMDRESPONSEOPCODE = 0x12, EVENTID_WRONGCMDRESPONSEINDEX = 0x13,
  EVENTID_DIRECTIVEDESERIALIZEERROR = 0x14, EVENTID_MISMATCHEDTIMEBASE = 0x15, EVENTID_MISMATCHEDTIMECONTEXT = 0x16, EVENTID_COMMANDTIMEDOUT = 0x17,
  EVENTID_DIRECTIVETIMEDOUT = 0x18, EVENTID_TOOMANYSEQUENCEARGS = 0x19, EVENTID_TOOMANYSEQUENCEDIRECTIVES = 0x1a, EVENTID_SEQUENCEPAUSED = 0x1b,
  EVENTID_BREAKPOINTSET = 0x1c, EVENTID_BREAKPOINTCLEARED = 0x1d
}
 Event IDs. More...
 
enum  {
  CHANNELID_STATE = 0x0, CHANNELID_SEQUENCESSUCCEEDED = 0x1, CHANNELID_SEQUENCESFAILED = 0x2, CHANNELID_SEQUENCESCANCELLED = 0x3,
  CHANNELID_STATEMENTSDISPATCHED = 0x4, CHANNELID_STATEMENTSFAILED = 0x5, CHANNELID_LASTDIRECTIVEERROR = 0x6, CHANNELID_DIRECTIVEERRORINDEX = 0x7,
  CHANNELID_DIRECTIVEERRORID = 0x8, CHANNELID_SEQPATH = 0x9, CHANNELID_DEBUG_REACHEDENDOFFILE = 0xa, CHANNELID_DEBUG_NEXTSTATEMENTREADSUCCESS = 0xb,
  CHANNELID_DEBUG_NEXTSTATEMENTOPCODE = 0xc, CHANNELID_DEBUG_NEXTCMDOPCODE = 0xd, CHANNELID_BREAKPOINTINUSE = 0xe, CHANNELID_BREAKPOINTINDEX = 0xf,
  CHANNELID_BREAKONLYONCEONBREAKPOINT = 0x10, CHANNELID_BREAKBEFORENEXTLINE = 0x11, CHANNELID_PRM_STATEMENT_TIMEOUT_SECS = 0x12
}
 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
 
FwIndexType getNum_seqDoneOut_OutputPorts () const
 
FwIndexType getNum_seqStartOut_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)
 
bool isConnected_seqDoneOut_OutputPort (FwIndexType portNum)
 
bool isConnected_seqStartOut_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...
 
void seqDoneOut_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
 Invoke output port seqDoneOut. More...
 
void seqStartOut_out (FwIndexType portNum, const Fw::StringBase &filename)
 Invoke output port seqStartOut. More...
 
virtual void directive_allocate_internalInterfaceHandler (const Svc::FpySequencer_AllocateDirective &directive)=0
 Internal interface handler for directive_allocate. More...
 
virtual void directive_constCmd_internalInterfaceHandler (const Svc::FpySequencer_ConstCmdDirective &directive)=0
 Internal interface handler for directive_constCmd. More...
 
virtual void directive_discard_internalInterfaceHandler (const Svc::FpySequencer_DiscardDirective &directive)=0
 Internal interface handler for directive_discard. More...
 
virtual void directive_exit_internalInterfaceHandler (const Svc::FpySequencer_ExitDirective &directive)=0
 Internal interface handler for directive_exit. 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_load_internalInterfaceHandler (const Svc::FpySequencer_LoadDirective &directive)=0
 Internal interface handler for directive_load. More...
 
virtual void directive_memCmp_internalInterfaceHandler (const Svc::FpySequencer_MemCmpDirective &directive)=0
 Internal interface handler for directive_memCmp. More...
 
virtual void directive_noOp_internalInterfaceHandler (const Svc::FpySequencer_NoOpDirective &directive)=0
 Internal interface handler for directive_noOp. More...
 
virtual void directive_pushTime_internalInterfaceHandler (const Svc::FpySequencer_PushTimeDirective &directive)=0
 Internal interface handler for directive_pushTime. More...
 
virtual void directive_pushTlmValAndTime_internalInterfaceHandler (const Svc::FpySequencer_PushTlmValAndTimeDirective &directive)=0
 Internal interface handler for directive_pushTlmValAndTime. More...
 
virtual void directive_pushVal_internalInterfaceHandler (const Svc::FpySequencer_PushValDirective &directive)=0
 Internal interface handler for directive_pushVal. More...
 
virtual void directive_stackCmd_internalInterfaceHandler (const Svc::FpySequencer_StackCmdDirective &directive)=0
 Internal interface handler for directive_stackCmd. More...
 
virtual void directive_stackOp_internalInterfaceHandler (const Svc::FpySequencer_StackOpDirective &directive)=0
 Internal interface handler for directive_stackOp. More...
 
virtual void directive_store_internalInterfaceHandler (const Svc::FpySequencer_StoreDirective &directive)=0
 Internal interface handler for directive_store. More...
 
virtual void directive_storePrm_internalInterfaceHandler (const Svc::FpySequencer_StorePrmDirective &directive)=0
 Internal interface handler for directive_storePrm. More...
 
virtual void directive_storeTlmVal_internalInterfaceHandler (const Svc::FpySequencer_StoreTlmValDirective &directive)=0
 Internal interface handler for directive_storeTlmVal. 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_allocate_internalInterfaceInvoke (const Svc::FpySequencer_AllocateDirective &directive)
 Internal interface base-class function for directive_allocate. More...
 
void directive_constCmd_internalInterfaceInvoke (const Svc::FpySequencer_ConstCmdDirective &directive)
 Internal interface base-class function for directive_constCmd. More...
 
void directive_discard_internalInterfaceInvoke (const Svc::FpySequencer_DiscardDirective &directive)
 Internal interface base-class function for directive_discard. More...
 
void directive_exit_internalInterfaceInvoke (const Svc::FpySequencer_ExitDirective &directive)
 Internal interface base-class function for directive_exit. 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_load_internalInterfaceInvoke (const Svc::FpySequencer_LoadDirective &directive)
 Internal interface base-class function for directive_load. More...
 
void directive_memCmp_internalInterfaceInvoke (const Svc::FpySequencer_MemCmpDirective &directive)
 Internal interface base-class function for directive_memCmp. More...
 
void directive_noOp_internalInterfaceInvoke (const Svc::FpySequencer_NoOpDirective &directive)
 Internal interface base-class function for directive_noOp. More...
 
void directive_pushTime_internalInterfaceInvoke (const Svc::FpySequencer_PushTimeDirective &directive)
 Internal interface base-class function for directive_pushTime. More...
 
void directive_pushTlmValAndTime_internalInterfaceInvoke (const Svc::FpySequencer_PushTlmValAndTimeDirective &directive)
 Internal interface base-class function for directive_pushTlmValAndTime. More...
 
void directive_pushVal_internalInterfaceInvoke (const Svc::FpySequencer_PushValDirective &directive)
 Internal interface base-class function for directive_pushVal. More...
 
void directive_stackCmd_internalInterfaceInvoke (const Svc::FpySequencer_StackCmdDirective &directive)
 Internal interface base-class function for directive_stackCmd. More...
 
void directive_stackOp_internalInterfaceInvoke (const Svc::FpySequencer_StackOpDirective &directive)
 Internal interface base-class function for directive_stackOp. More...
 
void directive_store_internalInterfaceInvoke (const Svc::FpySequencer_StoreDirective &directive)
 Internal interface base-class function for directive_store. More...
 
void directive_storePrm_internalInterfaceInvoke (const Svc::FpySequencer_StorePrmDirective &directive)
 Internal interface base-class function for directive_storePrm. More...
 
void directive_storeTlmVal_internalInterfaceInvoke (const Svc::FpySequencer_StoreTlmValDirective &directive)
 Internal interface base-class function for directive_storeTlmVal. 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_SET_BREAKPOINT (const Svc::FpySequencer_BreakpointArgs &value)
 Send signal cmd_SET_BREAKPOINT to state machine sequencer. More...
 
void sequencer_sendSignal_cmd_CLEAR_BREAKPOINT ()
 Send signal cmd_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_stmtResponse_keepWaiting ()
 Send signal stmtResponse_keepWaiting 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_CONTINUE ()
 Send signal cmd_CONTINUE to state machine sequencer. More...
 
void sequencer_sendSignal_cmd_BREAK ()
 Send signal cmd_BREAK to state machine sequencer. More...
 
void sequencer_sendSignal_cmd_STEP ()
 Send signal cmd_STEP 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_report_seqFailed (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
 
virtual void Svc_FpySequencer_SequencerStateMachine_action_report_seqStarted (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_clearBreakpoint (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_seqBroken (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
 
virtual void Svc_FpySequencer_SequencerStateMachine_action_setBreakpoint (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal, const Svc::FpySequencer_BreakpointArgs &value)=0
 
virtual void Svc_FpySequencer_SequencerStateMachine_action_setBreakBeforeNextLine (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
 
virtual void Svc_FpySequencer_SequencerStateMachine_action_clearBreakBeforeNextLine (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal)=0
 
virtual bool Svc_FpySequencer_SequencerStateMachine_guard_goalStateIs_RUNNING (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const =0
 
virtual bool Svc_FpySequencer_SequencerStateMachine_guard_shouldBreak (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const =0
 
virtual bool Svc_FpySequencer_SequencerStateMachine_guard_breakOnce (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 SET_BREAKPOINT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 stmtIdx, bool breakOnce)=0
 
virtual void BREAK_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
 
virtual void CONTINUE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
 
virtual void CLEAR_BREAKPOINT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
 
virtual void STEP_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 SET_BREAKPOINT_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void BREAK_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void CONTINUE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void CLEAR_BREAKPOINT_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void STEP_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 SET_BREAKPOINT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command SET_BREAKPOINT. More...
 
virtual void BREAK_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command BREAK. More...
 
virtual void CONTINUE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command CONTINUE. More...
 
virtual void CLEAR_BREAKPOINT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command CLEAR_BREAKPOINT. More...
 
virtual void STEP_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command STEP. 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 (Svc::FpySequencer_FileReadStage readStage, const Fw::StringBase &filePath, I32 errorCode) const
 Log event FileReadError. More...
 
void log_WARNING_HI_EndOfFileError (Svc::FpySequencer_FileReadStage readStage, const Fw::StringBase &filePath) const
 Log event EndOfFileError. More...
 
void log_WARNING_HI_FileReadDeserializeError (Svc::FpySequencer_FileReadStage readStage, 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 (FwSizeType 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_CommandFailed (FwOpcodeType opCode, U32 stmtIdx, const Fw::StringBase &filePath, Fw::CmdResponse response) const
 Log event CommandFailed. 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 (U8 opcode, U32 stmtIdx, const Fw::StringBase &filePath) const
 Log event UnknownSequencerDirective. 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_CmdResponseWhileAwaitingDirective (FwOpcodeType opcode, Fw::CmdResponse response, U8 expectedDirectiveOpcode) const
 Log event CmdResponseWhileAwaitingDirective. 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 (U8 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_CommandTimedOut (FwOpcodeType opCode, U32 stmtIdx, const Fw::StringBase &filePath) const
 Log event CommandTimedOut. More...
 
void log_WARNING_HI_DirectiveTimedOut (U8 opCode, U32 stmtIdx, const Fw::StringBase &filePath) const
 Log event DirectiveTimedOut. More...
 
void log_WARNING_HI_TooManySequenceArgs (U8 count, U8 max) const
 Log event TooManySequenceArgs. More...
 
void log_WARNING_HI_TooManySequenceDirectives (U16 count, U16 max) const
 Log event TooManySequenceDirectives. More...
 
void log_ACTIVITY_HI_SequencePaused (U32 stmtIdx) const
 Log event SequencePaused. More...
 
void log_ACTIVITY_HI_BreakpointSet (U32 breakpointIdx, bool breakOnce) const
 Log event BreakpointSet. More...
 
void log_ACTIVITY_HI_BreakpointCleared () const
 Log event BreakpointCleared. More...
 
void tlmWrite_State (FwEnumStoreType 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_LastDirectiveError (const Svc::FpySequencer_DirectiveErrorCode &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_DirectiveErrorIndex (U64 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_DirectiveErrorId (const Svc::Fpy::DirectiveId &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_SeqPath (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Debug_ReachedEndOfFile (bool arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_Debug_NextStatementReadSuccess (bool arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_Debug_NextStatementOpcode (U8 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Debug_NextCmdOpcode (FwOpcodeType arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_BreakpointInUse (bool arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_BreakpointIndex (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_BreakOnlyOnceOnBreakpoint (bool arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_BreakBeforeNextLine (bool arg, Fw::Time _tlmTime=Fw::Time()) const
 
void tlmWrite_PRM_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 78 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 98 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 103 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 112 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 
NUM_SEQDONEOUT_OUTPUT_PORTS 
NUM_SEQSTARTOUT_OUTPUT_PORTS 

Definition at line 124 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_SET_BREAKPOINT 

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

OPCODE_BREAK 

Pauses the execution of the sequencer, just before it is about to dispatch the next directive, until unpaused by the CONTINUE command, or stepped by the STEP command. This command is only valid substates of the RUNNING state that are not RUNNING.PAUSED.

OPCODE_CONTINUE 

Continues the automatic execution of the sequence after it has been paused. If a breakpoint is still set, it may pause again on that breakpoint. This command is only valid in the RUNNING.PAUSED state.

OPCODE_CLEAR_BREAKPOINT 

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

OPCODE_STEP 

Dispatches and awaits the result of the next directive, or ends the sequence if no more directives remain. Returns to the RUNNING.PAUSED state if the directive executes successfully. This command is only valid in the RUNNING.PAUSED state.

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 134 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_COMMANDFAILED 
EVENTID_SEQUENCEDONE 
EVENTID_SEQUENCECANCELLED 
EVENTID_UNKNOWNSEQUENCERDIRECTIVE 
EVENTID_CMDRESPONSEWHILENOTRUNNINGSEQUENCE 
EVENTID_CMDRESPONSEFROMOLDSEQUENCE 
EVENTID_CMDRESPONSEWHILENOTAWAITING 
EVENTID_CMDRESPONSEWHILEAWAITINGDIRECTIVE 
EVENTID_WRONGCMDRESPONSEOPCODE 
EVENTID_WRONGCMDRESPONSEINDEX 
EVENTID_DIRECTIVEDESERIALIZEERROR 
EVENTID_MISMATCHEDTIMEBASE 
EVENTID_MISMATCHEDTIMECONTEXT 
EVENTID_COMMANDTIMEDOUT 
EVENTID_DIRECTIVETIMEDOUT 
EVENTID_TOOMANYSEQUENCEARGS 
EVENTID_TOOMANYSEQUENCEDIRECTIVES 
EVENTID_SEQUENCEPAUSED 
EVENTID_BREAKPOINTSET 
EVENTID_BREAKPOINTCLEARED 

Definition at line 158 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_LASTDIRECTIVEERROR 

Channel ID for LastDirectiveError.

CHANNELID_DIRECTIVEERRORINDEX 

Channel ID for DirectiveErrorIndex.

CHANNELID_DIRECTIVEERRORID 

Channel ID for DirectiveErrorId.

CHANNELID_SEQPATH 

Channel ID for SeqPath.

CHANNELID_DEBUG_REACHEDENDOFFILE 

Channel ID for Debug_ReachedEndOfFile.

CHANNELID_DEBUG_NEXTSTATEMENTREADSUCCESS 

Channel ID for Debug_NextStatementReadSuccess.

CHANNELID_DEBUG_NEXTSTATEMENTOPCODE 

Channel ID for Debug_NextStatementOpcode.

CHANNELID_DEBUG_NEXTCMDOPCODE 

Channel ID for Debug_NextCmdOpcode.

CHANNELID_BREAKPOINTINUSE 

Channel ID for BreakpointInUse.

CHANNELID_BREAKPOINTINDEX 

Channel ID for BreakpointIndex.

CHANNELID_BREAKONLYONCEONBREAKPOINT 

Channel ID for BreakOnlyOnceOnBreakpoint.

CHANNELID_BREAKBEFORENEXTLINE 

Channel ID for BreakBeforeNextLine.

CHANNELID_PRM_STATEMENT_TIMEOUT_SECS 

Channel ID for PRM_STATEMENT_TIMEOUT_SECS.

Definition at line 192 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 215 of file FpySequencerComponentAc.hpp.

◆ SmId

State machine identifiers.

Enumerator
sequencer 

Definition at line 223 of file FpySequencerComponentAc.hpp.

Constructor & Destructor Documentation

◆ FpySequencerComponentBase()

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

Construct FpySequencerComponentBase object.

Parameters
compNameThe component name

Definition at line 1394 of file FpySequencerComponentAc.cpp.

◆ ~FpySequencerComponentBase()

Svc::FpySequencerComponentBase::~FpySequencerComponentBase ( )
protectedvirtual

Destroy FpySequencerComponentBase object.

Definition at line 1455 of file FpySequencerComponentAc.cpp.

Member Function Documentation

◆ BREAK_cmdHandler()

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

Handler for command BREAK

Pauses the execution of the sequencer, just before it is about to dispatch the next directive, until unpaused by the CONTINUE command, or stepped by the STEP command. This command is only valid substates of the RUNNING state that are not RUNNING.PAUSED.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ BREAK_cmdHandlerBase()

void Svc::FpySequencerComponentBase::BREAK_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command BREAK

Pauses the execution of the sequencer, just before it is about to dispatch the next directive, until unpaused by the CONTINUE command, or stepped by the STEP command. This command is only valid substates of the RUNNING state that are not RUNNING.PAUSED.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3537 of file FpySequencerComponentAc.cpp.

◆ BREAK_preMsgHook()

void Svc::FpySequencerComponentBase::BREAK_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command BREAK.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3836 of file FpySequencerComponentAc.cpp.

◆ 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
opCodeThe opcode
cmdSeqThe 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
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3419 of file FpySequencerComponentAc.cpp.

◆ CANCEL_preMsgHook()

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

Pre-message hook for command CANCEL.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3814 of file FpySequencerComponentAc.cpp.

◆ checkTimers_handler()

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

Handler for input port checkTimers.

Parameters
portNumThe port number
contextThe 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
portNumThe port number
contextThe call order

Definition at line 1773 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
portNumThe port number
contextThe call order

Definition at line 2064 of file FpySequencerComponentAc.cpp.

◆ CLEAR_BREAKPOINT_cmdHandler()

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

Handler for command CLEAR_BREAKPOINT

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

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ CLEAR_BREAKPOINT_cmdHandlerBase()

void Svc::FpySequencerComponentBase::CLEAR_BREAKPOINT_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command CLEAR_BREAKPOINT

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

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3655 of file FpySequencerComponentAc.cpp.

◆ CLEAR_BREAKPOINT_preMsgHook()

void Svc::FpySequencerComponentBase::CLEAR_BREAKPOINT_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command CLEAR_BREAKPOINT.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3858 of file FpySequencerComponentAc.cpp.

◆ cmdOut_out()

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

Invoke output port cmdOut.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 2115 of file FpySequencerComponentAc.cpp.

◆ cmdResponse_out()

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

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 3225 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
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe 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
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

Definition at line 1826 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
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

Definition at line 2073 of file FpySequencerComponentAc.cpp.

◆ CONTINUE_cmdHandler()

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

Handler for command CONTINUE

Continues the automatic execution of the sequence after it has been paused. If a breakpoint is still set, it may pause again on that breakpoint. This command is only valid in the RUNNING.PAUSED state.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ CONTINUE_cmdHandlerBase()

void Svc::FpySequencerComponentBase::CONTINUE_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command CONTINUE

Continues the automatic execution of the sequence after it has been paused. If a breakpoint is still set, it may pause again on that breakpoint. This command is only valid in the RUNNING.PAUSED state.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3596 of file FpySequencerComponentAc.cpp.

◆ CONTINUE_preMsgHook()

void Svc::FpySequencerComponentBase::CONTINUE_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command CONTINUE.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3847 of file FpySequencerComponentAc.cpp.

◆ directive_allocate_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_allocate_internalInterfaceHandler ( const Svc::FpySequencer_AllocateDirective directive)
protectedpure virtual

Internal interface handler for directive_allocate.

Implemented in Svc::FpySequencer.

◆ directive_allocate_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_allocate_internalInterfaceInvoke ( const Svc::FpySequencer_AllocateDirective directive)
protected

Internal interface base-class function for directive_allocate.

Definition at line 2251 of file FpySequencerComponentAc.cpp.

◆ directive_constCmd_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_constCmd_internalInterfaceHandler ( const Svc::FpySequencer_ConstCmdDirective directive)
protectedpure virtual

Internal interface handler for directive_constCmd.

Implemented in Svc::FpySequencer.

◆ directive_constCmd_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_constCmd_internalInterfaceInvoke ( const Svc::FpySequencer_ConstCmdDirective directive)
protected

Internal interface base-class function for directive_constCmd.

Definition at line 2287 of file FpySequencerComponentAc.cpp.

◆ directive_discard_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_discard_internalInterfaceHandler ( const Svc::FpySequencer_DiscardDirective directive)
protectedpure virtual

Internal interface handler for directive_discard.

Implemented in Svc::FpySequencer.

◆ directive_discard_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_discard_internalInterfaceInvoke ( const Svc::FpySequencer_DiscardDirective directive)
protected

Internal interface base-class function for directive_discard.

Definition at line 2323 of file FpySequencerComponentAc.cpp.

◆ directive_exit_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_exit_internalInterfaceHandler ( const Svc::FpySequencer_ExitDirective directive)
protectedpure virtual

Internal interface handler for directive_exit.

Implemented in Svc::FpySequencer.

◆ directive_exit_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_exit_internalInterfaceInvoke ( const Svc::FpySequencer_ExitDirective directive)
protected

Internal interface base-class function for directive_exit.

Definition at line 2359 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 2395 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 2431 of file FpySequencerComponentAc.cpp.

◆ directive_load_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_load_internalInterfaceHandler ( const Svc::FpySequencer_LoadDirective directive)
protectedpure virtual

Internal interface handler for directive_load.

Implemented in Svc::FpySequencer.

◆ directive_load_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_load_internalInterfaceInvoke ( const Svc::FpySequencer_LoadDirective directive)
protected

Internal interface base-class function for directive_load.

Definition at line 2467 of file FpySequencerComponentAc.cpp.

◆ directive_memCmp_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_memCmp_internalInterfaceHandler ( const Svc::FpySequencer_MemCmpDirective directive)
protectedpure virtual

Internal interface handler for directive_memCmp.

Implemented in Svc::FpySequencer.

◆ directive_memCmp_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_memCmp_internalInterfaceInvoke ( const Svc::FpySequencer_MemCmpDirective directive)
protected

Internal interface base-class function for directive_memCmp.

Definition at line 2503 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 2539 of file FpySequencerComponentAc.cpp.

◆ directive_pushTime_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_pushTime_internalInterfaceHandler ( const Svc::FpySequencer_PushTimeDirective directive)
protectedpure virtual

Internal interface handler for directive_pushTime.

Implemented in Svc::FpySequencer.

◆ directive_pushTime_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_pushTime_internalInterfaceInvoke ( const Svc::FpySequencer_PushTimeDirective directive)
protected

Internal interface base-class function for directive_pushTime.

Definition at line 2575 of file FpySequencerComponentAc.cpp.

◆ directive_pushTlmValAndTime_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_pushTlmValAndTime_internalInterfaceHandler ( const Svc::FpySequencer_PushTlmValAndTimeDirective directive)
protectedpure virtual

Internal interface handler for directive_pushTlmValAndTime.

Implemented in Svc::FpySequencer.

◆ directive_pushTlmValAndTime_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_pushTlmValAndTime_internalInterfaceInvoke ( const Svc::FpySequencer_PushTlmValAndTimeDirective directive)
protected

Internal interface base-class function for directive_pushTlmValAndTime.

Definition at line 2611 of file FpySequencerComponentAc.cpp.

◆ directive_pushVal_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_pushVal_internalInterfaceHandler ( const Svc::FpySequencer_PushValDirective directive)
protectedpure virtual

Internal interface handler for directive_pushVal.

Implemented in Svc::FpySequencer.

◆ directive_pushVal_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_pushVal_internalInterfaceInvoke ( const Svc::FpySequencer_PushValDirective directive)
protected

Internal interface base-class function for directive_pushVal.

Definition at line 2647 of file FpySequencerComponentAc.cpp.

◆ directive_stackCmd_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_stackCmd_internalInterfaceHandler ( const Svc::FpySequencer_StackCmdDirective directive)
protectedpure virtual

Internal interface handler for directive_stackCmd.

Implemented in Svc::FpySequencer.

◆ directive_stackCmd_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_stackCmd_internalInterfaceInvoke ( const Svc::FpySequencer_StackCmdDirective directive)
protected

Internal interface base-class function for directive_stackCmd.

Definition at line 2683 of file FpySequencerComponentAc.cpp.

◆ directive_stackOp_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_stackOp_internalInterfaceHandler ( const Svc::FpySequencer_StackOpDirective directive)
protectedpure virtual

Internal interface handler for directive_stackOp.

Implemented in Svc::FpySequencer.

◆ directive_stackOp_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_stackOp_internalInterfaceInvoke ( const Svc::FpySequencer_StackOpDirective directive)
protected

Internal interface base-class function for directive_stackOp.

Definition at line 2719 of file FpySequencerComponentAc.cpp.

◆ directive_store_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_store_internalInterfaceHandler ( const Svc::FpySequencer_StoreDirective directive)
protectedpure virtual

Internal interface handler for directive_store.

Implemented in Svc::FpySequencer.

◆ directive_store_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_store_internalInterfaceInvoke ( const Svc::FpySequencer_StoreDirective directive)
protected

Internal interface base-class function for directive_store.

Definition at line 2755 of file FpySequencerComponentAc.cpp.

◆ directive_storePrm_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_storePrm_internalInterfaceHandler ( const Svc::FpySequencer_StorePrmDirective directive)
protectedpure virtual

Internal interface handler for directive_storePrm.

Implemented in Svc::FpySequencer.

◆ directive_storePrm_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_storePrm_internalInterfaceInvoke ( const Svc::FpySequencer_StorePrmDirective directive)
protected

Internal interface base-class function for directive_storePrm.

Definition at line 2791 of file FpySequencerComponentAc.cpp.

◆ directive_storeTlmVal_internalInterfaceHandler()

virtual void Svc::FpySequencerComponentBase::directive_storeTlmVal_internalInterfaceHandler ( const Svc::FpySequencer_StoreTlmValDirective directive)
protectedpure virtual

Internal interface handler for directive_storeTlmVal.

Implemented in Svc::FpySequencer.

◆ directive_storeTlmVal_internalInterfaceInvoke()

void Svc::FpySequencerComponentBase::directive_storeTlmVal_internalInterfaceInvoke ( const Svc::FpySequencer_StoreTlmValDirective directive)
protected

Internal interface base-class function for directive_storeTlmVal.

Definition at line 2827 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 2863 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 2899 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
portNumThe port number

Definition at line 852 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
portNumThe port number

Definition at line 837 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
portNumThe port number

Definition at line 863 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
portNumThe port number

Definition at line 874 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
portNumThe port number

Definition at line 885 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
portNumThe port number

Definition at line 896 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 1475 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 1465 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 1565 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 1509 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 1481 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 1515 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 1571 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 1577 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 1521 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 1487 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 1583 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 1537 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 1543 of file FpySequencerComponentAc.cpp.

◆ getNum_seqDoneOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_seqDoneOut_OutputPorts ( ) const
protected

Get the number of seqDoneOut output ports

Returns
The number of seqDoneOut output ports

Definition at line 1589 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 1493 of file FpySequencerComponentAc.cpp.

◆ getNum_seqStartOut_OutputPorts()

FwIndexType Svc::FpySequencerComponentBase::getNum_seqStartOut_OutputPorts ( ) const
protected

Get the number of seqStartOut output ports

Returns
The number of seqStartOut output ports

Definition at line 1595 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 1549 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 1555 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 1499 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
portNumThe port number
idParameter ID
valBuffer containing serialized parameter value. Unmodified if param not found.

Definition at line 2137 of file FpySequencerComponentAc.cpp.

◆ getTime()

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

Get the time

\return The current time

Definition at line 7925 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
portNumThe port number
idTelemetry Channel ID
timeTagTime Tag
valBuffer 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 2159 of file FpySequencerComponentAc.cpp.

◆ init()

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

Initialize FpySequencerComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 398 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
portNumThe port number

Definition at line 1701 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
portNumThe port number

Definition at line 1605 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
portNumThe port number

Definition at line 1616 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
portNumThe port number

Definition at line 1712 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
portNumThe port number

Definition at line 1723 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
portNumThe port number

Definition at line 1627 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
portNumThe port number

Definition at line 1734 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
portNumThe port number

Definition at line 1653 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
portNumThe port number

Definition at line 1664 of file FpySequencerComponentAc.cpp.

◆ isConnected_seqDoneOut_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_seqDoneOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port seqDoneOut is connected

Returns
Whether port seqDoneOut is connected
Parameters
portNumThe port number

Definition at line 1745 of file FpySequencerComponentAc.cpp.

◆ isConnected_seqStartOut_OutputPort()

bool Svc::FpySequencerComponentBase::isConnected_seqStartOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port seqStartOut is connected

Returns
Whether port seqStartOut is connected
Parameters
portNumThe port number

Definition at line 1756 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
portNumThe port number

Definition at line 1675 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
portNumThe port number

Definition at line 1686 of file FpySequencerComponentAc.cpp.

◆ loadParameters()

void Svc::FpySequencerComponentBase::loadParameters ( )

Load the parameters from a parameter source.

Connect the parameter first

Definition at line 1347 of file FpySequencerComponentAc.cpp.

◆ log_ACTIVITY_HI_BreakpointCleared()

void Svc::FpySequencerComponentBase::log_ACTIVITY_HI_BreakpointCleared ( ) const
protected

Log event BreakpointCleared.

Definition at line 6984 of file FpySequencerComponentAc.cpp.

◆ log_ACTIVITY_HI_BreakpointSet()

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

Log event BreakpointSet.

Definition at line 6882 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 5078 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 5006 of file FpySequencerComponentAc.cpp.

◆ log_ACTIVITY_HI_SequencePaused()

void Svc::FpySequencerComponentBase::log_ACTIVITY_HI_SequencePaused ( U32  stmtIdx) const
protected

Log event SequencePaused.

Definition at line 6800 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_CmdResponseWhileAwaitingDirective()

void Svc::FpySequencerComponentBase::log_WARNING_HI_CmdResponseWhileAwaitingDirective ( FwOpcodeType  opcode,
Fw::CmdResponse  response,
U8  expectedDirectiveOpcode 
) const
protected

Log event CmdResponseWhileAwaitingDirective.

Definition at line 5629 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 5524 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_CommandFailed()

void Svc::FpySequencerComponentBase::log_WARNING_HI_CommandFailed ( FwOpcodeType  opCode,
U32  stmtIdx,
const Fw::StringBase filePath,
Fw::CmdResponse  response 
) const
protected

Log event CommandFailed.

Definition at line 4875 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_CommandTimedOut()

void Svc::FpySequencerComponentBase::log_WARNING_HI_CommandTimedOut ( FwOpcodeType  opCode,
U32  stmtIdx,
const Fw::StringBase filePath 
) const
protected

Log event CommandTimedOut.

Definition at line 6376 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_DirectiveDeserializeError()

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

Log event DirectiveDeserializeError.

Definition at line 6016 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_DirectiveTimedOut()

void Svc::FpySequencerComponentBase::log_WARNING_HI_DirectiveTimedOut ( U8  opCode,
U32  stmtIdx,
const Fw::StringBase filePath 
) const
protected

Log event DirectiveTimedOut.

Definition at line 6486 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_EndOfFileError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_EndOfFileError ( Svc::FpySequencer_FileReadStage  readStage,
const Fw::StringBase filePath 
) const
protected

Log event EndOfFileError.

Definition at line 4253 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_ExtraBytesInSequence()

void Svc::FpySequencerComponentBase::log_WARNING_HI_ExtraBytesInSequence ( FwSizeType  remaining) const
protected

Log event ExtraBytesInSequence.

Definition at line 4701 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 4048 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_FileReadDeserializeError()

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

Log event FileReadDeserializeError.

Definition at line 4348 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_FileReadError()

void Svc::FpySequencerComponentBase::log_WARNING_HI_FileReadError ( Svc::FpySequencer_FileReadStage  readStage,
const Fw::StringBase filePath,
I32  errorCode 
) const
protected

Log event FileReadError.

Definition at line 4140 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 4783 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 3884 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 3966 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 6172 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 6274 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 6596 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_TooManySequenceDirectives()

void Svc::FpySequencerComponentBase::log_WARNING_HI_TooManySequenceDirectives ( U16  count,
U16  max 
) const
protected

Log event TooManySequenceDirectives.

Definition at line 6698 of file FpySequencerComponentAc.cpp.

◆ log_WARNING_HI_UnknownSequencerDirective()

void Svc::FpySequencerComponentBase::log_WARNING_HI_UnknownSequencerDirective ( U8  opcode,
U32  stmtIdx,
const Fw::StringBase filePath 
) const
protected

Log event UnknownSequencerDirective.

Definition at line 5150 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 5875 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 5752 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 4599 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 4497 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 5383 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 5260 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 7900 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
idThe parameter ID

Reimplemented in Svc::FpySequencer.

Definition at line 7894 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
validWhether the parameter is valid

Definition at line 7910 of file FpySequencerComponentAc.cpp.

◆ pingIn_handler()

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

Handler for input port pingIn.

Parameters
portNumThe port number
keyValue 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
portNumThe port number
keyValue to return to pinger

Definition at line 1897 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
portNumThe port number
keyValue to return to pinger

Definition at line 2084 of file FpySequencerComponentAc.cpp.

◆ pingOut_out()

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

Invoke output port pingOut.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 2183 of file FpySequencerComponentAc.cpp.

◆ regCommands()

void Svc::FpySequencerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 1293 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
opCodeThe opcode
cmdSeqThe command sequence number
fileNameThe name of the sequence file
blockReturn 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
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3242 of file FpySequencerComponentAc.cpp.

◆ RUN_preMsgHook()

void Svc::FpySequencerComponentBase::RUN_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command RUN.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3781 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
opCodeThe opcode
cmdSeqThe command sequence number
blockReturn 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
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3360 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
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3803 of file FpySequencerComponentAc.cpp.

◆ seqDoneOut_out()

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

Invoke output port seqDoneOut.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

Definition at line 2203 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
portNumThe port number
filenameThe 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
portNumThe port number
filenameThe sequence file

Definition at line 1950 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
portNumThe port number
filenameThe sequence file

Definition at line 2093 of file FpySequencerComponentAc.cpp.

◆ seqStartOut_out()

void Svc::FpySequencerComponentBase::seqStartOut_out ( FwIndexType  portNum,
const Fw::StringBase filename 
)
protected

Invoke output port seqStartOut.

Parameters
portNumThe port number
filenameThe sequence file

Definition at line 2227 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 2939 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_checkTimersIn()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_checkTimersIn ( )
protected

Send signal checkTimersIn to state machine sequencer.

Definition at line 3081 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_cmd_BREAK()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_BREAK ( )
protected

Send signal cmd_BREAK to state machine sequencer.

Definition at line 3201 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 2988 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_cmd_CLEAR_BREAKPOINT()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_CLEAR_BREAKPOINT ( )
protected

Send signal cmd_CLEAR_BREAKPOINT to state machine sequencer.

Definition at line 3011 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_cmd_CONTINUE()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_CONTINUE ( )
protected

Send signal cmd_CONTINUE to state machine sequencer.

Definition at line 3191 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
valueThe value

Definition at line 2962 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
valueThe value

Definition at line 2975 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_cmd_SET_BREAKPOINT()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_SET_BREAKPOINT ( const Svc::FpySequencer_BreakpointArgs value)
protected

Send signal cmd_SET_BREAKPOINT to state machine sequencer.

Parameters
valueThe value

Definition at line 2998 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_cmd_STEP()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_cmd_STEP ( )
protected

Send signal cmd_STEP to state machine sequencer.

Definition at line 3211 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
valueThe value

Definition at line 2949 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_entered()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_entered ( )
protected

Send signal entered to state machine sequencer.

Definition at line 3041 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 3101 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 3091 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 3181 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 3171 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 3061 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 3071 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 3051 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 3021 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 3031 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 3111 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 3121 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 3141 of file FpySequencerComponentAc.cpp.

◆ sequencer_sendSignal_stmtResponse_keepWaiting()

void Svc::FpySequencerComponentBase::sequencer_sendSignal_stmtResponse_keepWaiting ( )
protected

Send signal stmtResponse_keepWaiting to state machine sequencer.

Definition at line 3161 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 3131 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 3151 of file FpySequencerComponentAc.cpp.

◆ SET_BREAKPOINT_cmdHandler()

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

Handler for command SET_BREAKPOINT

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

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
stmtIdxThe directive index to pause execution before.
breakOnceWhether or not to break only once at this breakpoint

◆ SET_BREAKPOINT_cmdHandlerBase()

void Svc::FpySequencerComponentBase::SET_BREAKPOINT_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command SET_BREAKPOINT

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

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3478 of file FpySequencerComponentAc.cpp.

◆ SET_BREAKPOINT_preMsgHook()

void Svc::FpySequencerComponentBase::SET_BREAKPOINT_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command SET_BREAKPOINT.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3825 of file FpySequencerComponentAc.cpp.

◆ set_cmdOut_OutputPort()

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

Connect port to cmdOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 1031 of file FpySequencerComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

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

Connect port to cmdRegOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 911 of file FpySequencerComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

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

Connect port to cmdResponseOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 925 of file FpySequencerComponentAc.cpp.

◆ set_getParam_OutputPort()

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

Connect port to getParam[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 1045 of file FpySequencerComponentAc.cpp.

◆ set_getTlmChan_OutputPort()

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

Connect port to getTlmChan[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 1059 of file FpySequencerComponentAc.cpp.

◆ set_logOut_OutputPort()

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

Connect port to logOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 939 of file FpySequencerComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 1073 of file FpySequencerComponentAc.cpp.

◆ set_prmGet_OutputPort()

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

Connect port to prmGet[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 971 of file FpySequencerComponentAc.cpp.

◆ set_prmSet_OutputPort()

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

Connect port to prmSet[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 985 of file FpySequencerComponentAc.cpp.

◆ set_seqDoneOut_OutputPort()

void Svc::FpySequencerComponentBase::set_seqDoneOut_OutputPort ( FwIndexType  portNum,
Fw::InputCmdResponsePort port 
)

Connect port to seqDoneOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 1087 of file FpySequencerComponentAc.cpp.

◆ set_seqStartOut_OutputPort()

void Svc::FpySequencerComponentBase::set_seqStartOut_OutputPort ( FwIndexType  portNum,
Svc::InputCmdSeqInPort port 
)

Connect port to seqStartOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 1101 of file FpySequencerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

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

Connect port to timeCaller[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 999 of file FpySequencerComponentAc.cpp.

◆ set_tlmOut_OutputPort()

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

Connect port to tlmOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 1013 of file FpySequencerComponentAc.cpp.

◆ STEP_cmdHandler()

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

Handler for command STEP

Dispatches and awaits the result of the next directive, or ends the sequence if no more directives remain. Returns to the RUNNING.PAUSED state if the directive executes successfully. This command is only valid in the RUNNING.PAUSED state.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ STEP_cmdHandlerBase()

void Svc::FpySequencerComponentBase::STEP_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command STEP

Dispatches and awaits the result of the next directive, or ends the sequence if no more directives remain. Returns to the RUNNING.PAUSED state if the directive executes successfully. This command is only valid in the RUNNING.PAUSED state.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3714 of file FpySequencerComponentAc.cpp.

◆ STEP_preMsgHook()

void Svc::FpySequencerComponentBase::STEP_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command STEP.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3869 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_action_clearBreakBeforeNextLine()

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

Implementation for action clearBreakBeforeNextLine of state machine Svc_FpySequencer_SequencerStateMachine

sets the "break on next line" flag to false

Parameters
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_action_clearBreakpoint()

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

Implementation for action clearBreakpoint of state machine Svc_FpySequencer_SequencerStateMachine

clears the breakpoint setting

Parameters
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_action_report_seqBroken()

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

Implementation for action report_seqBroken of state machine Svc_FpySequencer_SequencerStateMachine

reports that a breakpoint was hit

Parameters
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_action_report_seqFailed()

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

Implementation for action report_seqFailed of state machine Svc_FpySequencer_SequencerStateMachine

called when a sequence failed to execute successfully

Parameters
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_action_report_seqStarted()

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

Implementation for action report_seqStarted of state machine Svc_FpySequencer_SequencerStateMachine

called when a sequence starts

Parameters
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_action_setBreakBeforeNextLine()

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

Implementation for action setBreakBeforeNextLine of state machine Svc_FpySequencer_SequencerStateMachine

sets the "break on next line" flag to true

Parameters
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_action_setBreakpoint()

virtual void Svc::FpySequencerComponentBase::Svc_FpySequencer_SequencerStateMachine_action_setBreakpoint ( SmId  smId,
Svc_FpySequencer_SequencerStateMachine::Signal  signal,
const Svc::FpySequencer_BreakpointArgs value 
)
protectedpure virtual

Implementation for action setBreakpoint of state machine Svc_FpySequencer_SequencerStateMachine

sets the breakpoint to the provided args

Parameters
smIdThe state machine id
signalThe signal
valueThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe signal
valueThe 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
smIdThe state machine id
signalThe signal
valueThe 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
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_guard_breakOnce()

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

Implementation for guard breakOnce of state machine Svc_FpySequencer_SequencerStateMachine

return true if this breakpoint should only happen once

Parameters
smIdThe state machine id
signalThe 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
smIdThe state machine id
signalThe signal

◆ Svc_FpySequencer_SequencerStateMachine_guard_shouldBreak()

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

Implementation for guard shouldBreak of state machine Svc_FpySequencer_SequencerStateMachine

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

Parameters
smIdThe state machine id
signalThe signal

◆ tlmWrite_BreakBeforeNextLine()

void Svc::FpySequencerComponentBase::tlmWrite_BreakBeforeNextLine ( bool  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel BreakBeforeNextLine

whether or not to break before dispatching the next line, independent of what line it is. can be used in combination with breakpointIndex

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7809 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_BreakOnlyOnceOnBreakpoint()

void Svc::FpySequencerComponentBase::tlmWrite_BreakOnlyOnceOnBreakpoint ( bool  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel BreakOnlyOnceOnBreakpoint

whether or not to remove the breakpoint after breaking on it

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7776 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_BreakpointIndex()

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

Write telemetry channel BreakpointIndex

the current breakpoint index. The sequence will break at this point just before dispatching the directive at this index

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7728 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_BreakpointInUse()

void Svc::FpySequencerComponentBase::tlmWrite_BreakpointInUse ( bool  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel BreakpointInUse

whether or not to break at the breakpoint index

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7695 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_Debug_NextCmdOpcode()

void Svc::FpySequencerComponentBase::tlmWrite_Debug_NextCmdOpcode ( FwOpcodeType  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel Debug_NextCmdOpcode

if the next statement is a cmd directive, the opcode of that cmd

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7647 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_Debug_NextStatementOpcode()

void Svc::FpySequencerComponentBase::tlmWrite_Debug_NextStatementOpcode ( U8  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel Debug_NextStatementOpcode

the opcode of the next statement to dispatch.

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7599 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_Debug_NextStatementReadSuccess()

void Svc::FpySequencerComponentBase::tlmWrite_Debug_NextStatementReadSuccess ( bool  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel Debug_NextStatementReadSuccess

true if we were able to deserialize the next statement successfully

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7566 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_Debug_ReachedEndOfFile()

void Svc::FpySequencerComponentBase::tlmWrite_Debug_ReachedEndOfFile ( bool  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel Debug_ReachedEndOfFile

true if there are no statements remaining in the sequence file

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7533 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_DirectiveErrorId()

void Svc::FpySequencerComponentBase::tlmWrite_DirectiveErrorId ( const Svc::Fpy::DirectiveId arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel DirectiveErrorId

the id of the last directive to error

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7437 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_DirectiveErrorIndex()

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

Write telemetry channel DirectiveErrorIndex

the index of the last directive to error

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7389 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_handler()

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

Handler for input port tlmWrite.

Parameters
portNumThe port number
contextThe 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
portNumThe port number
contextThe call order

Definition at line 2003 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_LastDirectiveError()

void Svc::FpySequencerComponentBase::tlmWrite_LastDirectiveError ( const Svc::FpySequencer_DirectiveErrorCode arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel LastDirectiveError

the error code of the last directive that ran

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7341 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
portNumThe port number
contextThe call order

Definition at line 2102 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_PRM_STATEMENT_TIMEOUT_SECS()

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

Write telemetry channel PRM_STATEMENT_TIMEOUT_SECS

value of prm STATEMENT_TIMEOUT_SECS

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7842 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7485 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7197 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7149 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7101 of file FpySequencerComponentAc.cpp.

◆ tlmWrite_State()

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

Write telemetry channel State

the current state of the sequencer

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7053 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7245 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
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 7293 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
opCodeThe opcode
cmdSeqThe command sequence number
fileNameThe 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
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 3301 of file FpySequencerComponentAc.cpp.

◆ VALIDATE_preMsgHook()

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

Pre-message hook for command VALIDATE.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 3792 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 89 of file FpySequencerComponentAc.hpp.

◆ FpySequencerTesterBase

friend class FpySequencerTesterBase
friend

Friend class tester to support autocoded test harness.

Definition at line 87 of file FpySequencerComponentAc.hpp.


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