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

#include <Svc/FpySequencer/FpySequencer.hpp>

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

Classes

union  DirectiveUnion
 
class  Stack
 

Public Member Functions

 FpySequencer (const char *const compName)
 
 ~FpySequencer ()
 
void allocateBuffer (FwEnumStoreType identifier, Fw::MemAllocator &allocator, FwSizeType bytes)
 
void deallocateBuffer (Fw::MemAllocator &allocator)
 
- Public Member Functions inherited from Svc::FpySequencerComponentBase
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::QueuedComponentBase
void deinit () override
 Allows de-initialization on teardown. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const FwIdType)
 Set the ID base. More...
 
FwIdType getIdBase () const
 

Protected Member Functions

bool Svc_FpySequencer_SequencerStateMachine_guard_goalStateIs_RUNNING (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const override
 
bool Svc_FpySequencer_SequencerStateMachine_guard_shouldBreak (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const override
 
bool Svc_FpySequencer_SequencerStateMachine_guard_breakOnce (SmId smId, Svc_FpySequencer_SequencerStateMachine::Signal signal) const override
 
void checkTimers_handler (FwIndexType portNum, U32 context) override
 Handler for input port checkTimers. More...
 
void cmdResponseIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) override
 Handler for input port cmdResponseIn. More...
 
void seqRunIn_handler (FwIndexType portNum, const Fw::StringBase &filename) override
 Handler for input port seqRunIn. More...
 
void pingIn_handler (FwIndexType portNum, U32 key) override
 Handler for input port pingIn. More...
 
void tlmWrite_handler (FwIndexType portNum, U32 context) override
 Handler for input port tlmWrite. More...
 
void directive_waitAbs_internalInterfaceHandler (const FpySequencer_WaitAbsDirective &directive) override
 Internal interface handler for directive_waitAbs. More...
 
void directive_waitRel_internalInterfaceHandler (const FpySequencer_WaitRelDirective &directive) override
 Internal interface handler for directive_waitRel. More...
 
void directive_goto_internalInterfaceHandler (const Svc::FpySequencer_GotoDirective &directive) override
 Internal interface handler for directive_goto. More...
 
void directive_if_internalInterfaceHandler (const Svc::FpySequencer_IfDirective &directive) override
 Internal interface handler for directive_if. More...
 
void directive_noOp_internalInterfaceHandler (const Svc::FpySequencer_NoOpDirective &directive) override
 Internal interface handler for directive_noOp. More...
 
void directive_pushTlmVal_internalInterfaceHandler (const Svc::FpySequencer_PushTlmValDirective &directive) override
 Internal interface handler for directive_pushTlmVal. More...
 
void directive_pushTlmValAndTime_internalInterfaceHandler (const Svc::FpySequencer_PushTlmValAndTimeDirective &directive) override
 Internal interface handler for directive_pushTlmValAndTime. More...
 
void directive_pushPrm_internalInterfaceHandler (const Svc::FpySequencer_PushPrmDirective &directive) override
 Internal interface handler for directive_pushPrm. More...
 
void directive_constCmd_internalInterfaceHandler (const Svc::FpySequencer_ConstCmdDirective &directive) override
 Internal interface handler for directive_constCmd. More...
 
void directive_stackOp_internalInterfaceHandler (const Svc::FpySequencer_StackOpDirective &directive) override
 Internal interface handler for directive_stackOp. More...
 
void directive_exit_internalInterfaceHandler (const Svc::FpySequencer_ExitDirective &directive) override
 Internal interface handler for directive_exit. More...
 
void directive_allocate_internalInterfaceHandler (const Svc::FpySequencer_AllocateDirective &directive) override
 Internal interface handler for directive_allocate. More...
 
void directive_storeRelConstOffset_internalInterfaceHandler (const Svc::FpySequencer_StoreRelConstOffsetDirective &directive) override
 Internal interface handler for directive_storeRelConstOffset. More...
 
void directive_loadRel_internalInterfaceHandler (const Svc::FpySequencer_LoadRelDirective &directive) override
 Internal interface handler for directive_loadRel. More...
 
void directive_pushVal_internalInterfaceHandler (const Svc::FpySequencer_PushValDirective &directive) override
 Internal interface handler for directive_pushVal. More...
 
void directive_discard_internalInterfaceHandler (const Svc::FpySequencer_DiscardDirective &directive) override
 Internal interface handler for directive_discard. More...
 
void directive_memCmp_internalInterfaceHandler (const Svc::FpySequencer_MemCmpDirective &directive) override
 Internal interface handler for directive_memCmp. More...
 
void directive_stackCmd_internalInterfaceHandler (const Svc::FpySequencer_StackCmdDirective &directive) override
 Internal interface handler for directive_stackCmd. More...
 
void directive_pushTime_internalInterfaceHandler (const Svc::FpySequencer_PushTimeDirective &directive) override
 Internal interface handler for directive_pushTime. More...
 
void directive_setFlag_internalInterfaceHandler (const Svc::FpySequencer_SetFlagDirective &directive) override
 Internal interface handler for directive_setFlag. More...
 
void directive_getFlag_internalInterfaceHandler (const Svc::FpySequencer_GetFlagDirective &directive) override
 Internal interface handler for directive_getFlag. More...
 
void directive_getField_internalInterfaceHandler (const Svc::FpySequencer_GetFieldDirective &directive) override
 Internal interface handler for directive_getField. More...
 
void directive_peek_internalInterfaceHandler (const Svc::FpySequencer_PeekDirective &directive) override
 Internal interface handler for directive_peek. More...
 
void directive_storeRel_internalInterfaceHandler (const Svc::FpySequencer_StoreRelDirective &directive) override
 Internal interface handler for directive_storeRel. More...
 
void directive_call_internalInterfaceHandler (const Svc::FpySequencer_CallDirective &directive) override
 Internal interface handler for directive_call. More...
 
void directive_return_internalInterfaceHandler (const Svc::FpySequencer_ReturnDirective &directive) override
 Internal interface handler for directive_return. More...
 
void directive_loadAbs_internalInterfaceHandler (const Svc::FpySequencer_LoadAbsDirective &directive) override
 Internal interface handler for directive_loadAbs. More...
 
void directive_storeAbs_internalInterfaceHandler (const Svc::FpySequencer_StoreAbsDirective &directive) override
 Internal interface handler for directive_storeAbs. More...
 
void directive_storeAbsConstOffset_internalInterfaceHandler (const Svc::FpySequencer_StoreAbsConstOffsetDirective &directive) override
 Internal interface handler for directive_storeAbsConstOffset. More...
 
void parametersLoaded () override
 Called whenever parameters are loaded. More...
 
void parameterUpdated (FwPrmIdType id) override
 Called whenever a parameter is updated. More...
 
- Protected Member Functions inherited from Svc::FpySequencerComponentBase
 FpySequencerComponentBase (const char *compName="")
 Construct FpySequencerComponentBase object. More...
 
virtual ~FpySequencerComponentBase ()
 Destroy FpySequencerComponentBase object. More...
 
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)
 
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...
 
