![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for SeqDispatcher component. More...
#include <Svc/SeqDispatcher/SeqDispatcherComponentAc.hpp>
Public Member Functions | |
| void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
| Initialize SeqDispatcherComponentBase object. More... | |
| 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]. 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_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_seqCancelOut_OutputPort (FwIndexType portNum, Svc::InputCmdSeqCancelPort *port) |
| Connect port to seqCancelOut[portNum]. More... | |
| void | set_seqRunOut_OutputPort (FwIndexType portNum, Svc::InputCmdSeqInPort *port) |
| Connect port to seqRunOut[portNum]. More... | |
| void | regCommands () |
| Register commands with the Command Dispatcher. 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 | |
| SeqDispatcherComponentBase (const char *compName="") | |
| Construct SeqDispatcherComponentBase object. More... | |
| virtual | ~SeqDispatcherComponentBase () |
| Destroy SeqDispatcherComponentBase object. More... | |
| bool | isConnected_cmdRegOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_cmdResponseOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_logOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) const |
| bool | isConnected_tlmOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_seqCancelOut_OutputPort (FwIndexType portNum) const |
| bool | isConnected_seqRunOut_OutputPort (FwIndexType portNum) const |
| void | cmdIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| Handler base-class function for input port cmdIn. More... | |
| virtual void | seqDoneIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0 |
| Handler for input port seqDoneIn. More... | |
| virtual void | seqRunIn_handler (FwIndexType portNum, const Fw::StringBase &filename, const Svc::SeqArgs &args)=0 |
| Handler for input port seqRunIn. More... | |
| virtual void | seqStartIn_handler (FwIndexType portNum, const Fw::StringBase &filename, const Svc::SeqArgs &args)=0 |
| Handler for input port seqStartIn. More... | |
| void | seqDoneIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
| Handler base-class function for input port seqDoneIn. More... | |
| void | seqRunIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename, const Svc::SeqArgs &args) |
| Handler base-class function for input port seqRunIn. More... | |
| void | seqStartIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename, const Svc::SeqArgs &args) |
| Handler base-class function for input port seqStartIn. More... | |
| virtual void | seqDoneIn_preMsgHook (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
| Pre-message hook for async input port seqDoneIn. More... | |
| virtual void | seqRunIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename, const Svc::SeqArgs &args) |
| Pre-message hook for async input port seqRunIn. More... | |
| virtual void | seqStartIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename, const Svc::SeqArgs &args) |
| Pre-message hook for async input port seqStartIn. More... | |
| void | seqCancelOut_out (FwIndexType portNum) const |
| Invoke output port seqCancelOut. More... | |
| void | seqRunOut_out (FwIndexType portNum, const Fw::StringBase &filename, const Svc::SeqArgs &args) const |
| Invoke output port seqRunOut. More... | |
| 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, const Svc::BlockState &block)=0 |
| virtual void | RUN_ARGS_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName, const Svc::BlockState &block, const Svc::SeqArgs &buffer)=0 |
| virtual void | LOG_STATUS_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| virtual void | CANCEL_NAME_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName)=0 |
| virtual void | CANCEL_ALL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| void | RUN_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | RUN_ARGS_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | LOG_STATUS_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CANCEL_NAME_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CANCEL_ALL_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 | RUN_ARGS_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command RUN_ARGS. More... | |
| virtual void | LOG_STATUS_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command LOG_STATUS. More... | |
| virtual void | CANCEL_NAME_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CANCEL_NAME. More... | |
| virtual void | CANCEL_ALL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CANCEL_ALL. More... | |
| void | log_WARNING_HI_InvalidSequencer (U16 idx) const |
| Log event InvalidSequencer. More... | |
| void | log_WARNING_HI_NoAvailableSequencers () const |
| Log event NoAvailableSequencers. More... | |
| void | log_WARNING_LO_UnknownSequenceFinished (U16 idx) const |
| Log event UnknownSequenceFinished. More... | |
| void | log_WARNING_HI_ConflictingSequenceStarted (U16 idx, const Fw::StringBase &newSequence, const Fw::StringBase &sequenceInInternalState) const |
| Log event ConflictingSequenceStarted. More... | |
| void | log_WARNING_LO_UnexpectedSequenceStarted (U16 idx, const Fw::StringBase &newSequence) const |
| Log event UnexpectedSequenceStarted. More... | |
| void | log_ACTIVITY_LO_LogSequencerStatus (U16 idx, const Svc::SeqDispatcher_CmdSequencerState &state, const Fw::StringBase &filename) const |
| Log event LogSequencerStatus. More... | |
| void | log_ACTIVITY_HI_SequenceCanceled (U16 idx, const Fw::StringBase &filename) const |
| Log event SequenceCanceled. More... | |
| void | log_WARNING_LO_CancelSequenceNotFound (const Fw::StringBase &filename) const |
| Log event CancelSequenceNotFound. More... | |
| void | tlmWrite (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const |
| 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 |
| void | tlmWrite_canceledCount (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| 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... | |
Static Protected Member Functions | |
| static constexpr FwIndexType | getNum_cmdIn_InputPorts () |
| static constexpr FwIndexType | getNum_seqDoneIn_InputPorts () |
| static constexpr FwIndexType | getNum_seqRunIn_InputPorts () |
| static constexpr FwIndexType | getNum_seqStartIn_InputPorts () |
| static constexpr FwIndexType | getNum_cmdRegOut_OutputPorts () |
| static constexpr FwIndexType | getNum_cmdResponseOut_OutputPorts () |
| static constexpr FwIndexType | getNum_logOut_OutputPorts () |
| static constexpr FwIndexType | getNum_timeCaller_OutputPorts () |
| static constexpr FwIndexType | getNum_tlmOut_OutputPorts () |
| static constexpr FwIndexType | getNum_seqCancelOut_OutputPorts () |
| static constexpr FwIndexType | getNum_seqRunOut_OutputPorts () |
Friends | |
| class | SeqDispatcherTesterBase |
| Friend class tester to support autocoded test harness. More... | |
| class | SeqDispatcherTester |
| 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... | |
Auto-generated base for SeqDispatcher component.
Dispatches command sequences to available command sequencers
Definition at line 43 of file SeqDispatcherComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
| Enumerator | |
|---|---|
| NUM_CMDIN_INPUT_PORTS | |
Definition at line 63 of file SeqDispatcherComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_SEQDONEIN_INPUT_PORTS | |
| NUM_SEQRUNIN_INPUT_PORTS | |
| NUM_SEQSTARTIN_INPUT_PORTS | |
Definition at line 68 of file SeqDispatcherComponentAc.hpp.
|
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_TIMECALLER_OUTPUT_PORTS | |
| NUM_TLMOUT_OUTPUT_PORTS | |
Definition at line 75 of file SeqDispatcherComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_SEQCANCELOUT_OUTPUT_PORTS | |
| NUM_SEQRUNOUT_OUTPUT_PORTS | |
Definition at line 85 of file SeqDispatcherComponentAc.hpp.
|
protected |
Command opcodes.
Definition at line 91 of file SeqDispatcherComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 101 of file SeqDispatcherComponentAc.hpp.
|
protected |
Channel IDs.
Definition at line 113 of file SeqDispatcherComponentAc.hpp.
|
protected |
Construct SeqDispatcherComponentBase object.
| compName | The component name |
Definition at line 726 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Destroy SeqDispatcherComponentBase object.
Definition at line 733 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for command CANCEL_ALL
Broadcast a cancel to every running sequencer. This does not exclude the caller! A sequence issuing CANCEL_ALL will cancel itself is connected to this seqDispatcher.
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CANCEL_ALL
Broadcast a cancel to every running sequencer. This does not exclude the caller! A sequence issuing CANCEL_ALL will cancel itself is connected to this seqDispatcher.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1459 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CANCEL_ALL.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1570 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for command CANCEL_NAME
Cancels any running sequence matching the given file name
| opCode | The opcode |
| cmdSeq | The command sequence number |
| fileName | The name of the sequence file to cancel |
|
protected |
Base-class handler function for command CANCEL_NAME
Cancels any running sequence matching the given file name
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1400 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CANCEL_NAME.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1559 of file SeqDispatcherComponentAc.cpp.
|
protected |
Handler base-class function for input port cmdIn.
| portNum | The port number |
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 853 of file SeqDispatcherComponentAc.cpp.
|
protected |
Emit command response.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| response | The command response |
Definition at line 1206 of file SeqDispatcherComponentAc.cpp.
| Fw::InputCmdPort * Svc::SeqDispatcherComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
| portNum | The port number |
Definition at line 369 of file SeqDispatcherComponentAc.cpp.
| Fw::InputCmdResponsePort * Svc::SeqDispatcherComponentBase::get_seqDoneIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 388 of file SeqDispatcherComponentAc.cpp.
| Svc::InputCmdSeqInPort * Svc::SeqDispatcherComponentBase::get_seqRunIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 399 of file SeqDispatcherComponentAc.cpp.
| Svc::InputCmdSeqInPort * Svc::SeqDispatcherComponentBase::get_seqStartIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 410 of file SeqDispatcherComponentAc.cpp.
|
inlinestaticprotected |
Get the number of cmdIn input ports
Definition at line 358 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdRegOut output ports
Definition at line 398 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of cmdResponseOut output ports
Definition at line 405 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of logOut output ports
Definition at line 412 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of seqCancelOut output ports
Definition at line 450 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of seqDoneIn input ports
Definition at line 371 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of seqRunIn input ports
Definition at line 378 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of seqRunOut output ports
Definition at line 457 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of seqStartIn input ports
Definition at line 385 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of timeCaller output ports
Definition at line 430 of file SeqDispatcherComponentAc.hpp.
|
inlinestaticprotected |
Get the number of tlmOut output ports
Definition at line 437 of file SeqDispatcherComponentAc.hpp.
|
protected |
| void Svc::SeqDispatcherComponentBase::init | ( | FwSizeType | queueDepth, |
| FwEnumStoreType | instance = 0 |
||
| ) |
Initialize SeqDispatcherComponentBase object.
| queueDepth | The queue depth |
| instance | The instance number |
Definition at line 71 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
| portNum | The port number |
Definition at line 745 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
| portNum | The port number |
Definition at line 756 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port logOut is connected
| portNum | The port number |
Definition at line 767 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port seqCancelOut is connected
| portNum | The port number |
Definition at line 823 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port seqRunOut is connected
| portNum | The port number |
Definition at line 834 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
| portNum | The port number |
Definition at line 793 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
| portNum | The port number |
Definition at line 804 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event SequenceCanceled.
Definition at line 2131 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event LogSequencerStatus.
Definition at line 2015 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for command LOG_STATUS
Logs via Events the state of each connected command sequencer
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command LOG_STATUS
Logs via Events the state of each connected command sequencer
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1341 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command LOG_STATUS.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1548 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event ConflictingSequenceStarted.
Definition at line 1814 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event InvalidSequencer.
Definition at line 1585 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event NoAvailableSequencers.
Definition at line 1667 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event CancelSequenceNotFound.
Definition at line 2226 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event UnexpectedSequenceStarted.
Definition at line 1920 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event UnknownSequenceFinished.
Definition at line 1732 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 691 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for command RUN_ARGS
Dispatches a sequence with arguments to the first available sequencer
| opCode | The opcode |
| cmdSeq | The command sequence number |
| fileName | The name of the sequence file |
| block | Return command status when complete or not |
| buffer | Arguments to pass to a sequencer |
|
protected |
Base-class handler function for command RUN_ARGS
Dispatches a sequence with arguments to the first available sequencer
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1282 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command RUN_ARGS.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1537 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for command RUN
Dispatches a sequence to the first available sequencer
| opCode | The opcode |
| cmdSeq | The command sequence number |
| fileName | The name of the sequence file |
| block | Return command status when complete or not |
|
protected |
Base-class handler function for command RUN
Dispatches a sequence to the first available sequencer
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1223 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command RUN.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 1526 of file SeqDispatcherComponentAc.cpp.
|
protected |
Invoke output port seqCancelOut.
| portNum | The port number |
Definition at line 1163 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for input port seqDoneIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
Implemented in Svc::SeqDispatcher.
|
protected |
Handler base-class function for input port seqDoneIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
Definition at line 923 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port seqDoneIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
Definition at line 1126 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for input port seqRunIn.
| portNum | The port number |
| filename | The sequence file |
| args | Sequence arguments |
Implemented in Svc::SeqDispatcher.
|
protected |
Handler base-class function for input port seqRunIn.
| portNum | The port number |
| filename | The sequence file |
| args | Sequence arguments |
Definition at line 994 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port seqRunIn.
| portNum | The port number |
| filename | The sequence file |
| args | Sequence arguments |
Definition at line 1137 of file SeqDispatcherComponentAc.cpp.
|
protected |
Invoke output port seqRunOut.
| portNum | The port number |
| filename | The sequence file |
| args | Sequence arguments |
Definition at line 1178 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for input port seqStartIn.
| portNum | The port number |
| filename | The sequence file |
| args | Sequence arguments |
Implemented in Svc::SeqDispatcher.
|
protected |
Handler base-class function for input port seqStartIn.
| portNum | The port number |
| filename | The sequence file |
| args | Sequence arguments |
Definition at line 1056 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port seqStartIn.
| portNum | The port number |
| filename | The sequence file |
| args | Sequence arguments |
Definition at line 1147 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::set_cmdRegOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdRegPort * | port | ||
| ) |
Connect port to cmdRegOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 429 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdResponsePort * | port | ||
| ) |
Connect port to cmdResponseOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 443 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::set_logOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to logOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 457 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::set_seqCancelOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputCmdSeqCancelPort * | port | ||
| ) |
Connect port to seqCancelOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 525 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::set_seqRunOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputCmdSeqInPort * | port | ||
| ) |
Connect port to seqRunOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 539 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to timeCaller[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 489 of file SeqDispatcherComponentAc.cpp.
| void Svc::SeqDispatcherComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTlmPort * | port | ||
| ) |
Connect port to tlmOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 503 of file SeqDispatcherComponentAc.cpp.
|
protected |
Write telemetry channel given its local id and serialized value. Warning: This is a low level telemetry interface that does not guarentee channel type safety. It is up to the caller to make sure the serialized data matches the definition in the model. Update on change semantics are ignored, this telemetry is always written
| id | The channel id |
| _tlmBuff | The serialized telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 2305 of file SeqDispatcherComponentAc.cpp.
|
protected |
Write telemetry channel canceledCount
Number of sequences canceled by the CANCEL_NAME and CANCEL_ALL commands
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 2402 of file SeqDispatcherComponentAc.cpp.
|
protected |
Write telemetry channel dispatchedCount
Number of sequences dispatched
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 2336 of file SeqDispatcherComponentAc.cpp.
|
protected |
Write telemetry channel errorCount
Number of sequences dispatched that returned an error. Note: if a sequence was run in non-blocking mode, even if the sequence errors out, this error count will never increase
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 2358 of file SeqDispatcherComponentAc.cpp.
|
protected |
Write telemetry channel sequencersAvailable
Number of sequencers in an available state
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 2380 of file SeqDispatcherComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 54 of file SeqDispatcherComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 52 of file SeqDispatcherComponentAc.hpp.