![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
#include <Svc/SeqDispatcher/SeqDispatcher.hpp>
Public Member Functions | |
SeqDispatcher (const char *const compName) | |
~SeqDispatcher () | |
![]() | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize SeqDispatcherComponentBase object. | |
Fw::InputCmdPort * | get_cmdIn_InputPort (FwIndexType portNum) |
Fw::InputCmdResponsePort * | get_seqDoneIn_InputPort (FwIndexType portNum) |
Svc::InputCmdSeqInPort * | get_seqRunIn_InputPort (FwIndexType portNum) |
Svc::InputCmdSeqInPort * | get_seqStartIn_InputPort (FwIndexType portNum) |
void | set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
Connect port to cmdRegOut[portNum]. | |
void | set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
Connect port to cmdResponseOut[portNum]. | |
void | set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
Connect port to logOut[portNum]. | |
void | set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
Connect port to timeCaller[portNum]. | |
void | set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
Connect port to tlmOut[portNum]. | |
void | set_seqRunOut_OutputPort (FwIndexType portNum, Svc::InputCmdSeqInPort *port) |
Connect port to seqRunOut[portNum]. | |
void | regCommands () |
Register commands with the Command Dispatcher. | |
![]() | |
void | start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT) |
called by instantiator when task is to be started | |
void | exit () |
exit task in active component | |
Os::Task::Status | join () |
Join the thread. | |
DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()") | |
Join to thread with discarded value_ptr. | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. | |
U32 | getIdBase () const |
Protected Member Functions | |
void | seqDoneIn_handler (NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
Handler for input port seqDoneIn. | |
void | seqStartIn_handler (NATIVE_INT_TYPE portNum, const Fw::StringBase &fileName) |
Handler for input port seqStartIn. | |
void | seqRunIn_handler (NATIVE_INT_TYPE portNum, const Fw::StringBase &fileName) |
Handler for input port seqRunIn. | |
![]() | |
SeqDispatcherComponentBase (const char *compName="") | |
Construct SeqDispatcherComponentBase object. | |
virtual | ~SeqDispatcherComponentBase () |
Destroy SeqDispatcherComponentBase object. | |
FwIndexType | getNum_cmdIn_InputPorts () const |
FwIndexType | getNum_seqDoneIn_InputPorts () const |
FwIndexType | getNum_seqRunIn_InputPorts () const |
FwIndexType | getNum_seqStartIn_InputPorts () const |
FwIndexType | getNum_cmdRegOut_OutputPorts () const |
FwIndexType | getNum_cmdResponseOut_OutputPorts () const |
FwIndexType | getNum_logOut_OutputPorts () const |
FwIndexType | getNum_timeCaller_OutputPorts () const |
FwIndexType | getNum_tlmOut_OutputPorts () const |
FwIndexType | getNum_seqRunOut_OutputPorts () const |
bool | isConnected_cmdRegOut_OutputPort (FwIndexType portNum) |
bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) |
bool | isConnected_logOut_OutputPort (FwIndexType portNum) |
bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) |
bool | isConnected_tlmOut_OutputPort (FwIndexType portNum) |
bool | isConnected_seqRunOut_OutputPort (FwIndexType portNum) |
void | seqDoneIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
Handler base-class function for input port seqDoneIn. | |
void | seqRunIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename) |
Handler base-class function for input port seqRunIn. | |
void | seqStartIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename) |
Handler base-class function for input port seqStartIn. | |
virtual void | seqDoneIn_preMsgHook (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
Pre-message hook for async input port seqDoneIn. | |
virtual void | seqRunIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename) |
Pre-message hook for async input port seqRunIn. | |
virtual void | seqStartIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename) |
Pre-message hook for async input port seqStartIn. | |
void | seqRunOut_out (FwIndexType portNum, const Fw::StringBase &filename) |
Invoke output port seqRunOut. | |
void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
Emit command response. | |
void | RUN_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
void | LOG_STATUS_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
virtual void | RUN_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command RUN. | |
virtual void | LOG_STATUS_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command LOG_STATUS. | |
void | log_WARNING_HI_InvalidSequencer (U16 idx) const |
Log event InvalidSequencer. | |
void | log_WARNING_HI_NoAvailableSequencers () const |
Log event NoAvailableSequencers. | |
void | log_WARNING_LO_UnknownSequenceFinished (U16 idx) const |
Log event UnknownSequenceFinished. | |
void | log_WARNING_HI_ConflictingSequenceStarted (U16 idx, const Fw::StringBase &newSequence, const Fw::StringBase &sequenceInInternalState) const |
Log event ConflictingSequenceStarted. | |
void | log_WARNING_LO_UnexpectedSequenceStarted (U16 idx, const Fw::StringBase &newSequence) const |
Log event UnexpectedSequenceStarted. | |
void | log_ACTIVITY_LO_LogSequencerStatus (U16 idx, Svc::SeqDispatcher_CmdSequencerState state, const Fw::StringBase &filename) const |
Log event LogSequencerStatus. | |
void | tlmWrite_dispatchedCount (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
void | tlmWrite_errorCount (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
void | tlmWrite_sequencersAvailable (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
Fw::Time | getTime () |
![]() | |
ActiveComponentBase (const char *name) | |
Constructor. | |
virtual | ~ActiveComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
initialization code | |
virtual void | preamble () |
A function that will be called before the event loop is entered. | |
MsgDispatchStatus | dispatch () |
The function that will dispatching messages. | |
virtual void | finalizer () |
A function that will be called after exiting the loop. | |
![]() | |
QueuedComponentBase (const char *name) | |
Constructor. | |
virtual | ~QueuedComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
initialization function | |
Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
NATIVE_INT_TYPE | getNumMsgsDropped () |
return number of messages dropped | |
void | incNumMsgDropped () |
increment the number of messages dropped | |
![]() | |
PassiveComponentBase (const char *name) | |
Named constructor. | |
virtual | ~PassiveComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
Initialization function. | |
NATIVE_INT_TYPE | getInstance () const |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. | |
virtual | ~ObjBase () |
Destructor. | |
void | init () |
Object initializer. | |
Definition at line 18 of file SeqDispatcher.hpp.
Svc::SeqDispatcher::SeqDispatcher | ( | const char *const | compName | ) |
Construct object SeqDispatcher
compName | The component name |
Definition at line 15 of file SeqDispatcher.cpp.
Svc::SeqDispatcher::~SeqDispatcher | ( | ) |
Destroy object SeqDispatcher
Definition at line 18 of file SeqDispatcher.cpp.
|
protectedvirtual |
Handler for input port seqDoneIn.
portNum | The port number |
opCode | Command Op Code |
cmdSeq | Command Sequence |
response | The command response argument |
Implements Svc::SeqDispatcherComponentBase.
Definition at line 93 of file SeqDispatcher.cpp.
|
protectedvirtual |
Handler for input port seqRunIn.
portNum | The port number |
fileName | The sequence file |
Implements Svc::SeqDispatcherComponentBase.
Definition at line 139 of file SeqDispatcher.cpp.
|
protectedvirtual |
Handler for input port seqStartIn.
portNum | The port number |
fileName | The sequence file |
Implements Svc::SeqDispatcherComponentBase.
Definition at line 60 of file SeqDispatcher.cpp.