void directive_allocate_internalInterfaceInvoke (const Svc::FpySequencer_AllocateDirective &directive)
 Internal interface base-class function for directive_allocate. More...
 
void directive_call_internalInterfaceInvoke (const Svc::FpySequencer_CallDirective &directive)
 Internal interface base-class function for directive_call. 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_getField_internalInterfaceInvoke (const Svc::FpySequencer_GetFieldDirective &directive)
 Internal interface base-class function for directive_getField. More...
 
void directive_getFlag_internalInterfaceInvoke (const Svc::FpySequencer_GetFlagDirective &directive)
 Internal interface base-class function for directive_getFlag. 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_loadAbs_internalInterfaceInvoke (const Svc::FpySequencer_LoadAbsDirective &directive)
 Internal interface base-class function for directive_loadAbs. More...
 
void directive_loadRel_internalInterfaceInvoke (const Svc::FpySequencer_LoadRelDirective &directive)
 Internal interface base-class function for directive_loadRel. 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_peek_internalInterfaceInvoke (const Svc::FpySequencer_PeekDirective &directive)
 Internal interface base-class function for directive_peek. More...
 
void directive_pushPrm_internalInterfaceInvoke (const Svc::FpySequencer_PushPrmDirective &directive)
 Internal interface base-class function for directive_pushPrm. More...
 
