F´ Flight Software - C/C++ Documentation
NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
|
Go to the documentation of this file.
13 #ifndef COMMANDDISPATCHER_COMP_HPP_
14 #define COMMANDDISPATCHER_COMP_HPP_
39 #if FW_ENABLE_TEXT_LOGGING == 1
168 #if FW_ENABLE_TEXT_LOGGING == 1
169 void set_LogText_OutputPort(
177 #if FW_PORT_SERIALIZATION
189 Fw::InputSerializePort *
port
196 Fw::InputSerializePort *
port
203 Fw::InputSerializePort *
port
210 Fw::InputSerializePort *
port
217 Fw::InputSerializePort *
port
224 Fw::InputSerializePort *
port
231 Fw::InputSerializePort *
port
238 Fw::InputSerializePort *
port
241 #if FW_ENABLE_TEXT_LOGGING == 1
242 void set_LogText_OutputPort(
246 Fw::InputSerializePort *
port
270 #if FW_OBJECT_NAMES == 1
304 virtual void lock(
void);
308 virtual void unLock(
void);
318 virtual void compCmdReg_handler(
357 void compCmdReg_handlerBase(
398 virtual void compCmdStat_preMsgHook(
428 void compCmdSend_out(
554 #if FW_ENABLE_TEXT_LOGGING == 1
585 bool isConnected_compCmdSend_OutputPort(
645 #if FW_ENABLE_TEXT_LOGGING == 1
646 bool isConnected_LogText_OutputPort(
662 OPCODE_CMD_NO_OP = 0,
676 virtual void CMD_NO_OP_cmdHandler(
718 virtual void CMD_NO_OP_preMsgHook(
753 void CMD_NO_OP_cmdHandlerBase(
791 void cmdResponse_out(
804 EVENTID_OPCODEREGISTERED = 0,
850 void log_DIAGNOSTIC_OpCodeRegistered(
940 CHANNELID_COMMANDSDISPATCHED = 0,
953 void tlmWrite_CommandsDispatched(
1041 #if FW_ENABLE_TEXT_LOGGING == 1
1055 static void m_p_compCmdReg_in(
1126 bool m_first_update_CommandsDispatched;
1140 U32 m_last_CommandsDispatched;
bool isConnected_Time_OutputPort(NATIVE_INT_TYPE portNum)
Fw::InputCmdRegPort * get_compCmdReg_InputPort(NATIVE_INT_TYPE portNum)
void pingOut_out(NATIVE_INT_TYPE portNum, U32 key)
bool m_first_update_CommandErrors
virtual void CMD_TEST_CMD_1_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
void log_WARNING_HI_MalformedCommand(CmdSerError Status)
PROTECTED FwOpcodeType U32 cmdSeq
PROTECTED OPCODE_CMD_NO_OP_STRING
#define PRIVATE
overridable private for unit testing
void set_CmdReg_OutputPort(NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)
NATIVE_INT_TYPE getNum_Time_OutputPorts(void)
PROTECTED EVENTID_TESTCMD1ARGS
virtual MsgDispatchStatus doDispatch(void)=0
method to dispatch a single message in the queue.
NATIVE_INT_TYPE getNum_compCmdStat_InputPorts(void)
Auto-generated base for CommandDispatcher component.
PRIVATE NATIVE_INT_TYPE portNum
NATIVE_INT_TYPE getNum_CmdStatus_OutputPorts(void)
@ NUM_CMDDISP_INPUT_PORTS
PROTECTED EVENTID_TOOMANYCOMMANDS
PROTECTED EVENTID_NOOPRECEIVED
@ NUM_CMDSTATUS_OUTPUT_PORTS
NATIVE_INT_TYPE getNum_seqCmdBuff_InputPorts(void)
virtual void CMD_NO_OP_STRING_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &arg1)=0
Handler for command CMD_NO_OP_STRING.
Fw::OutputCmdResponsePort m_seqCmdStatus_OutputPort[NUM_SEQCMDSTATUS_OUTPUT_PORTS]
uint8_t U8
8-bit unsigned integer
virtual void CMD_TEST_CMD_1_cmdHandler(FwOpcodeType opCode, U32 cmdSeq, I32 arg1, F32 arg2, U8 arg3)=0
Handler for command CMD_TEST_CMD_1.
PROTECTED EVENTID_NOOPSTRINGRECEIVED
Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS]
PROTECTED FwOpcodeType U32 Fw::CmdArgBuffer & args
virtual void pingIn_handler(NATIVE_INT_TYPE portNum, U32 key)=0
Handler for input port pingIn.
static void m_p_seqCmdBuff_in(Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
bool isConnected_CmdReg_OutputPort(NATIVE_INT_TYPE portNum)
void set_pingOut_OutputPort(NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)
void set_Log_OutputPort(NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
bool isConnected_Tlm_OutputPort(NATIVE_INT_TYPE portNum)
NATIVE_INT_TYPE getNum_CmdDisp_InputPorts(void)
NATIVE_INT_TYPE getNum_pingOut_OutputPorts(void)
static void m_p_CmdDisp_in(Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
Svc::InputPingPort * get_pingIn_InputPort(NATIVE_INT_TYPE portNum)
PROTECTED OPCODE_CMD_CLEAR_TRACKING
@ NUM_PINGOUT_OUTPUT_PORTS
virtual void CMD_CLEAR_TRACKING_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
void log_ACTIVITY_HI_TestCmd1Args(I32 arg1, F32 arg2, U8 arg3)
void log_WARNING_HI_OpCodeError(U32 Opcode, ErrorResponse error)
Fw::OutputCmdRegPort m_CmdReg_OutputPort[NUM_CMDREG_OUTPUT_PORTS]
virtual void seqCmdBuff_preMsgHook(NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
Fw::OutputCmdResponsePort m_CmdStatus_OutputPort[NUM_CMDSTATUS_OUTPUT_PORTS]
void log_WARNING_HI_InvalidCommand(U32 Opcode)
bool isConnected_CmdStatus_OutputPort(NATIVE_INT_TYPE portNum)
virtual void unLock(void)
Fw::InputCmdResponsePort m_compCmdStat_InputPort[NUM_COMPCMDSTAT_INPUT_PORTS]
@ NUM_COMPCMDSEND_OUTPUT_PORTS
PROTECTED EVENTID_OPCODECOMPLETED
void init(void)
Object initializer.
PROTECTED EVENTID_OPCODEERROR
@ NUM_SEQCMDSTATUS_OUTPUT_PORTS
void CMD_TEST_CMD_1_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
PROTECTED CHANNELID_COMMANDERRORS
Channel ID for CommandErrors.
bool isConnected_seqCmdStatus_OutputPort(NATIVE_INT_TYPE portNum)
NATIVE_INT_TYPE getNum_seqCmdStatus_OutputPorts(void)
PROTECTED ErrorResponse_MAX ErrorResponse
void log_WARNING_HI_TooManyCommands(U32 Opcode)
@ NUM_COMPCMDREG_INPUT_PORTS
void seqCmdStatus_out(NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)
void log_ACTIVITY_HI_NoOpReceived(void)
float F32
32-bit floating point
virtual void pingIn_preMsgHook(NATIVE_INT_TYPE portNum, U32 key)
#define FwOpcodeType
Type representation for a command opcode.
bool isConnected_Log_OutputPort(NATIVE_INT_TYPE portNum)
PROTECTED EVENTID_OPCODEDISPATCHED
PROTECTED FwOpcodeType U32 Fw::CommandResponse response
@ NUM_LOGTEXT_OUTPUT_PORTS
Fw::InputCmdPort m_CmdDisp_InputPort[NUM_CMDDISP_INPUT_PORTS]
void log_COMMAND_OpCodeCompleted(U32 Opcode)
void set_Time_OutputPort(NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
void CMD_NO_OP_STRING_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
NATIVE_INT_TYPE getNum_Tlm_OutputPorts(void)
void log_ACTIVITY_HI_NoOpStringReceived(Fw::LogStringArg &message)
PROTECTED ERR_EXECUTION_ERROR
void regCommands(void)
Register commands with the Command Dispatcher.
void log_COMMAND_OpCodeDispatched(U32 Opcode, I32 port)
void CMD_CLEAR_TRACKING_cmdHandlerBase(FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
@ NUM_COMPCMDSTAT_INPUT_PORTS
virtual ~CommandDispatcherComponentBase(void)
PROTECTED ERR_VALIDATION_ERROR
PROTECTED EVENTID_INVALIDCOMMAND
PROTECTED EVENTID_MALFORMEDCOMMAND
Fw::InputCmdResponsePort * get_compCmdStat_InputPort(NATIVE_INT_TYPE portNum)
Fw::InputCmdPort * get_CmdDisp_InputPort(NATIVE_INT_TYPE portNum)
Fw::InputComPort m_seqCmdBuff_InputPort[NUM_SEQCMDBUFF_INPUT_PORTS]
void set_seqCmdStatus_OutputPort(NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
static void m_p_pingIn_in(Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, U32 key)
NATIVE_INT_TYPE getNum_pingIn_InputPorts(void)
Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS]
@ NUM_SEQCMDBUFF_INPUT_PORTS
void pingIn_handlerBase(NATIVE_INT_TYPE portNum, U32 key)
virtual void CMD_CLEAR_TRACKING_cmdHandler(FwOpcodeType opCode, U32 cmdSeq)=0
Handler for command CMD_CLEAR_TRACKING.
Fw::InputComPort * get_seqCmdBuff_InputPort(NATIVE_INT_TYPE portNum)
Fw::OutputLogPort m_Log_OutputPort[NUM_LOG_OUTPUT_PORTS]
void set_Tlm_OutputPort(NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
PROTECTED OPCODE_CMD_TEST_CMD_1
NATIVE_INT_TYPE getNum_CmdReg_OutputPorts(void)
void tlmWrite_CommandErrors(U32 arg)
virtual void compCmdStat_handler(NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)=0
Handler for input port compCmdStat.
void set_CmdStatus_OutputPort(NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
void seqCmdBuff_handlerBase(NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
@ NUM_CMDREG_OUTPUT_PORTS
bool isConnected_pingOut_OutputPort(NATIVE_INT_TYPE portNum)
friend class CommandDispatcherComponentBaseFriend
void set_compCmdSend_OutputPort(NATIVE_INT_TYPE portNum, Fw::InputCmdPort *port)
void compCmdStat_handlerBase(NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)
NATIVE_INT_TYPE getNum_Log_OutputPorts(void)
int NATIVE_INT_TYPE
native integer type declaration
PROTECTED FwOpcodeType opCode
static void m_p_compCmdStat_in(Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)
PROTECTED ERR_FORMAT_ERROR
virtual void seqCmdBuff_handler(NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)=0
Handler for input port seqCmdBuff.
virtual void CMD_NO_OP_STRING_preMsgHook(FwOpcodeType opCode, U32 cmdSeq)
Fw::OutputTlmPort m_Tlm_OutputPort[NUM_TLM_OUTPUT_PORTS]
Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS]