![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/FpySequencer/FpySequencer_SequencerStateMachineStateMachineAc.hpp>
Public Member Functions | |
FpySequencer_SequencerStateMachineStateMachineBase::State | getState () const |
Get the state. More... | |
void | sendSignal_cmd_VALIDATE (const Svc::FpySequencer_SequenceExecutionArgs &value) |
called on VALIDATE cmd with the path of the sequence file to validate. only raised in IDLE state More... | |
void | sendSignal_cmd_RUN (const Svc::FpySequencer_SequenceExecutionArgs &value) |
called on RUN cmd with the path of the sequence file to run. only raised in IDLE state More... | |
void | sendSignal_cmd_RUN_VALIDATED (const Svc::FpySequencer_SequenceExecutionArgs &value) |
called on RUN_VALIDATED cmd. only raised in AWAITING_CMD_RUN_VALIDATED state More... | |
void | sendSignal_cmd_CANCEL () |
called on CANCEL cmd. raised in all states except IDLE More... | |
void | sendSignal_cmd_DEBUG_SET_BREAKPOINT (const Svc::FpySequencer_DebugBreakpointArgs &value) |
called in DEBUG_SET_BREAKPOINT cmd. raised in any state More... | |
void | sendSignal_cmd_DEBUG_CLEAR_BREAKPOINT () |
called in DEBUG_CLEAR_BREAKPOINT cmd. raised in any state More... | |
void | sendSignal_result_failure () |
generic failure of an action More... | |
void | sendSignal_result_success () |
generic success of an action More... | |
void | sendSignal_entered () |
generic entry of a state More... | |
void | sendSignal_result_dispatchStatement_success () |
called in dispatchStatement method when a statement was successfully dispatched More... | |
void | sendSignal_result_dispatchStatement_failure () |
called in dispatchStatement method when a statement was unable to be sent out More... | |
void | sendSignal_result_dispatchStatement_noMoreStatements () |
called in dispatchStatement method when there were no more statements in the sequence More... | |
void | sendSignal_checkTimersIn () |
raised whenever the checkTimers port is called More... | |
void | sendSignal_result_checkShouldWake_wakeup () |
raised when we are done sleeping More... | |
void | sendSignal_result_checkShouldWake_keepSleeping () |
raised when we should keep sleeping More... | |
void | sendSignal_result_timeOpFailed () |
void | sendSignal_stmtResponse_beginSleep () |
a statement is telling the sequencer to go to sleep More... | |
void | sendSignal_stmtResponse_success () |
called when statement successfully executed. only raised in the RUNNING.AWAITING_CMD_RESPONSE state More... | |
void | sendSignal_stmtResponse_failure () |
called when the statement unsuccessfully executed. only raised in the RUNNING.AWAITING_CMD_RESPONSE state More... | |
void | sendSignal_stmtResponse_unexpected () |
called when an unexpected or incorrect statement response comes in. only raised in the RUNNING state More... | |
void | sendSignal_stmtResponse_keepWaiting () |
called when the statement is telling the sequencer to await a later stmt response More... | |
void | sendSignal_result_checkStatementTimeout_statementTimeout () |
raised when the statement times out, according to the timeout parameter More... | |
void | sendSignal_result_checkStatementTimeout_noTimeout () |
raised when the statement has not timed out yet More... | |
void | sendSignal_cmd_DEBUG_CONTINUE () |
called in DEBUG_CONTINUE cmd. only raised in RUNNING.DEBUG_BROKEN state More... | |
void | sendSignal_cmd_DEBUG_BREAK (const Svc::FpySequencer_DebugBreakpointArgs &value) |
called in DEBUG_BREAK cmd. only raised in RUNNING state More... | |
Protected Member Functions | |
FpySequencer_SequencerStateMachineStateMachineBase () | |
Constructor. More... | |
virtual | ~FpySequencer_SequencerStateMachineStateMachineBase () |
Destructor. More... | |
void | initBase (const FwEnumStoreType id) |
Initialize the state machine. More... | |
virtual void | action_signalEntered (Signal signal)=0 |
simply raises the "entered" signal More... | |
virtual void | action_setSequenceFilePath (Signal signal, const Svc::FpySequencer_SequenceExecutionArgs &value)=0 |
sets the current sequence file path member var More... | |
virtual void | action_setSequenceBlockState (Signal signal, const Svc::FpySequencer_SequenceExecutionArgs &value)=0 |
sets the block state of the sequence to be run More... | |
virtual void | action_validate (Signal signal)=0 |
performs all steps necessary for sequence validation, and raises a signal result_success or result_failure More... | |
virtual void | action_report_seqSucceeded (Signal signal)=0 |
reports that a sequence succeeded More... | |
virtual void | action_report_seqCancelled (Signal signal)=0 |
reports that a sequence was cancelled More... | |
virtual void | action_report_seqFailed (Signal signal)=0 |
called when a sequence failed to execute successfully More... | |
virtual void | action_report_seqStarted (Signal signal)=0 |
called when a sequence starts More... | |
virtual void | action_setGoalState_RUNNING (Signal signal)=0 |
sets the goal state to RUNNING More... | |
virtual void | action_setGoalState_VALID (Signal signal)=0 |
sets the goal state to VALID More... | |
virtual void | action_setGoalState_IDLE (Signal signal)=0 |
sets the goal state to IDLE More... | |
virtual void | action_sendCmdResponse_OK (Signal signal)=0 |
responds to the calling command with OK More... | |
virtual void | action_sendCmdResponse_EXECUTION_ERROR (Signal signal)=0 |
responds to the calling command with EXECUTION_ERROR More... | |
virtual void | action_clearSequenceFile (Signal signal)=0 |
clears all variables related to the loading/validating of the sequence file More... | |
virtual void | action_clearDebugBreakpoint (Signal signal)=0 |
clears the debug breakpoint setting More... | |
virtual void | action_checkShouldWake (Signal signal)=0 |
checks if sequencer should wake from sleep More... | |
virtual void | action_dispatchStatement (Signal signal)=0 |
iterates to the next statement and dispatches it More... | |
virtual void | action_resetRuntime (Signal signal)=0 |
resets the sequence runtime More... | |
virtual void | action_checkStatementTimeout (Signal signal)=0 |
checks if the current statement has timed out More... | |
virtual void | action_incrementSequenceCounter (Signal signal)=0 |
increments the m_sequencesStarted counter More... | |
virtual void | action_report_debugBroken (Signal signal)=0 |
reports that a debug breakpoint was hit More... | |
virtual void | action_setDebugBreakpoint (Signal signal, const Svc::FpySequencer_DebugBreakpointArgs &value)=0 |
sets the debug breakpoint to the provided args More... | |
virtual bool | guard_goalStateIs_RUNNING (Signal signal) const =0 |
return true if the goal state is RUNNING More... | |
virtual bool | guard_shouldDebugBreak (Signal signal) const =0 |
virtual bool | guard_debugBreakOnce (Signal signal) const =0 |
return true if this debug breakpoint should only happen once More... | |
Protected Attributes | |
FwEnumStoreType | m_id = 0 |
The state machine ID. More... | |
State | m_state = State::__FPRIME_AC_UNINITIALIZED |
The state. More... | |
Definition at line 19 of file FpySequencer_SequencerStateMachineStateMachineAc.hpp.
The signal type.
Enumerator | |
---|---|
__FPRIME_AC_INITIAL_TRANSITION | The initial transition. |
checkTimersIn | raised whenever the checkTimers port is called |
cmd_CANCEL | called on CANCEL cmd. raised in all states except IDLE |
cmd_DEBUG_BREAK | called in DEBUG_BREAK cmd. only raised in RUNNING state |
cmd_DEBUG_CLEAR_BREAKPOINT | called in DEBUG_CLEAR_BREAKPOINT cmd. raised in any state |
cmd_DEBUG_CONTINUE | called in DEBUG_CONTINUE cmd. only raised in RUNNING.DEBUG_BROKEN state |
cmd_DEBUG_SET_BREAKPOINT | called in DEBUG_SET_BREAKPOINT cmd. raised in any state |
cmd_RUN | called on RUN cmd with the path of the sequence file to run. only raised in IDLE state |
cmd_RUN_VALIDATED | called on RUN_VALIDATED cmd. only raised in AWAITING_CMD_RUN_VALIDATED state |
cmd_VALIDATE | called on VALIDATE cmd with the path of the sequence file to validate. only raised in IDLE state |
entered | generic entry of a state |
result_checkShouldWake_keepSleeping | raised when we should keep sleeping |
result_checkShouldWake_wakeup | raised when we are done sleeping |
result_checkStatementTimeout_noTimeout | raised when the statement has not timed out yet |
result_checkStatementTimeout_statementTimeout | raised when the statement times out, according to the timeout parameter |
result_dispatchStatement_failure | called in dispatchStatement method when a statement was unable to be sent out |
result_dispatchStatement_noMoreStatements | called in dispatchStatement method when there were no more statements in the sequence |
result_dispatchStatement_success | called in dispatchStatement method when a statement was successfully dispatched |
result_failure | generic failure of an action |
result_success | generic success of an action |
result_timeOpFailed | raised when an operation could not be performed on a Fw::Time object due to a mismatched time base or context |
stmtResponse_beginSleep | a statement is telling the sequencer to go to sleep |
stmtResponse_failure | called when the statement unsuccessfully executed. only raised in the RUNNING.AWAITING_CMD_RESPONSE state |
stmtResponse_keepWaiting | called when the statement is telling the sequencer to await a later stmt response |
stmtResponse_success | called when statement successfully executed. only raised in the RUNNING.AWAITING_CMD_RESPONSE state |
stmtResponse_unexpected | called when an unexpected or incorrect statement response comes in. only raised in the RUNNING state |
Definition at line 47 of file FpySequencer_SequencerStateMachineStateMachineAc.hpp.
The state type.
Definition at line 28 of file FpySequencer_SequencerStateMachineStateMachineAc.hpp.
|
protected |
Constructor.
Definition at line 17 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
|
protectedvirtual |
Destructor.
Definition at line 23 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
|
protectedpure virtual |
checks if sequencer should wake from sleep
signal | The signal |
|
protectedpure virtual |
checks if the current statement has timed out
signal | The signal |
|
protectedpure virtual |
clears the debug breakpoint setting
signal | The signal |
|
protectedpure virtual |
clears all variables related to the loading/validating of the sequence file
signal | The signal |
|
protectedpure virtual |
iterates to the next statement and dispatches it
signal | The signal |
|
protectedpure virtual |
increments the m_sequencesStarted counter
signal | The signal |
|
protectedpure virtual |
reports that a debug breakpoint was hit
signal | The signal |
|
protectedpure virtual |
reports that a sequence was cancelled
signal | The signal |
|
protectedpure virtual |
called when a sequence failed to execute successfully
signal | The signal |
|
protectedpure virtual |
called when a sequence starts
signal | The signal |
|
protectedpure virtual |
reports that a sequence succeeded
signal | The signal |
|
protectedpure virtual |
resets the sequence runtime
signal | The signal |
|
protectedpure virtual |
responds to the calling command with EXECUTION_ERROR
signal | The signal |
|
protectedpure virtual |
responds to the calling command with OK
signal | The signal |
|
protectedpure virtual |
sets the debug breakpoint to the provided args
signal | The signal |
value | The value |
|
protectedpure virtual |
sets the goal state to IDLE
signal | The signal |
|
protectedpure virtual |
sets the goal state to RUNNING
signal | The signal |
|
protectedpure virtual |
sets the goal state to VALID
signal | The signal |
|
protectedpure virtual |
sets the block state of the sequence to be run
signal | The signal |
value | The value |
|
protectedpure virtual |
sets the current sequence file path member var
signal | The signal |
value | The value |
|
protectedpure virtual |
simply raises the "entered" signal
signal | The signal |
|
protectedpure virtual |
performs all steps necessary for sequence validation, and raises a signal result_success or result_failure
signal | The signal |
FpySequencer_SequencerStateMachineStateMachineBase::State Svc::FpySequencer_SequencerStateMachineStateMachineBase::getState | ( | ) | const |
Get the state.
Definition at line 45 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
|
protectedpure virtual |
return true if this debug breakpoint should only happen once
signal | The signal |
|
protectedpure virtual |
return true if the goal state is RUNNING
signal | The signal |
|
protectedpure virtual |
return true if should debug break at this point in execution, before dispatching next stmt
signal | The signal |
|
protected |
Initialize the state machine.
id | The state machine ID |
Definition at line 33 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_checkTimersIn | ( | ) |
raised whenever the checkTimers port is called
Definition at line 440 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_CANCEL | ( | ) |
called on CANCEL cmd. raised in all states except IDLE
Definition at line 142 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_DEBUG_BREAK | ( | const Svc::FpySequencer_DebugBreakpointArgs & | value | ) |
called in DEBUG_BREAK cmd. only raised in RUNNING state
value | The value |
Definition at line 786 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_DEBUG_CLEAR_BREAKPOINT | ( | ) |
called in DEBUG_CLEAR_BREAKPOINT cmd. raised in any state
Definition at line 233 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_DEBUG_CONTINUE | ( | ) |
called in DEBUG_CONTINUE cmd. only raised in RUNNING.DEBUG_BROKEN state
Definition at line 760 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_DEBUG_SET_BREAKPOINT | ( | const Svc::FpySequencer_DebugBreakpointArgs & | value | ) |
called in DEBUG_SET_BREAKPOINT cmd. raised in any state
value | The value |
Definition at line 195 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_RUN | ( | const Svc::FpySequencer_SequenceExecutionArgs & | value | ) |
called on RUN cmd with the path of the sequence file to run. only raised in IDLE state
value | The value |
Definition at line 84 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_RUN_VALIDATED | ( | const Svc::FpySequencer_SequenceExecutionArgs & | value | ) |
called on RUN_VALIDATED cmd. only raised in AWAITING_CMD_RUN_VALIDATED state
value | The value |
Definition at line 114 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_cmd_VALIDATE | ( | const Svc::FpySequencer_SequenceExecutionArgs & | value | ) |
called on VALIDATE cmd with the path of the sequence file to validate. only raised in IDLE state
value | The value |
Definition at line 55 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_entered | ( | ) |
generic entry of a state
Definition at line 326 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_checkShouldWake_keepSleeping | ( | ) |
raised when we should keep sleeping
Definition at line 495 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_checkShouldWake_wakeup | ( | ) |
raised when we are done sleeping
Definition at line 469 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_checkStatementTimeout_noTimeout | ( | ) |
raised when the statement has not timed out yet
Definition at line 736 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_checkStatementTimeout_statementTimeout | ( | ) |
raised when the statement times out, according to the timeout parameter
Definition at line 702 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_dispatchStatement_failure | ( | ) |
called in dispatchStatement method when a statement was unable to be sent out
Definition at line 382 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_dispatchStatement_noMoreStatements | ( | ) |
called in dispatchStatement method when there were no more statements in the sequence
Definition at line 411 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_dispatchStatement_success | ( | ) |
called in dispatchStatement method when a statement was successfully dispatched
Definition at line 356 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_failure | ( | ) |
generic failure of an action
Definition at line 271 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_success | ( | ) |
generic success of an action
Definition at line 300 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_result_timeOpFailed | ( | ) |
raised when an operation could not be performed on a Fw::Time object due to a mismatched time base or context
Definition at line 519 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_stmtResponse_beginSleep | ( | ) |
a statement is telling the sequencer to go to sleep
Definition at line 553 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_stmtResponse_failure | ( | ) |
called when the statement unsuccessfully executed. only raised in the RUNNING.AWAITING_CMD_RESPONSE state
Definition at line 605 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_stmtResponse_keepWaiting | ( | ) |
called when the statement is telling the sequencer to await a later stmt response
Definition at line 678 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_stmtResponse_success | ( | ) |
called when statement successfully executed. only raised in the RUNNING.AWAITING_CMD_RESPONSE state
Definition at line 579 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
void Svc::FpySequencer_SequencerStateMachineStateMachineBase::sendSignal_stmtResponse_unexpected | ( | ) |
called when an unexpected or incorrect statement response comes in. only raised in the RUNNING state
Definition at line 634 of file FpySequencer_SequencerStateMachineStateMachineAc.cpp.
|
protected |
The state machine ID.
Definition at line 431 of file FpySequencer_SequencerStateMachineStateMachineAc.hpp.
|
protected |
The state.
Definition at line 434 of file FpySequencer_SequencerStateMachineStateMachineAc.hpp.