void directive_pushTime_internalInterfaceInvoke (const Svc::FpySequencer_PushTimeDirective &directive)
 Internal interface base-class function for directive_pushTime. More...
 
void directive_pushTlmVal_internalInterfaceInvoke (const Svc::FpySequencer_PushTlmValDirective &directive)
 Internal interface base-class function for directive_pushTlmVal. 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_return_internalInterfaceInvoke (const Svc::FpySequencer_ReturnDirective &directive)
 Internal interface base-class function for directive_return. More...
 
void directive_setFlag_internalInterfaceInvoke (const Svc::FpySequencer_SetFlagDirective &directive)
 Internal interface base-class function for directive_setFlag. 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_storeAbs_internalInterfaceInvoke (const Svc::FpySequencer_StoreAbsDirective &directive)
 Internal interface base-class function for directive_storeAbs. More...
 
void directive_storeAbsConstOffset_internalInterfaceInvoke (const Svc::FpySequencer_StoreAbsConstOffsetDirective &directive)
 Internal interface base-class function for directive_storeAbsConstOffset. More...
 
void directive_storeRel_internalInterfaceInvoke (const Svc::FpySequencer_StoreRelDirective &directive)
 Internal interface base-class function for directive_storeRel. More...
 
void directive_storeRelConstOffset_internalInterfaceInvoke (const Svc::FpySequencer_StoreRelConstOffsetDirective &directive)
 Internal interface base-class function for directive_storeRelConstOffset. 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...
 
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)
 
void SET_FLAG_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void DUMP_STACK_TO_FILE_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...
 
virtual void SET_FLAG_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command SET_FLAG. More...
 
virtual void DUMP_STACK_TO_FILE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command DUMP_STACK_TO_FILE. 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_FileWriteError (FwSizeType writeSize, const Fw::StringBase &filePath, I32 errorCode) const
 Log event FileWriteError. 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_SequenceExitedWithError (const Fw::StringBase &filePath, U8 errorCode) const
 Log event SequenceExitedWithError. 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::Fpy::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())
 
