![]() |
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>
Protected Member Functions | |
SeqDispatcherComponentBase (const char *compName="") | |
Construct SeqDispatcherComponentBase object. More... | |
virtual | ~SeqDispatcherComponentBase () |
Destroy SeqDispatcherComponentBase object. More... | |
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) |
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)=0 |
Handler for input port seqRunIn. More... | |
virtual void | seqStartIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=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) |
Handler base-class function for input port seqRunIn. More... | |
void | seqStartIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename) |
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) |
Pre-message hook for async input port seqRunIn. More... | |
virtual void | seqStartIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename) |
Pre-message hook for async input port seqStartIn. More... | |
void | seqRunOut_out (FwIndexType portNum, const Fw::StringBase &filename) |
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, Fw::Wait block)=0 |
virtual void | LOG_STATUS_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
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. More... | |
virtual void | LOG_STATUS_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command LOG_STATUS. 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, Svc::SeqDispatcher_CmdSequencerState state, const Fw::StringBase &filename) const |
Log event LogSequencerStatus. More... | |
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. More... | |
virtual | ~ActiveComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE 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... | |
![]() | |
QueuedComponentBase (const char *name) | |
Constructor. More... | |
virtual | ~QueuedComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
initialization function More... | |
Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
NATIVE_INT_TYPE | getNumMsgsDropped () |
return number of messages dropped More... | |
void | incNumMsgDropped () |
increment the number of messages dropped More... | |
![]() | |
PassiveComponentBase (const char *name) | |
Named constructor. More... | |
virtual | ~PassiveComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
Initialization function. More... | |
NATIVE_INT_TYPE | getInstance () const |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. More... | |
virtual | ~ObjBase () |
Destructor. More... | |
void | init () |
Object initializer. More... | |
Friends | |
class | SeqDispatcherComponentBaseFriend |
Friend class for white-box testing. More... | |
Additional Inherited Members | |
![]() | |
enum | { ACTIVE_COMPONENT_EXIT } |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT } |
![]() | |
Os::Task | m_task |
task object for active component More... | |
![]() | |
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 36 of file SeqDispatcherComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDIN_INPUT_PORTS |
Definition at line 54 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 59 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 66 of file SeqDispatcherComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_SEQRUNOUT_OUTPUT_PORTS |
Definition at line 76 of file SeqDispatcherComponentAc.hpp.
|
protected |
Command opcodes.
Enumerator | |
---|---|
OPCODE_RUN | Dispatches a sequence to the first available sequencer. |
OPCODE_LOG_STATUS | Logs via Events the state of each connected command sequencer. |
Definition at line 81 of file SeqDispatcherComponentAc.hpp.
|
protected |
Event IDs.
Enumerator | |
---|---|
EVENTID_INVALIDSEQUENCER | |
EVENTID_NOAVAILABLESEQUENCERS | |
EVENTID_UNKNOWNSEQUENCEFINISHED | |
EVENTID_CONFLICTINGSEQUENCESTARTED | |
EVENTID_UNEXPECTEDSEQUENCESTARTED | |
EVENTID_LOGSEQUENCERSTATUS |
Definition at line 87 of file SeqDispatcherComponentAc.hpp.
|
protected |
Channel IDs.
Enumerator | |
---|---|
CHANNELID_DISPATCHEDCOUNT | Channel ID for dispatchedCount. |
CHANNELID_ERRORCOUNT | Channel ID for errorCount. |
CHANNELID_SEQUENCERSAVAILABLE | Channel ID for sequencersAvailable. |
Definition at line 97 of file SeqDispatcherComponentAc.hpp.
|
protected |
Construct SeqDispatcherComponentBase object.
compName | The component name |
Definition at line 629 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Destroy SeqDispatcherComponentBase object.
Definition at line 636 of file SeqDispatcherComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 1060 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 331 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 346 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 357 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 368 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of cmdIn input ports
Definition at line 646 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of cmdRegOut output ports
Definition at line 678 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of cmdResponseOut output ports
Definition at line 684 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of logOut output ports
Definition at line 690 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of seqDoneIn input ports
Definition at line 656 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of seqRunIn input ports
Definition at line 662 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of seqRunOut output ports
Definition at line 722 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of seqStartIn input ports
Definition at line 668 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of timeCaller output ports
Definition at line 706 of file SeqDispatcherComponentAc.cpp.
|
protected |
Get the number of tlmOut output ports
Definition at line 712 of file SeqDispatcherComponentAc.cpp.
|
protected |
void Svc::SeqDispatcherComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize SeqDispatcherComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 76 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
portNum | The port number |
Definition at line 732 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
portNum | The port number |
Definition at line 743 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port logOut is connected
portNum | The port number |
Definition at line 754 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port seqRunOut is connected
portNum | The port number |
Definition at line 806 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
portNum | The port number |
Definition at line 780 of file SeqDispatcherComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
portNum | The port number |
Definition at line 791 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event LogSequencerStatus.
Definition at line 1650 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 1136 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command LOG_STATUS.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1214 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event ConflictingSequenceStarted.
Definition at line 1458 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event InvalidSequencer.
Definition at line 1229 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event NoAvailableSequencers.
Definition at line 1311 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event UnexpectedSequenceStarted.
Definition at line 1558 of file SeqDispatcherComponentAc.cpp.
|
protected |
Log event UnknownSequenceFinished.
Definition at line 1376 of file SeqDispatcherComponentAc.cpp.
void Svc::SeqDispatcherComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 611 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 1077 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command RUN.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1203 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 823 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 1008 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for input port seqRunIn.
portNum | The port number |
filename | The sequence file |
Implemented in Svc::SeqDispatcher.
|
protected |
Handler base-class function for input port seqRunIn.
portNum | The port number |
filename | The sequence file |
Definition at line 894 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port seqRunIn.
portNum | The port number |
filename | The sequence file |
Definition at line 1019 of file SeqDispatcherComponentAc.cpp.
|
protected |
Invoke output port seqRunOut.
portNum | The port number |
filename | The sequence file |
Definition at line 1041 of file SeqDispatcherComponentAc.cpp.
|
protectedpure virtual |
Handler for input port seqStartIn.
portNum | The port number |
filename | The sequence file |
Implemented in Svc::SeqDispatcher.
|
protected |
Handler base-class function for input port seqStartIn.
portNum | The port number |
filename | The sequence file |
Definition at line 947 of file SeqDispatcherComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port seqStartIn.
portNum | The port number |
filename | The sequence file |
Definition at line 1028 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 383 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 397 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 411 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 475 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 443 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 457 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 1767 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 1800 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 1833 of file SeqDispatcherComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 45 of file SeqDispatcherComponentAc.hpp.