![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for CmdSequencer component. More...
#include <Svc/CmdSequencer/CmdSequencerComponentAc.hpp>
Protected Member Functions | |
| CmdSequencerComponentBase (const char *compName="") | |
| Construct CmdSequencerComponentBase object. | |
| virtual | ~CmdSequencerComponentBase () |
| Destroy CmdSequencerComponentBase object. | |
| FwIndexType | getNum_cmdIn_InputPorts () const |
| FwIndexType | getNum_cmdResponseIn_InputPorts () const |
| FwIndexType | getNum_pingIn_InputPorts () const |
| FwIndexType | getNum_schedIn_InputPorts () const |
| FwIndexType | getNum_seqCancelIn_InputPorts () const |
| FwIndexType | getNum_seqRunIn_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_comCmdOut_OutputPorts () const |
| FwIndexType | getNum_pingOut_OutputPorts () const |
| FwIndexType | getNum_seqDone_OutputPorts () const |
| FwIndexType | getNum_seqStartOut_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_comCmdOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
| bool | isConnected_seqDone_OutputPort (FwIndexType portNum) |
| bool | isConnected_seqStartOut_OutputPort (FwIndexType portNum) |
| virtual void | cmdResponseIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0 |
| Handler for input port cmdResponseIn. | |
| virtual void | pingIn_handler (FwIndexType portNum, U32 key)=0 |
| Handler for input port pingIn. | |
| virtual void | schedIn_handler (FwIndexType portNum, U32 context)=0 |
| Handler for input port schedIn. | |
| virtual void | seqCancelIn_handler (FwIndexType portNum)=0 |
| Handler for input port seqCancelIn. | |
| virtual void | seqRunIn_handler (FwIndexType portNum, const Fw::StringBase &filename)=0 |
| Handler for input port seqRunIn. | |
| void | cmdResponseIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
| Handler base-class function for input port cmdResponseIn. | |
| void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
| Handler base-class function for input port pingIn. | |
| void | schedIn_handlerBase (FwIndexType portNum, U32 context) |
| Handler base-class function for input port schedIn. | |
| void | seqCancelIn_handlerBase (FwIndexType portNum) |
| Handler base-class function for input port seqCancelIn. | |
| void | seqRunIn_handlerBase (FwIndexType portNum, const Fw::StringBase &filename) |
| Handler base-class function for input port seqRunIn. | |
| virtual void | cmdResponseIn_preMsgHook (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
| Pre-message hook for async input port cmdResponseIn. | |
| virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
| Pre-message hook for async input port pingIn. | |
| virtual void | schedIn_preMsgHook (FwIndexType portNum, U32 context) |
| Pre-message hook for async input port schedIn. | |
| virtual void | seqCancelIn_preMsgHook (FwIndexType portNum) |
| Pre-message hook for async input port seqCancelIn. | |
| virtual void | seqRunIn_preMsgHook (FwIndexType portNum, const Fw::StringBase &filename) |
| Pre-message hook for async input port seqRunIn. | |
| void | comCmdOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
| Invoke output port comCmdOut. | |
| void | pingOut_out (FwIndexType portNum, U32 key) |
| Invoke output port pingOut. | |
| void | seqDone_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) |
| Invoke output port seqDone. | |
| void | seqStartOut_out (FwIndexType portNum, const Fw::StringBase &filename) |
| Invoke output port seqStartOut. | |
| void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
| Emit command response. | |
| virtual void | CS_RUN_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName, Svc::CmdSequencer_BlockState block)=0 |
| virtual void | CS_VALIDATE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName)=0 |
| virtual void | CS_CANCEL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| virtual void | CS_START_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| virtual void | CS_STEP_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| virtual void | CS_AUTO_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| virtual void | CS_MANUAL_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| virtual void | CS_JOIN_WAIT_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
| void | CS_RUN_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CS_VALIDATE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CS_CANCEL_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CS_START_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CS_STEP_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CS_AUTO_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CS_MANUAL_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | CS_JOIN_WAIT_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| virtual void | CS_RUN_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_RUN. | |
| virtual void | CS_VALIDATE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_VALIDATE. | |
| virtual void | CS_CANCEL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_CANCEL. | |
| virtual void | CS_START_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_START. | |
| virtual void | CS_STEP_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_STEP. | |
| virtual void | CS_AUTO_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_AUTO. | |
| virtual void | CS_MANUAL_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_MANUAL. | |
| virtual void | CS_JOIN_WAIT_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
| Pre-message hook for command CS_JOIN_WAIT. | |
| void | log_ACTIVITY_LO_CS_SequenceLoaded (const Fw::StringBase &fileName) const |
| void | log_ACTIVITY_HI_CS_SequenceCanceled (const Fw::StringBase &fileName) const |
| void | log_WARNING_HI_CS_FileReadError (const Fw::StringBase &fileName) const |
| void | log_WARNING_HI_CS_FileInvalid (const Fw::StringBase &fileName, Svc::CmdSequencer_FileReadStage stage, I32 error) const |
| void | log_WARNING_HI_CS_RecordInvalid (const Fw::StringBase &fileName, U32 recordNumber, I32 error) const |
| void | log_WARNING_HI_CS_FileSizeError (const Fw::StringBase &fileName, U32 size) const |
| void | log_WARNING_HI_CS_FileNotFound (const Fw::StringBase &fileName) const |
| void | log_WARNING_HI_CS_FileCrcFailure (const Fw::StringBase &fileName, U32 storedCRC, U32 computedCRC) const |
| void | log_ACTIVITY_LO_CS_CommandComplete (const Fw::StringBase &fileName, U32 recordNumber, U32 opCode) const |
| void | log_ACTIVITY_HI_CS_SequenceComplete (const Fw::StringBase &fileName) const |
| void | log_WARNING_HI_CS_CommandError (const Fw::StringBase &fileName, U32 recordNumber, U32 opCode, U32 errorStatus) const |
| void | log_WARNING_HI_CS_InvalidMode () const |
| void | log_WARNING_HI_CS_RecordMismatch (const Fw::StringBase &fileName, U32 header_records, U32 extra_bytes) const |
| void | log_WARNING_HI_CS_TimeBaseMismatch (const Fw::StringBase &fileName, U16 time_base, U16 seq_time_base) const |
| void | log_WARNING_HI_CS_TimeContextMismatch (const Fw::StringBase &fileName, U8 currTimeBase, U8 seqTimeBase) const |
| void | log_ACTIVITY_HI_CS_PortSequenceStarted (const Fw::StringBase &filename) const |
| void | log_WARNING_HI_CS_UnexpectedCompletion (U32 opcode) const |
| void | log_ACTIVITY_HI_CS_ModeSwitched (Svc::CmdSequencer_SeqMode mode) const |
| void | log_WARNING_LO_CS_NoSequenceActive () const |
| void | log_ACTIVITY_HI_CS_SequenceValid (const Fw::StringBase &filename) const |
| void | log_WARNING_HI_CS_SequenceTimeout (const Fw::StringBase &filename, U32 command) const |
| void | log_ACTIVITY_HI_CS_CmdStepped (const Fw::StringBase &filename, U32 command) const |
| void | log_ACTIVITY_HI_CS_CmdStarted (const Fw::StringBase &filename) const |
| void | log_ACTIVITY_HI_CS_JoinWaiting (const Fw::StringBase &filename, U32 recordNumber, U32 opCode) const |
| void | log_WARNING_HI_CS_JoinWaitingNotComplete () const |
| void | log_WARNING_LO_CS_NoRecords (const Fw::StringBase &fileName) const |
| Log event CS_NoRecords. | |
| void | tlmWrite_CS_LoadCommands (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CS_CancelCommands (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CS_Errors (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CS_CommandsExecuted (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CS_SequencesCompleted (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| Fw::Time | getTime () |
Protected Member Functions inherited from Fw::ActiveComponentBase | |
| 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. | |
Protected Member Functions inherited from Fw::QueuedComponentBase | |
| 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 | |
Protected Member Functions inherited from Fw::PassiveComponentBase | |
| PassiveComponentBase (const char *name) | |
| Named constructor. | |
| virtual | ~PassiveComponentBase () |
| Destructor. | |
| void | init (NATIVE_INT_TYPE instance) |
| Initialization function. | |
| NATIVE_INT_TYPE | getInstance () const |
Protected Member Functions inherited from Fw::ObjBase | |
| ObjBase (const char *name) | |
| ObjBase constructor. | |
| virtual | ~ObjBase () |
| Destructor. | |
| void | init () |
| Object initializer. | |
Friends | |
| class | CmdSequencerComponentBaseFriend |
| Friend class for white-box testing. | |
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 | |
Protected Attributes inherited from Fw::QueuedComponentBase | |
| Os::Queue | m_queue |
| queue object for active component | |
Auto-generated base for CmdSequencer component.
A component for running command sequences
Definition at line 41 of file CmdSequencerComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
| Enumerator | |
|---|---|
| NUM_CMDIN_INPUT_PORTS | |
Definition at line 59 of file CmdSequencerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_CMDRESPONSEIN_INPUT_PORTS | |
| NUM_PINGIN_INPUT_PORTS | |
| NUM_SCHEDIN_INPUT_PORTS | |
| NUM_SEQCANCELIN_INPUT_PORTS | |
| NUM_SEQRUNIN_INPUT_PORTS | |
Definition at line 64 of file CmdSequencerComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
| Enumerator | |
|---|---|
| NUM_LOGTEXT_OUTPUT_PORTS | |
| NUM_CMDREGOUT_OUTPUT_PORTS | |
| NUM_CMDRESPONSEOUT_OUTPUT_PORTS | |
| NUM_LOGOUT_OUTPUT_PORTS | |
| NUM_TIMECALLER_OUTPUT_PORTS | |
| NUM_TLMOUT_OUTPUT_PORTS | |
Definition at line 73 of file CmdSequencerComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
| Enumerator | |
|---|---|
| NUM_COMCMDOUT_OUTPUT_PORTS | |
| NUM_PINGOUT_OUTPUT_PORTS | |
| NUM_SEQDONE_OUTPUT_PORTS | |
| NUM_SEQSTARTOUT_OUTPUT_PORTS | |
Definition at line 83 of file CmdSequencerComponentAc.hpp.
|
protected |
Command opcodes.
Definition at line 91 of file CmdSequencerComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 103 of file CmdSequencerComponentAc.hpp.
|
protected |
Channel IDs.
Definition at line 133 of file CmdSequencerComponentAc.hpp.
|
protected |
Construct CmdSequencerComponentBase object.
| compName | The component name |
Definition at line 872 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Destroy CmdSequencerComponentBase object.
Definition at line 879 of file CmdSequencerComponentAc.cpp.
|
protected |
Emit command response.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| response | The command response |
Definition at line 1525 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port cmdResponseIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
|
protected |
Handler base-class function for input port cmdResponseIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
Definition at line 1129 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port cmdResponseIn.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
Definition at line 1407 of file CmdSequencerComponentAc.cpp.
|
protected |
Invoke output port comCmdOut.
| portNum | The port number |
| data | Buffer containing packet data |
| context | Call context value; meaning chosen by user |
Definition at line 1455 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_AUTO
Set the run mode to AUTO.
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CS_AUTO
Set the run mode to AUTO.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1837 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_AUTO.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2077 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_CANCEL
Cancel a command sequence
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CS_CANCEL
Cancel a command sequence
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1660 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_CANCEL.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2044 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_JOIN_WAIT
Wait for sequences that are running to finish. Allow user to run multiple seq files in SEQ_NO_BLOCK mode then wait for them to finish before allowing more seq run request.
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CS_JOIN_WAIT
Wait for sequences that are running to finish. Allow user to run multiple seq files in SEQ_NO_BLOCK mode then wait for them to finish before allowing more seq run request.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1955 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_JOIN_WAIT.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2099 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_MANUAL
Set the run mode to MANUAL.
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CS_MANUAL
Set the run mode to MANUAL.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1896 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_MANUAL.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2088 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_RUN
Run a command sequence file
| 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 CS_RUN
Run a command sequence file
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1542 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_RUN.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2022 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_START
Start running a command sequence
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CS_START
Start running a command sequence
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1719 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_START.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2055 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_STEP
Perform one step in a command sequence. Valid only if CmdSequencer is in MANUAL run mode.
| opCode | The opcode |
| cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command CS_STEP
Perform one step in a command sequence. Valid only if CmdSequencer is in MANUAL run mode.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1778 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_STEP.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2066 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for command CS_VALIDATE
Validate a command sequence file
| opCode | The opcode |
| cmdSeq | The command sequence number |
| fileName | The name of the sequence file |
|
protected |
Base-class handler function for command CS_VALIDATE
Validate a command sequence file
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 1601 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command CS_VALIDATE.
| opCode | The opcode |
| cmdSeq | The command sequence number |
Definition at line 2033 of file CmdSequencerComponentAc.cpp.
| Fw::InputCmdPort * Svc::CmdSequencerComponentBase::get_cmdIn_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
| portNum | The port number |
Definition at line 444 of file CmdSequencerComponentAc.cpp.
| Fw::InputCmdResponsePort * Svc::CmdSequencerComponentBase::get_cmdResponseIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 459 of file CmdSequencerComponentAc.cpp.
| Svc::InputPingPort * Svc::CmdSequencerComponentBase::get_pingIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 470 of file CmdSequencerComponentAc.cpp.
| Svc::InputSchedPort * Svc::CmdSequencerComponentBase::get_schedIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 481 of file CmdSequencerComponentAc.cpp.
| Svc::InputCmdSeqCancelPort * Svc::CmdSequencerComponentBase::get_seqCancelIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 492 of file CmdSequencerComponentAc.cpp.
| Svc::InputCmdSeqInPort * Svc::CmdSequencerComponentBase::get_seqRunIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 503 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of cmdIn input ports
Definition at line 889 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of cmdRegOut output ports
Definition at line 943 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of cmdResponseIn input ports
Definition at line 899 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of cmdResponseOut output ports
Definition at line 949 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of comCmdOut output ports
Definition at line 977 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of logOut output ports
Definition at line 955 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of pingIn input ports
Definition at line 905 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of pingOut output ports
Definition at line 983 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of schedIn input ports
Definition at line 911 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of seqCancelIn input ports
Definition at line 917 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of seqDone output ports
Definition at line 989 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of seqRunIn input ports
Definition at line 923 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of seqStartOut output ports
Definition at line 995 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of timeCaller output ports
Definition at line 961 of file CmdSequencerComponentAc.cpp.
|
protected |
Get the number of tlmOut output ports
Definition at line 967 of file CmdSequencerComponentAc.cpp.
|
protected |
| void Svc::CmdSequencerComponentBase::init | ( | FwSizeType | queueDepth, |
| FwEnumStoreType | instance = 0 |
||
| ) |
Initialize CmdSequencerComponentBase object.
| queueDepth | The queue depth |
| instance | The instance number |
Definition at line 84 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port cmdRegOut is connected
| portNum | The port number |
Definition at line 1020 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port cmdResponseOut is connected
| portNum | The port number |
Definition at line 1031 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port comCmdOut is connected
| portNum | The port number |
Definition at line 1079 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port logOut is connected
| portNum | The port number |
Definition at line 1042 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port pingOut is connected
| portNum | The port number |
Definition at line 1090 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port seqDone is connected
| portNum | The port number |
Definition at line 1101 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port seqStartOut is connected
| portNum | The port number |
Definition at line 1112 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
| portNum | The port number |
Definition at line 1053 of file CmdSequencerComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
| portNum | The port number |
Definition at line 1064 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_CmdStarted
A manual sequence was started
| filename | The sequence file |
Definition at line 4092 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_CmdStepped
A command in a sequence was stepped through
| filename | The sequence file |
| command | The command that was stepped |
Definition at line 4000 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_JoinWaiting
Wait for the current running sequence file complete
| filename | The sequence file |
| recordNumber | The record number |
| opCode | The opcode |
Definition at line 4164 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_ModeSwitched
Switched step mode
| mode | The new mode |
Definition at line 3686 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_PortSequenceStarted
A local port request to run a sequence was started
| filename | The sequence file |
Definition at line 3532 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_SequenceCanceled
A command sequence was successfully canceled.
| fileName | The name of the sequence file |
Definition at line 2186 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_SequenceComplete
A command sequence successfully completed.
| fileName | The name of the sequence file |
Definition at line 2937 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_SequenceValid
A sequence passed validation
| filename | The sequence file |
Definition at line 3836 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_CommandComplete
The Command Sequencer issued a command and received a success status in return.
| fileName | The name of the sequence file |
| recordNumber | The record number of the command |
| opCode | The command opcode |
Definition at line 2827 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_SequenceLoaded
Sequence file was successfully loaded.
| fileName | The name of the sequence file |
Definition at line 2114 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_CommandError
The Command Sequencer issued a command and received an error status in return.
| fileName | The name of the sequence file |
| recordNumber | The record number |
| opCode | The opcode |
| errorStatus | The error status |
Definition at line 3009 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_FileCrcFailure
The sequence file validation failed
| fileName | The sequence file |
| storedCRC | The CRC stored in the file |
| computedCRC | The CRC computed over the file |
Definition at line 2717 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_FileInvalid
The sequence file format was invalid.
| fileName | The name of the sequence file |
| stage | The read stage |
| error | The error code |
Definition at line 2330 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_FileNotFound
The sequence file was not found
| fileName | The sequence file |
Definition at line 2645 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_FileReadError
The Sequence File Loader could not read the sequence file.
| fileName | The name of the sequence file |
Definition at line 2258 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_FileSizeError
The sequence file was too large.
| fileName | The name of the sequence file |
| size | Invalid size |
Definition at line 2553 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_InvalidMode
The Command Sequencer received a command that was invalid for its current mode.
Definition at line 3137 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_JoinWaitingNotComplete
Cannot run new sequence when current sequence file is still running.
Definition at line 4274 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_RecordInvalid
The format of a command record was invalid.
| fileName | The name of the sequence file |
| recordNumber | The record number |
| error | The error code |
Definition at line 2443 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_RecordMismatch
Number of records in header doesn't match number in file
| fileName | The name of the sequence file |
| header_records | The number of records in the header |
| extra_bytes | The number of bytes beyond last record |
Definition at line 3202 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_SequenceTimeout
A sequence passed validation
| filename | The sequence file |
| command | The command that timed out |
Definition at line 3908 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_TimeBaseMismatch
The running time base doesn't match the time base in the sequence files
| fileName | The name of the sequence file |
| time_base | The current time |
| seq_time_base | The sequence time base |
Definition at line 3312 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_TimeContextMismatch
The running time base doesn't match the time base in the sequence files
| fileName | The name of the sequence file |
| currTimeBase | The current time base |
| seqTimeBase | The sequence time base |
Definition at line 3422 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_UnexpectedCompletion
A command status came back when no sequence was running
| opcode | The reported opcode |
Definition at line 3604 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_NoRecords.
| fileName | The name of the sequence file |
Definition at line 4339 of file CmdSequencerComponentAc.cpp.
|
protected |
Log event CS_NoSequenceActive
A sequence related command came with no active sequence
Definition at line 3771 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
|
protected |
Handler base-class function for input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 1200 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port pingIn.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 1418 of file CmdSequencerComponentAc.cpp.
|
protected |
Invoke output port pingOut.
| portNum | The port number |
| key | Value to return to pinger |
Definition at line 1472 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 830 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port schedIn.
| portNum | The port number |
| context | The call order |
|
protected |
Handler base-class function for input port schedIn.
| portNum | The port number |
| context | The call order |
Definition at line 1253 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port schedIn.
| portNum | The port number |
| context | The call order |
Definition at line 1427 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port seqCancelIn.
| portNum | The port number |
|
protected |
Handler base-class function for input port seqCancelIn.
| portNum | The port number |
Definition at line 1306 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port seqCancelIn.
| portNum | The port number |
Definition at line 1436 of file CmdSequencerComponentAc.cpp.
|
protected |
Invoke output port seqDone.
| portNum | The port number |
| opCode | Command Op Code |
| cmdSeq | Command Sequence |
| response | The command response argument |
Definition at line 1487 of file CmdSequencerComponentAc.cpp.
|
protectedpure virtual |
Handler for input port seqRunIn.
| portNum | The port number |
| filename | The sequence file |
|
protected |
Handler base-class function for input port seqRunIn.
| portNum | The port number |
| filename | The sequence file |
Definition at line 1346 of file CmdSequencerComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port seqRunIn.
| portNum | The port number |
| filename | The sequence file |
Definition at line 1442 of file CmdSequencerComponentAc.cpp.
|
protected |
Invoke output port seqStartOut.
| portNum | The port number |
| filename | The sequence file |
Definition at line 1506 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_cmdRegOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdRegPort * | port | ||
| ) |
Connect port to cmdRegOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 536 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_cmdResponseOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdResponsePort * | port | ||
| ) |
Connect port to cmdResponseOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 550 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_comCmdOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputComPort * | port | ||
| ) |
Connect port to comCmdOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 610 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_logOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to logOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 564 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_pingOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputPingPort * | port | ||
| ) |
Connect port to pingOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 624 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_seqDone_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdResponsePort * | port | ||
| ) |
Connect port to seqDone[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 638 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_seqStartOut_OutputPort | ( | FwIndexType | portNum, |
| Svc::InputCmdSeqInPort * | port | ||
| ) |
Connect port to seqStartOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 652 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to timeCaller[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 578 of file CmdSequencerComponentAc.cpp.
| void Svc::CmdSequencerComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTlmPort * | port | ||
| ) |
Connect port to tlmOut[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 592 of file CmdSequencerComponentAc.cpp.
|
protected |
Write telemetry channel CS_CancelCommands
The number of Cancel commands executed
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 4448 of file CmdSequencerComponentAc.cpp.
|
protected |
Write telemetry channel CS_CommandsExecuted
The number of commands executed across all sequences.
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 4514 of file CmdSequencerComponentAc.cpp.
|
protected |
Write telemetry channel CS_Errors
The number of errors that have occurred
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 4481 of file CmdSequencerComponentAc.cpp.
|
protected |
Write telemetry channel CS_LoadCommands
The number of Load commands executed
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 4415 of file CmdSequencerComponentAc.cpp.
|
protected |
Write telemetry channel CS_SequencesCompleted
The number of sequences completed.
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 4547 of file CmdSequencerComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 50 of file CmdSequencerComponentAc.hpp.