void tlmWrite_Debug_NextStatementReadSuccess (bool arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Debug_NextStatementOpcode (U8 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Debug_NextStatementIndex (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Debug_NextCmdOpcode (FwOpcodeType arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Debug_StackSize (Svc::Fpy::StackSizeType arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_BreakpointInUse (bool arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_BreakpointIndex (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_BreakOnlyOnceOnBreakpoint (bool arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_BreakBeforeNextLine (bool arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_PRM_STATEMENT_TIMEOUT_SECS (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_PRM_FLAG_DEFAULT_EXIT_ON_CMD_FAIL (bool arg, Fw::Time _tlmTime=Fw::Time())
 
F32 paramGet_STATEMENT_TIMEOUT_SECS (Fw::ParamValid &valid)
 
bool paramGet_FLAG_DEFAULT_EXIT_ON_CMD_FAIL (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)
 
MsgDispatchStatus dispatchAvailableMessages ()
 dispatches all messages currently in the queue, returning status of the dispatch More...
 
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 FpySequencerTester
 

Additional Inherited Members

- Public Types inherited from Fw::ActiveComponentBase
enum  { ACTIVE_COMPONENT_EXIT }
 
- Public Types inherited from Fw::QueuedComponentBase
enum  MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT }
 
- Protected Types inherited from Svc::FpySequencerComponentBase
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_SET_FLAG = 0x9, OPCODE_DUMP_STACK_TO_FILE = 0xa, OPCODE_STATEMENT_TIMEOUT_SECS_SET = 0xb,
  OPCODE_STATEMENT_TIMEOUT_SECS_SAVE = 0xc, OPCODE_FLAG_DEFAULT_EXIT_ON_CMD_FAIL_SET = 0xd, OPCODE_FLAG_DEFAULT_EXIT_ON_CMD_FAIL_SAVE = 0xe
}
 Command opcodes. More...
 
enum  {
  EVENTID_INVALIDCOMMAND = 0x0, EVENTID_INVALIDSEQRUNCALL = 0x1, EVENTID_FILEOPENERROR = 0x2, EVENTID_FILEWRITEERROR = 0x3,
  EVENTID_FILEREADERROR = 0x4, EVENTID_ENDOFFILEERROR = 0x5, EVENTID_FILEREADDESERIALIZEERROR = 0x6, EVENTID_WRONGSCHEMAVERSION = 0x7,
  EVENTID_WRONGCRC = 0x8, EVENTID_EXTRABYTESINSEQUENCE = 0x9, EVENTID_INSUFFICIENTBUFFERSPACE = 0xa, EVENTID_COMMANDFAILED = 0xb,
  EVENTID_SEQUENCEDONE = 0xc, EVENTID_SEQUENCECANCELLED = 0xd, EVENTID_SEQUENCEEXITEDWITHERROR = 0xe, EVENTID_UNKNOWNSEQUENCERDIRECTIVE = 0xf,
  EVENTID_CMDRESPONSEWHILENOTRUNNINGSEQUENCE = 0x10, EVENTID_CMDRESPONSEFROMOLDSEQUENCE = 0x11, EVENTID_CMDRESPONSEWHILENOTAWAITING = 0x12, EVENTID_CMDRESPONSEWHILEAWAITINGDIRECTIVE = 0x13,
  EVENTID_WRONGCMDRESPONSEOPCODE = 0x14, EVENTID_WRONGCMDRESPONSEINDEX = 0x15, EVENTID_DIRECTIVEDESERIALIZEERROR = 0x16, EVENTID_MISMATCHEDTIMEBASE = 0x17,
  EVENTID_MISMATCHEDTIMECONTEXT = 0x18, EVENTID_COMMANDTIMEDOUT = 0x19, EVENTID_DIRECTIVETIMEDOUT = 0x1a, EVENTID_TOOMANYSEQUENCEARGS = 0x1b,
  EVENTID_TOOMANYSEQUENCEDIRECTIVES = 0x1c, EVENTID_SEQUENCEPAUSED = 0x1d, EVENTID_BREAKPOINTSET = 0x1e, EVENTID_BREAKPOINTCLEARED = 0x1f
}
 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_NEXTSTATEMENTINDEX = 0xd, CHANNELID_DEBUG_NEXTCMDOPCODE = 0xe, CHANNELID_DEBUG_STACKSIZE = 0xf,
  CHANNELID_BREAKPOINTINUSE = 0x10, CHANNELID_BREAKPOINTINDEX = 0x11, CHANNELID_BREAKONLYONCEONBREAKPOINT = 0x12, CHANNELID_BREAKBEFORENEXTLINE = 0x13,
  CHANNELID_PRM_STATEMENT_TIMEOUT_SECS = 0x14, CHANNELID_PRM_FLAG_DEFAULT_EXIT_ON_CMD_FAIL = 0x15
}
 Channel IDs. More...
 
enum  { PARAMID_STATEMENT_TIMEOUT_SECS = 0x0, PARAMID_FLAG_DEFAULT_EXIT_ON_CMD_FAIL = 0x1 }
 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...
 
- Static Protected Member Functions inherited from Svc::FpySequencerComponentBase
static constexpr FwIndexType getNum_cmdIn_InputPorts ()
 
static constexpr FwIndexType getNum_checkTimers_InputPorts ()
 
static constexpr FwIndexType getNum_cmdResponseIn_InputPorts ()
 
static constexpr FwIndexType getNum_pingIn_InputPorts ()
 
static constexpr FwIndexType getNum_seqRunIn_InputPorts ()
 
static constexpr FwIndexType getNum_tlmWrite_InputPorts ()
 
static constexpr FwIndexType getNum_cmdRegOut_OutputPorts ()
 
static constexpr FwIndexType getNum_cmdResponseOut_OutputPorts ()
 
static constexpr FwIndexType getNum_logOut_OutputPorts ()
 
static constexpr FwIndexType getNum_prmGet_OutputPorts ()
 
static constexpr FwIndexType getNum_prmSet_OutputPorts ()
 
static constexpr FwIndexType getNum_timeCaller_OutputPorts ()
 
static constexpr FwIndexType getNum_tlmOut_OutputPorts ()
 
static constexpr FwIndexType getNum_cmdOut_OutputPorts ()
 
static constexpr FwIndexType getNum_getParam_OutputPorts ()
 
static constexpr FwIndexType getNum_getTlmChan_OutputPorts ()
 
static constexpr FwIndexType getNum_pingOut_OutputPorts ()
 
static constexpr FwIndexType getNum_seqDoneOut_OutputPorts ()
 
static constexpr FwIndexType getNum_seqStartOut_OutputPorts ()
 
- 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

Definition at line 44 of file FpySequencer.hpp.

Constructor & Destructor Documentation

◆ FpySequencer()

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

Construct object FpySequencer

Parameters
compNameThe component name

Definition at line 16 of file FpySequencer.cpp.

◆ ~FpySequencer()

Svc::FpySequencer::~FpySequencer ( )

Destroy object FpySequencer

Definition at line 33 of file FpySequencer.cpp.

Member Function Documentation

◆ allocateBuffer()

void Svc::FpySequencer::allocateBuffer ( FwEnumStoreType  identifier,
Fw::MemAllocator allocator,
FwSizeType  bytes 
)

Definition at line 8 of file FpySequencerValidationState.cpp.

◆ checkTimers_handler()

void Svc::FpySequencer::checkTimers_handler ( FwIndexType  portNum,
U32  context 
)
overrideprotectedvirtual

Handler for input port checkTimers.

Parameters
portNumThe port number
contextThe call order

Implements Svc::FpySequencerComponentBase.

Definition at line 276 of file FpySequencer.cpp.

◆ cmdResponseIn_handler()

void Svc::FpySequencer::cmdResponseIn_handler ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdResponse response 
)
overrideprotectedvirtual

Handler for input port cmdResponseIn.

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

Implements Svc::FpySequencerComponentBase.

Definition at line 290 of file FpySequencer.cpp.

◆ deallocateBuffer()

void Svc::FpySequencer::deallocateBuffer ( Fw::MemAllocator allocator)

Definition at line 22 of file FpySequencerValidationState.cpp.

◆ directive_allocate_internalInterfaceHandler()

void Svc::FpySequencer::directive_allocate_internalInterfaceHandler ( const Svc::FpySequencer_AllocateDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_allocate.

Implements Svc::FpySequencerComponentBase.

Definition at line 155 of file FpySequencerDirectives.cpp.

◆ directive_call_internalInterfaceHandler()

void Svc::FpySequencer::directive_call_internalInterfaceHandler ( const Svc::FpySequencer_CallDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_call.

Implements Svc::FpySequencerComponentBase.

Definition at line 247 of file FpySequencerDirectives.cpp.

◆ directive_constCmd_internalInterfaceHandler()

void Svc::FpySequencer::directive_constCmd_internalInterfaceHandler ( const Svc::FpySequencer_ConstCmdDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_constCmd.

Implements Svc::FpySequencerComponentBase.

Definition at line 134 of file FpySequencerDirectives.cpp.

◆ directive_discard_internalInterfaceHandler()

void Svc::FpySequencer::directive_discard_internalInterfaceHandler ( const Svc::FpySequencer_DiscardDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_discard.

Implements Svc::FpySequencerComponentBase.

Definition at line 184 of file FpySequencerDirectives.cpp.

◆ directive_exit_internalInterfaceHandler()

void Svc::FpySequencer::directive_exit_internalInterfaceHandler ( const Svc::FpySequencer_ExitDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_exit.

Implements Svc::FpySequencerComponentBase.

Definition at line 148 of file FpySequencerDirectives.cpp.

◆ directive_getField_internalInterfaceHandler()

void Svc::FpySequencer::directive_getField_internalInterfaceHandler ( const Svc::FpySequencer_GetFieldDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_getField.

Implements Svc::FpySequencerComponentBase.

Definition at line 226 of file FpySequencerDirectives.cpp.

◆ directive_getFlag_internalInterfaceHandler()

void Svc::FpySequencer::directive_getFlag_internalInterfaceHandler ( const Svc::FpySequencer_GetFlagDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_getFlag.

Implements Svc::FpySequencerComponentBase.

Definition at line 219 of file FpySequencerDirectives.cpp.

◆ directive_goto_internalInterfaceHandler()

void Svc::FpySequencer::directive_goto_internalInterfaceHandler ( const Svc::FpySequencer_GotoDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_goto.

Implements Svc::FpySequencerComponentBase.

Definition at line 90 of file FpySequencerDirectives.cpp.

◆ directive_if_internalInterfaceHandler()

void Svc::FpySequencer::directive_if_internalInterfaceHandler ( const Svc::FpySequencer_IfDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_if.

Implements Svc::FpySequencerComponentBase.

Definition at line 97 of file FpySequencerDirectives.cpp.

◆ directive_loadAbs_internalInterfaceHandler()

void Svc::FpySequencer::directive_loadAbs_internalInterfaceHandler ( const Svc::FpySequencer_LoadAbsDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_loadAbs.

Implements Svc::FpySequencerComponentBase.

Definition at line 261 of file FpySequencerDirectives.cpp.

◆ directive_loadRel_internalInterfaceHandler()

void Svc::FpySequencer::directive_loadRel_internalInterfaceHandler ( const Svc::FpySequencer_LoadRelDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_loadRel.

Implements Svc::FpySequencerComponentBase.

Definition at line 177 of file FpySequencerDirectives.cpp.

◆ directive_memCmp_internalInterfaceHandler()

void Svc::FpySequencer::directive_memCmp_internalInterfaceHandler ( const Svc::FpySequencer_MemCmpDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_memCmp.

Implements Svc::FpySequencerComponentBase.

Definition at line 191 of file FpySequencerDirectives.cpp.

◆ directive_noOp_internalInterfaceHandler()

void Svc::FpySequencer::directive_noOp_internalInterfaceHandler ( const Svc::FpySequencer_NoOpDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_noOp.

Implements Svc::FpySequencerComponentBase.

Definition at line 104 of file FpySequencerDirectives.cpp.

◆ directive_peek_internalInterfaceHandler()

void Svc::FpySequencer::directive_peek_internalInterfaceHandler ( const Svc::FpySequencer_PeekDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_peek.

Implements Svc::FpySequencerComponentBase.

Definition at line 233 of file FpySequencerDirectives.cpp.

◆ directive_pushPrm_internalInterfaceHandler()

void Svc::FpySequencer::directive_pushPrm_internalInterfaceHandler ( const Svc::FpySequencer_PushPrmDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_pushPrm.

Implements Svc::FpySequencerComponentBase.

Definition at line 127 of file FpySequencerDirectives.cpp.

◆ directive_pushTime_internalInterfaceHandler()

void Svc::FpySequencer::directive_pushTime_internalInterfaceHandler ( const Svc::FpySequencer_PushTimeDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_pushTime.

Implements Svc::FpySequencerComponentBase.

Definition at line 205 of file FpySequencerDirectives.cpp.

◆ directive_pushTlmVal_internalInterfaceHandler()

void Svc::FpySequencer::directive_pushTlmVal_internalInterfaceHandler ( const Svc::FpySequencer_PushTlmValDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_pushTlmVal.

Implements Svc::FpySequencerComponentBase.

Definition at line 111 of file FpySequencerDirectives.cpp.

◆ directive_pushTlmValAndTime_internalInterfaceHandler()

void Svc::FpySequencer::directive_pushTlmValAndTime_internalInterfaceHandler ( const Svc::FpySequencer_PushTlmValAndTimeDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_pushTlmValAndTime.

Implements Svc::FpySequencerComponentBase.

Definition at line 119 of file FpySequencerDirectives.cpp.

◆ directive_pushVal_internalInterfaceHandler()

void Svc::FpySequencer::directive_pushVal_internalInterfaceHandler ( const Svc::FpySequencer_PushValDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_pushVal.

Implements Svc::FpySequencerComponentBase.

Definition at line 170 of file FpySequencerDirectives.cpp.

◆ directive_return_internalInterfaceHandler()

void Svc::FpySequencer::directive_return_internalInterfaceHandler ( const Svc::FpySequencer_ReturnDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_return.

Implements Svc::FpySequencerComponentBase.

Definition at line 254 of file FpySequencerDirectives.cpp.

◆ directive_setFlag_internalInterfaceHandler()

void Svc::FpySequencer::directive_setFlag_internalInterfaceHandler ( const Svc::FpySequencer_SetFlagDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_setFlag.

Implements Svc::FpySequencerComponentBase.

Definition at line 212 of file FpySequencerDirectives.cpp.

◆ directive_stackCmd_internalInterfaceHandler()

void Svc::FpySequencer::directive_stackCmd_internalInterfaceHandler ( const Svc::FpySequencer_StackCmdDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_stackCmd.

Implements Svc::FpySequencerComponentBase.

Definition at line 198 of file FpySequencerDirectives.cpp.

◆ directive_stackOp_internalInterfaceHandler()

void Svc::FpySequencer::directive_stackOp_internalInterfaceHandler ( const Svc::FpySequencer_StackOpDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_stackOp.

Implements Svc::FpySequencerComponentBase.

Definition at line 141 of file FpySequencerDirectives.cpp.

◆ directive_storeAbs_internalInterfaceHandler()

void Svc::FpySequencer::directive_storeAbs_internalInterfaceHandler ( const Svc::FpySequencer_StoreAbsDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_storeAbs.

Implements Svc::FpySequencerComponentBase.

Definition at line 268 of file FpySequencerDirectives.cpp.

◆ directive_storeAbsConstOffset_internalInterfaceHandler()

void Svc::FpySequencer::directive_storeAbsConstOffset_internalInterfaceHandler ( const Svc::FpySequencer_StoreAbsConstOffsetDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_storeAbsConstOffset.

Implements Svc::FpySequencerComponentBase.

Definition at line 275 of file FpySequencerDirectives.cpp.

◆ directive_storeRel_internalInterfaceHandler()

void Svc::FpySequencer::directive_storeRel_internalInterfaceHandler ( const Svc::FpySequencer_StoreRelDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_storeRel.

Implements Svc::FpySequencerComponentBase.

Definition at line 240 of file FpySequencerDirectives.cpp.

◆ directive_storeRelConstOffset_internalInterfaceHandler()

void Svc::FpySequencer::directive_storeRelConstOffset_internalInterfaceHandler ( const Svc::FpySequencer_StoreRelConstOffsetDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_storeRelConstOffset.

Implements Svc::FpySequencerComponentBase.

Definition at line 162 of file FpySequencerDirectives.cpp.

◆ directive_waitAbs_internalInterfaceHandler()

void Svc::FpySequencer::directive_waitAbs_internalInterfaceHandler ( const FpySequencer_WaitAbsDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_waitAbs.

Implements Svc::FpySequencerComponentBase.

Definition at line 83 of file FpySequencerDirectives.cpp.

◆ directive_waitRel_internalInterfaceHandler()

void Svc::FpySequencer::directive_waitRel_internalInterfaceHandler ( const FpySequencer_WaitRelDirective directive)
overrideprotectedvirtual

Internal interface handler for directive_waitRel.

Implements Svc::FpySequencerComponentBase.

Definition at line 76 of file FpySequencerDirectives.cpp.

◆ parametersLoaded()

void Svc::FpySequencer::parametersLoaded ( )
overrideprotectedvirtual

Called whenever parameters are loaded.

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

Reimplemented from Svc::FpySequencerComponentBase.

Definition at line 490 of file FpySequencer.cpp.

◆ parameterUpdated()

void Svc::FpySequencer::parameterUpdated ( FwPrmIdType  id)
overrideprotectedvirtual

Called whenever a parameter is updated.

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

Reimplemented from Svc::FpySequencerComponentBase.

Definition at line 495 of file FpySequencer.cpp.

◆ pingIn_handler()

void Svc::FpySequencer::pingIn_handler ( FwIndexType  portNum,
U32  key 
)
overrideprotectedvirtual

Handler for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Implements Svc::FpySequencerComponentBase.

Definition at line 282 of file FpySequencer.cpp.

◆ seqRunIn_handler()

void Svc::FpySequencer::seqRunIn_handler ( FwIndexType  portNum,
const Fw::StringBase filename 
)
overrideprotectedvirtual

Handler for input port seqRunIn.

Implements Svc::FpySequencerComponentBase.

Definition at line 394 of file FpySequencer.cpp.

◆ Svc_FpySequencer_SequencerStateMachine_guard_breakOnce()

bool Svc::FpySequencer::Svc_FpySequencer_SequencerStateMachine_guard_breakOnce ( SmId  smId,
Svc_FpySequencer_SequencerStateMachine::Signal  signal 
) const
overrideprotected

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

Definition at line 385 of file FpySequencerStateMachine.cpp.

◆ Svc_FpySequencer_SequencerStateMachine_guard_goalStateIs_RUNNING()

bool Svc::FpySequencer::Svc_FpySequencer_SequencerStateMachine_guard_goalStateIs_RUNNING ( SmId  smId,
Svc_FpySequencer_SequencerStateMachine::Signal  signal 
) const
overrideprotected

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

Definition at line 360 of file FpySequencerStateMachine.cpp.

◆ Svc_FpySequencer_SequencerStateMachine_guard_shouldBreak()

bool Svc::FpySequencer::Svc_FpySequencer_SequencerStateMachine_guard_shouldBreak ( SmId  smId,
Svc_FpySequencer_SequencerStateMachine::Signal  signal 
) const
overrideprotected

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

Definition at line 371 of file FpySequencerStateMachine.cpp.

◆ tlmWrite_handler()

void Svc::FpySequencer::tlmWrite_handler ( FwIndexType  portNum,
U32  context 
)
overrideprotectedvirtual

Handler for input port tlmWrite.

Parameters
portNumThe port number
contextThe call order

Implements Svc::FpySequencerComponentBase.

Definition at line 406 of file FpySequencer.cpp.

Friends And Related Function Documentation

◆ FpySequencerTester

friend class FpySequencerTester
friend

Definition at line 45 of file FpySequencer.hpp.


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