F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Svc::CommandDispatcherComponentBase Class Referenceabstract

Auto-generated base for CommandDispatcher component. More...

#include <Svc/CmdDispatcher/CommandDispatcherComponentAc.hpp>

Inheritance diagram for Svc::CommandDispatcherComponentBase:
Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::CommandDispatcherImpl

Public Member Functions

void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize CommandDispatcherComponentBase object. More...
 
Fw::InputCmdPortget_CmdDisp_InputPort (FwIndexType portNum)
 
Fw::InputCmdRegPortget_compCmdReg_InputPort (FwIndexType portNum)
 
Fw::InputCmdResponsePortget_compCmdStat_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_pingIn_InputPort (FwIndexType portNum)
 
Fw::InputComPortget_seqCmdBuff_InputPort (FwIndexType portNum)
 
void set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
 Connect port to CmdReg[portNum]. More...
 
void set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to CmdStatus[portNum]. More...
 
void set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum]. More...
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum]. More...
 
void set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to Tlm[portNum]. More...
 
void set_compCmdSend_OutputPort (FwIndexType portNum, Fw::InputCmdPort *port)
 Connect port to compCmdSend[portNum]. More...
 
void set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
 Connect port to pingOut[portNum]. More...
 
void set_seqCmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to seqCmdStatus[portNum]. More...
 
void regCommands ()
 Register commands with the Command Dispatcher. More...
 
- Public Member Functions inherited from Fw::ActiveComponentBase
void start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
 called by instantiator when task is to be started 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::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Protected Types

enum  { NUM_CMDDISP_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_COMPCMDREG_INPUT_PORTS = 30, NUM_COMPCMDSTAT_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1, NUM_SEQCMDBUFF_INPUT_PORTS = 5 }
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_CMDREG_OUTPUT_PORTS = 1, NUM_CMDSTATUS_OUTPUT_PORTS = 1, NUM_LOG_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1,
  NUM_TIME_OUTPUT_PORTS = 1, NUM_TLM_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_COMPCMDSEND_OUTPUT_PORTS = 30, NUM_PINGOUT_OUTPUT_PORTS = 1, NUM_SEQCMDSTATUS_OUTPUT_PORTS = 5 }
 Enumerations for numbers of typed output ports. More...
 
enum  { OPCODE_CMD_NO_OP = 0x0, OPCODE_CMD_NO_OP_STRING = 0x1, OPCODE_CMD_TEST_CMD_1 = 0x2, OPCODE_CMD_CLEAR_TRACKING = 0x3 }
 Command opcodes. More...
 
enum  {
  EVENTID_OPCODEREGISTERED = 0x0, EVENTID_OPCODEDISPATCHED = 0x1, EVENTID_OPCODECOMPLETED = 0x2, EVENTID_OPCODEERROR = 0x3,
  EVENTID_MALFORMEDCOMMAND = 0x4, EVENTID_INVALIDCOMMAND = 0x5, EVENTID_TOOMANYCOMMANDS = 0x6, EVENTID_NOOPRECEIVED = 0x7,
  EVENTID_NOOPSTRINGRECEIVED = 0x8, EVENTID_TESTCMD1ARGS = 0x9, EVENTID_OPCODEREREGISTERED = 0xa
}
 Event IDs. More...
 
enum  { CHANNELID_COMMANDSDISPATCHED = 0x0, CHANNELID_COMMANDERRORS = 0x1 }
 Channel IDs. More...
 
- Protected Types inherited from Fw::ActiveComponentBase
enum  Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
 Tracks the lifecycle of the component. More...
 

Protected Member Functions

 CommandDispatcherComponentBase (const char *compName="")
 Construct CommandDispatcherComponentBase object. More...
 
virtual ~CommandDispatcherComponentBase ()
 Destroy CommandDispatcherComponentBase object. More...
 
FwIndexType getNum_CmdDisp_InputPorts () const
 
FwIndexType getNum_compCmdReg_InputPorts () const
 
FwIndexType getNum_compCmdStat_InputPorts () const
 
FwIndexType getNum_pingIn_InputPorts () const
 
FwIndexType getNum_seqCmdBuff_InputPorts () const
 
FwIndexType getNum_CmdReg_OutputPorts () const
 
FwIndexType getNum_CmdStatus_OutputPorts () const
 
FwIndexType getNum_Log_OutputPorts () const
 
FwIndexType getNum_Time_OutputPorts () const
 
FwIndexType getNum_Tlm_OutputPorts () const
 
FwIndexType getNum_compCmdSend_OutputPorts () const
 
FwIndexType getNum_pingOut_OutputPorts () const
 
FwIndexType getNum_seqCmdStatus_OutputPorts () const
 
bool isConnected_CmdReg_OutputPort (FwIndexType portNum)
 
bool isConnected_CmdStatus_OutputPort (FwIndexType portNum)
 
bool isConnected_Log_OutputPort (FwIndexType portNum)
 
bool isConnected_Time_OutputPort (FwIndexType portNum)
 
bool isConnected_Tlm_OutputPort (FwIndexType portNum)
 
bool isConnected_compCmdSend_OutputPort (FwIndexType portNum)
 
bool isConnected_pingOut_OutputPort (FwIndexType portNum)
 
bool isConnected_seqCmdStatus_OutputPort (FwIndexType portNum)
 
virtual void compCmdReg_handler (FwIndexType portNum, FwOpcodeType opCode)=0
 Handler for input port compCmdReg. More...
 
virtual void compCmdStat_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0
 Handler for input port compCmdStat. More...
 
virtual void pingIn_handler (FwIndexType portNum, U32 key)=0
 Handler for input port pingIn. More...
 
virtual void seqCmdBuff_handler (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0
 Handler for input port seqCmdBuff. More...
 
void compCmdReg_handlerBase (FwIndexType portNum, FwOpcodeType opCode)
 Handler base-class function for input port compCmdReg. More...
 
void compCmdStat_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
 Handler base-class function for input port compCmdStat. More...
 
void pingIn_handlerBase (FwIndexType portNum, U32 key)
 Handler base-class function for input port pingIn. More...
 
void seqCmdBuff_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Handler base-class function for input port seqCmdBuff. More...
 
virtual void compCmdStat_preMsgHook (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
 Pre-message hook for async input port compCmdStat. More...
 
virtual void pingIn_preMsgHook (FwIndexType portNum, U32 key)
 Pre-message hook for async input port pingIn. More...
 
virtual void seqCmdBuff_preMsgHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
 Pre-message hook for async input port seqCmdBuff. More...
 
void compCmdSend_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 Invoke output port compCmdSend. More...
 
void pingOut_out (FwIndexType portNum, U32 key)
 Invoke output port pingOut. More...
 
void seqCmdStatus_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
 Invoke output port seqCmdStatus. More...
 
void cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response. More...
 
virtual void CMD_NO_OP_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
 
virtual void CMD_NO_OP_STRING_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &arg1)=0
 
virtual void CMD_TEST_CMD_1_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, I32 arg1, F32 arg2, U8 arg3)=0
 
virtual void CMD_CLEAR_TRACKING_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
 
void CMD_NO_OP_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void CMD_NO_OP_STRING_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void CMD_TEST_CMD_1_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void CMD_CLEAR_TRACKING_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
virtual void CMD_NO_OP_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command CMD_NO_OP. More...
 
virtual void CMD_NO_OP_STRING_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command CMD_NO_OP_STRING. More...
 
virtual void CMD_TEST_CMD_1_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command CMD_TEST_CMD_1. More...
 
virtual void CMD_CLEAR_TRACKING_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command CMD_CLEAR_TRACKING. More...
 
void log_DIAGNOSTIC_OpCodeRegistered (U32 Opcode, I32 port, I32 slot) const
 Log event OpCodeRegistered. More...
 
void log_COMMAND_OpCodeDispatched (U32 Opcode, I32 port) const
 
void log_COMMAND_OpCodeCompleted (U32 Opcode) const
 
void log_COMMAND_OpCodeError (U32 Opcode, Fw::CmdResponse error) const
 
void log_WARNING_HI_MalformedCommand (Fw::DeserialStatus Status) const
 
void log_WARNING_HI_InvalidCommand (U32 Opcode) const
 
void log_WARNING_HI_TooManyCommands (U32 Opcode) const
 
void log_ACTIVITY_HI_NoOpReceived () const
 
void log_ACTIVITY_HI_NoOpStringReceived (const Fw::StringBase &message) const
 
void log_ACTIVITY_HI_TestCmd1Args (I32 arg1, F32 arg2, U8 arg3) const
 
void log_DIAGNOSTIC_OpCodeReregistered (U32 Opcode, I32 port) const
 
void tlmWrite_CommandsDispatched (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CommandErrors (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
Fw::Time getTime ()
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. More...
 
- 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)
 
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...
 

Friends

class CommandDispatcherComponentBaseFriend
 Friend class for 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...
 

Detailed Description

Auto-generated base for CommandDispatcher component.

A component for dispatching commands

Definition at line 38 of file CommandDispatcherComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDDISP_INPUT_PORTS 

Definition at line 56 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_COMPCMDREG_INPUT_PORTS 
NUM_COMPCMDSTAT_INPUT_PORTS 
NUM_PINGIN_INPUT_PORTS 
NUM_SEQCMDBUFF_INPUT_PORTS 

Definition at line 61 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREG_OUTPUT_PORTS 
NUM_CMDSTATUS_OUTPUT_PORTS 
NUM_LOG_OUTPUT_PORTS 
NUM_LOGTEXT_OUTPUT_PORTS 
NUM_TIME_OUTPUT_PORTS 
NUM_TLM_OUTPUT_PORTS 

Definition at line 69 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_COMPCMDSEND_OUTPUT_PORTS 
NUM_PINGOUT_OUTPUT_PORTS 
NUM_SEQCMDSTATUS_OUTPUT_PORTS 

Definition at line 79 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Command opcodes.

Enumerator
OPCODE_CMD_NO_OP 

No-op command.

OPCODE_CMD_NO_OP_STRING 

No-op string command.

OPCODE_CMD_TEST_CMD_1 

No-op command.

OPCODE_CMD_CLEAR_TRACKING 

Clear command tracking info to recover from components not returning status.

Definition at line 86 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_OPCODEREGISTERED 
EVENTID_OPCODEDISPATCHED 

Op code dispatched event.

EVENTID_OPCODECOMPLETED 

Op code completed event.

EVENTID_OPCODEERROR 

Op code completed with error event.

EVENTID_MALFORMEDCOMMAND 

Received a malformed command packet.

EVENTID_INVALIDCOMMAND 

Received an invalid opcode.

EVENTID_TOOMANYCOMMANDS 

Exceeded the number of commands that can be simultaneously executed.

EVENTID_NOOPRECEIVED 

The command dispatcher has successfully received a NO-OP command.

EVENTID_NOOPSTRINGRECEIVED 

The command dispatcher has successfully received a NO-OP command from GUI with a string.

EVENTID_TESTCMD1ARGS 

This log event message returns the TEST_CMD_1 arguments.

EVENTID_OPCODEREREGISTERED 

Op code reregistered event.

Definition at line 94 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Channel IDs.

Enumerator
CHANNELID_COMMANDSDISPATCHED 

Channel ID for CommandsDispatched.

CHANNELID_COMMANDERRORS 

Channel ID for CommandErrors.

Definition at line 109 of file CommandDispatcherComponentAc.hpp.

Constructor & Destructor Documentation

◆ CommandDispatcherComponentBase()

Svc::CommandDispatcherComponentBase::CommandDispatcherComponentBase ( const char *  compName = "")
protected

Construct CommandDispatcherComponentBase object.

Parameters
compNameThe component name

Definition at line 768 of file CommandDispatcherComponentAc.cpp.

◆ ~CommandDispatcherComponentBase()

Svc::CommandDispatcherComponentBase::~CommandDispatcherComponentBase ( )
protectedvirtual

Destroy CommandDispatcherComponentBase object.

Definition at line 781 of file CommandDispatcherComponentAc.cpp.

Member Function Documentation

◆ CMD_CLEAR_TRACKING_cmdHandler()

virtual void Svc::CommandDispatcherComponentBase::CMD_CLEAR_TRACKING_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedpure virtual

Handler for command CMD_CLEAR_TRACKING

Clear command tracking info to recover from components not returning status

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ CMD_CLEAR_TRACKING_cmdHandlerBase()

void Svc::CommandDispatcherComponentBase::CMD_CLEAR_TRACKING_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command CMD_CLEAR_TRACKING

Clear command tracking info to recover from components not returning status

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1527 of file CommandDispatcherComponentAc.cpp.

◆ CMD_CLEAR_TRACKING_preMsgHook()

void Svc::CommandDispatcherComponentBase::CMD_CLEAR_TRACKING_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command CMD_CLEAR_TRACKING.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1627 of file CommandDispatcherComponentAc.cpp.

◆ CMD_NO_OP_cmdHandler()

virtual void Svc::CommandDispatcherComponentBase::CMD_NO_OP_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedpure virtual

Handler for command CMD_NO_OP

No-op command

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ CMD_NO_OP_cmdHandlerBase()

void Svc::CommandDispatcherComponentBase::CMD_NO_OP_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command CMD_NO_OP

No-op command

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1350 of file CommandDispatcherComponentAc.cpp.

◆ CMD_NO_OP_preMsgHook()

void Svc::CommandDispatcherComponentBase::CMD_NO_OP_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command CMD_NO_OP.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1594 of file CommandDispatcherComponentAc.cpp.

◆ CMD_NO_OP_STRING_cmdHandler()

virtual void Svc::CommandDispatcherComponentBase::CMD_NO_OP_STRING_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg arg1 
)
protectedpure virtual

Handler for command CMD_NO_OP_STRING

No-op string command

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
arg1The String command argument

◆ CMD_NO_OP_STRING_cmdHandlerBase()

void Svc::CommandDispatcherComponentBase::CMD_NO_OP_STRING_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command CMD_NO_OP_STRING

No-op string command

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1409 of file CommandDispatcherComponentAc.cpp.

◆ CMD_NO_OP_STRING_preMsgHook()

void Svc::CommandDispatcherComponentBase::CMD_NO_OP_STRING_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command CMD_NO_OP_STRING.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1605 of file CommandDispatcherComponentAc.cpp.

◆ CMD_TEST_CMD_1_cmdHandler()

virtual void Svc::CommandDispatcherComponentBase::CMD_TEST_CMD_1_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
I32  arg1,
F32  arg2,
U8  arg3 
)
protectedpure virtual

Handler for command CMD_TEST_CMD_1

No-op command

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
arg1The I32 command argument
arg2The F32 command argument
arg3The U8 command argument

◆ CMD_TEST_CMD_1_cmdHandlerBase()

void Svc::CommandDispatcherComponentBase::CMD_TEST_CMD_1_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command CMD_TEST_CMD_1

No-op command

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1468 of file CommandDispatcherComponentAc.cpp.

◆ CMD_TEST_CMD_1_preMsgHook()

void Svc::CommandDispatcherComponentBase::CMD_TEST_CMD_1_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command CMD_TEST_CMD_1.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1616 of file CommandDispatcherComponentAc.cpp.

◆ cmdResponse_out()

void Svc::CommandDispatcherComponentBase::cmdResponse_out ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdResponse  response 
)
protected

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 1333 of file CommandDispatcherComponentAc.cpp.

◆ compCmdReg_handler()

virtual void Svc::CommandDispatcherComponentBase::compCmdReg_handler ( FwIndexType  portNum,
FwOpcodeType  opCode 
)
protectedpure virtual

Handler for input port compCmdReg.

Parameters
portNumThe port number
opCodeCommand Op Code

◆ compCmdReg_handlerBase()

void Svc::CommandDispatcherComponentBase::compCmdReg_handlerBase ( FwIndexType  portNum,
FwOpcodeType  opCode 
)
protected

Handler base-class function for input port compCmdReg.

Parameters
portNumThe port number
opCodeCommand Op Code

Definition at line 1008 of file CommandDispatcherComponentAc.cpp.

◆ compCmdSend_out()

void Svc::CommandDispatcherComponentBase::compCmdSend_out ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Invoke output port compCmdSend.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
argsBuffer containing arguments

Definition at line 1261 of file CommandDispatcherComponentAc.cpp.

◆ compCmdStat_handler()

virtual void Svc::CommandDispatcherComponentBase::compCmdStat_handler ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdResponse response 
)
protectedpure virtual

Handler for input port compCmdStat.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

◆ compCmdStat_handlerBase()

void Svc::CommandDispatcherComponentBase::compCmdStat_handlerBase ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdResponse response 
)
protected

Handler base-class function for input port compCmdStat.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

Definition at line 1033 of file CommandDispatcherComponentAc.cpp.

◆ compCmdStat_preMsgHook()

void Svc::CommandDispatcherComponentBase::compCmdStat_preMsgHook ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdResponse response 
)
protectedvirtual

Pre-message hook for async input port compCmdStat.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

Definition at line 1227 of file CommandDispatcherComponentAc.cpp.

◆ get_CmdDisp_InputPort()

Fw::InputCmdPort * Svc::CommandDispatcherComponentBase::get_CmdDisp_InputPort ( FwIndexType  portNum)

Get special input port at index

Returns
CmdDisp[portNum]
Parameters
portNumThe port number

Definition at line 395 of file CommandDispatcherComponentAc.cpp.

◆ get_compCmdReg_InputPort()

Fw::InputCmdRegPort * Svc::CommandDispatcherComponentBase::get_compCmdReg_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
compCmdReg[portNum]
Parameters
portNumThe port number

Definition at line 410 of file CommandDispatcherComponentAc.cpp.

◆ get_compCmdStat_InputPort()

Fw::InputCmdResponsePort * Svc::CommandDispatcherComponentBase::get_compCmdStat_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
compCmdStat[portNum]
Parameters
portNumThe port number

Definition at line 421 of file CommandDispatcherComponentAc.cpp.

◆ get_pingIn_InputPort()

Svc::InputPingPort * Svc::CommandDispatcherComponentBase::get_pingIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
pingIn[portNum]
Parameters
portNumThe port number

Definition at line 432 of file CommandDispatcherComponentAc.cpp.

◆ get_seqCmdBuff_InputPort()

Fw::InputComPort * Svc::CommandDispatcherComponentBase::get_seqCmdBuff_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
seqCmdBuff[portNum]
Parameters
portNumThe port number

Definition at line 443 of file CommandDispatcherComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_CmdDisp_InputPorts ( ) const
protected

Get the number of CmdDisp input ports

Returns
The number of CmdDisp input ports

Definition at line 791 of file CommandDispatcherComponentAc.cpp.

◆ getNum_CmdReg_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_CmdReg_OutputPorts ( ) const
protected

Get the number of CmdReg output ports

Returns
The number of CmdReg output ports

Definition at line 829 of file CommandDispatcherComponentAc.cpp.

◆ getNum_CmdStatus_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_CmdStatus_OutputPorts ( ) const
protected

Get the number of CmdStatus output ports

Returns
The number of CmdStatus output ports

Definition at line 835 of file CommandDispatcherComponentAc.cpp.

◆ getNum_compCmdReg_InputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_compCmdReg_InputPorts ( ) const
protected

Get the number of compCmdReg input ports

Returns
The number of compCmdReg input ports

Definition at line 801 of file CommandDispatcherComponentAc.cpp.

◆ getNum_compCmdSend_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_compCmdSend_OutputPorts ( ) const
protected

Get the number of compCmdSend output ports

Returns
The number of compCmdSend output ports

Definition at line 873 of file CommandDispatcherComponentAc.cpp.

◆ getNum_compCmdStat_InputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_compCmdStat_InputPorts ( ) const
protected

Get the number of compCmdStat input ports

Returns
The number of compCmdStat input ports

Definition at line 807 of file CommandDispatcherComponentAc.cpp.

◆ getNum_Log_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_Log_OutputPorts ( ) const
protected

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 841 of file CommandDispatcherComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_pingIn_InputPorts ( ) const
protected

Get the number of pingIn input ports

Returns
The number of pingIn input ports

Definition at line 813 of file CommandDispatcherComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_pingOut_OutputPorts ( ) const
protected

Get the number of pingOut output ports

Returns
The number of pingOut output ports

Definition at line 879 of file CommandDispatcherComponentAc.cpp.

◆ getNum_seqCmdBuff_InputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_seqCmdBuff_InputPorts ( ) const
protected

Get the number of seqCmdBuff input ports

Returns
The number of seqCmdBuff input ports

Definition at line 819 of file CommandDispatcherComponentAc.cpp.

◆ getNum_seqCmdStatus_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_seqCmdStatus_OutputPorts ( ) const
protected

Get the number of seqCmdStatus output ports

Returns
The number of seqCmdStatus output ports

Definition at line 885 of file CommandDispatcherComponentAc.cpp.

◆ getNum_Time_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_Time_OutputPorts ( ) const
protected

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 857 of file CommandDispatcherComponentAc.cpp.

◆ getNum_Tlm_OutputPorts()

FwIndexType Svc::CommandDispatcherComponentBase::getNum_Tlm_OutputPorts ( ) const
protected

Get the number of Tlm output ports

Returns
The number of Tlm output ports

Definition at line 863 of file CommandDispatcherComponentAc.cpp.

◆ getTime()

Fw::Time Svc::CommandDispatcherComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 2763 of file CommandDispatcherComponentAc.cpp.

◆ init()

void Svc::CommandDispatcherComponentBase::init ( FwSizeType  queueDepth,
FwEnumStoreType  instance = 0 
)

Initialize CommandDispatcherComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 78 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_CmdReg_OutputPort ( FwIndexType  portNum)
protected

Check whether port CmdReg is connected

Returns
Whether port CmdReg is connected
Parameters
portNumThe port number

Definition at line 895 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_CmdStatus_OutputPort ( FwIndexType  portNum)
protected

Check whether port CmdStatus is connected

Returns
Whether port CmdStatus is connected
Parameters
portNumThe port number

Definition at line 906 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_compCmdSend_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_compCmdSend_OutputPort ( FwIndexType  portNum)
protected

Check whether port compCmdSend is connected

Returns
Whether port compCmdSend is connected
Parameters
portNumThe port number

Definition at line 969 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_Log_OutputPort ( FwIndexType  portNum)
protected

Check whether port Log is connected

Returns
Whether port Log is connected
Parameters
portNumThe port number

Definition at line 917 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_pingOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port pingOut is connected

Returns
Whether port pingOut is connected
Parameters
portNumThe port number

Definition at line 980 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_seqCmdStatus_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_seqCmdStatus_OutputPort ( FwIndexType  portNum)
protected

Check whether port seqCmdStatus is connected

Returns
Whether port seqCmdStatus is connected
Parameters
portNumThe port number

Definition at line 991 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_Time_OutputPort ( FwIndexType  portNum)
protected

Check whether port Time is connected

Returns
Whether port Time is connected
Parameters
portNumThe port number

Definition at line 943 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_Tlm_OutputPort ( FwIndexType  portNum)
protected

Check whether port Tlm is connected

Returns
Whether port Tlm is connected
Parameters
portNumThe port number

Definition at line 954 of file CommandDispatcherComponentAc.cpp.

◆ lock()

void Svc::CommandDispatcherComponentBase::lock ( )
protectedvirtual

Lock the guarded mutex.

Definition at line 2783 of file CommandDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_NoOpReceived()

void Svc::CommandDispatcherComponentBase::log_ACTIVITY_HI_NoOpReceived ( ) const
protected

Log event NoOpReceived

The command dispatcher has successfully received a NO-OP command

Definition at line 2300 of file CommandDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_NoOpStringReceived()

void Svc::CommandDispatcherComponentBase::log_ACTIVITY_HI_NoOpStringReceived ( const Fw::StringBase message) const
protected

Log event NoOpStringReceived

The command dispatcher has successfully received a NO-OP command from GUI with a string

Parameters
messageThe NO-OP string that is generated

Definition at line 2365 of file CommandDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_TestCmd1Args()

void Svc::CommandDispatcherComponentBase::log_ACTIVITY_HI_TestCmd1Args ( I32  arg1,
F32  arg2,
U8  arg3 
) const
protected

Log event TestCmd1Args

This log event message returns the TEST_CMD_1 arguments.

Parameters
arg1Arg1
arg2Arg2
arg3Arg3

Definition at line 2437 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeCompleted()

void Svc::CommandDispatcherComponentBase::log_COMMAND_OpCodeCompleted ( U32  Opcode) const
protected

Log event OpCodeCompleted

Op code completed event

Parameters
OpcodeThe I32 command argument

Definition at line 1864 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeDispatched()

void Svc::CommandDispatcherComponentBase::log_COMMAND_OpCodeDispatched ( U32  Opcode,
I32  port 
) const
protected

Log event OpCodeDispatched

Op code dispatched event

Parameters
OpcodeThe opcode dispatched
portThe port dispatched to

Definition at line 1762 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeError()

void Svc::CommandDispatcherComponentBase::log_COMMAND_OpCodeError ( U32  Opcode,
Fw::CmdResponse  error 
) const
protected

Log event OpCodeError

Op code completed with error event

Parameters
OpcodeThe opcode with the error
errorThe error value

Definition at line 1946 of file CommandDispatcherComponentAc.cpp.

◆ log_DIAGNOSTIC_OpCodeRegistered()

void Svc::CommandDispatcherComponentBase::log_DIAGNOSTIC_OpCodeRegistered ( U32  Opcode,
I32  port,
I32  slot 
) const
protected

Log event OpCodeRegistered.

Parameters
OpcodeThe opcode to register
portThe registration port
slotThe dispatch slot it was placed in

Definition at line 1642 of file CommandDispatcherComponentAc.cpp.

◆ log_DIAGNOSTIC_OpCodeReregistered()

void Svc::CommandDispatcherComponentBase::log_DIAGNOSTIC_OpCodeReregistered ( U32  Opcode,
I32  port 
) const
protected

Log event OpCodeReregistered

Op code reregistered event

Parameters
OpcodeThe opcode reregistered
portThe reregistration port

Definition at line 2557 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_InvalidCommand()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_InvalidCommand ( U32  Opcode) const
protected

Log event InvalidCommand

Received an invalid opcode

Parameters
OpcodeInvalid opcode

Definition at line 2136 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_MalformedCommand()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_MalformedCommand ( Fw::DeserialStatus  Status) const
protected

Log event MalformedCommand

Received a malformed command packet

Parameters
StatusThe deserialization error

Definition at line 2051 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_TooManyCommands()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_TooManyCommands ( U32  Opcode) const
protected

Log event TooManyCommands

Exceeded the number of commands that can be simultaneously executed

Parameters
OpcodeThe opcode that overflowed the list

Definition at line 2218 of file CommandDispatcherComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::CommandDispatcherComponentBase::pingIn_handler ( FwIndexType  portNum,
U32  key 
)
protectedpure virtual

Handler for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

◆ pingIn_handlerBase()

void Svc::CommandDispatcherComponentBase::pingIn_handlerBase ( FwIndexType  portNum,
U32  key 
)
protected

Handler base-class function for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 1104 of file CommandDispatcherComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::CommandDispatcherComponentBase::pingIn_preMsgHook ( FwIndexType  portNum,
U32  key 
)
protectedvirtual

Pre-message hook for async input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 1238 of file CommandDispatcherComponentAc.cpp.

◆ pingOut_out()

void Svc::CommandDispatcherComponentBase::pingOut_out ( FwIndexType  portNum,
U32  key 
)
protected

Invoke output port pingOut.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 1285 of file CommandDispatcherComponentAc.cpp.

◆ regCommands()

void Svc::CommandDispatcherComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 742 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdBuff_handler()

virtual void Svc::CommandDispatcherComponentBase::seqCmdBuff_handler ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
)
protectedpure virtual

Handler for input port seqCmdBuff.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

◆ seqCmdBuff_handlerBase()

void Svc::CommandDispatcherComponentBase::seqCmdBuff_handlerBase ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
)
protected

Handler base-class function for input port seqCmdBuff.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 1157 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdBuff_preMsgHook()

void Svc::CommandDispatcherComponentBase::seqCmdBuff_preMsgHook ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
)
protectedvirtual

Pre-message hook for async input port seqCmdBuff.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 1247 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdStatus_out()

void Svc::CommandDispatcherComponentBase::seqCmdStatus_out ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdResponse response 
)
protected

Invoke output port seqCmdStatus.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

Definition at line 1305 of file CommandDispatcherComponentAc.cpp.

◆ set_CmdReg_OutputPort()

void Svc::CommandDispatcherComponentBase::set_CmdReg_OutputPort ( FwIndexType  portNum,
Fw::InputCmdRegPort port 
)

Connect port to CmdReg[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 458 of file CommandDispatcherComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

void Svc::CommandDispatcherComponentBase::set_CmdStatus_OutputPort ( FwIndexType  portNum,
Fw::InputCmdResponsePort port 
)

Connect port to CmdStatus[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 472 of file CommandDispatcherComponentAc.cpp.

◆ set_compCmdSend_OutputPort()

void Svc::CommandDispatcherComponentBase::set_compCmdSend_OutputPort ( FwIndexType  portNum,
Fw::InputCmdPort port 
)

Connect port to compCmdSend[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 550 of file CommandDispatcherComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::CommandDispatcherComponentBase::set_Log_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 486 of file CommandDispatcherComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::CommandDispatcherComponentBase::set_pingOut_OutputPort ( FwIndexType  portNum,
Svc::InputPingPort port 
)

Connect port to pingOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 564 of file CommandDispatcherComponentAc.cpp.

◆ set_seqCmdStatus_OutputPort()

void Svc::CommandDispatcherComponentBase::set_seqCmdStatus_OutputPort ( FwIndexType  portNum,
Fw::InputCmdResponsePort port 
)

Connect port to seqCmdStatus[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 578 of file CommandDispatcherComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::CommandDispatcherComponentBase::set_Time_OutputPort ( FwIndexType  portNum,
Fw::InputTimePort port 
)

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 518 of file CommandDispatcherComponentAc.cpp.

◆ set_Tlm_OutputPort()

void Svc::CommandDispatcherComponentBase::set_Tlm_OutputPort ( FwIndexType  portNum,
Fw::InputTlmPort port 
)

Connect port to Tlm[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 532 of file CommandDispatcherComponentAc.cpp.

◆ tlmWrite_CommandErrors()

void Svc::CommandDispatcherComponentBase::tlmWrite_CommandErrors ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CommandErrors

Number of command errors

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 2711 of file CommandDispatcherComponentAc.cpp.

◆ tlmWrite_CommandsDispatched()

void Svc::CommandDispatcherComponentBase::tlmWrite_CommandsDispatched ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CommandsDispatched

Number of commands dispatched

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 2663 of file CommandDispatcherComponentAc.cpp.

◆ unLock()

void Svc::CommandDispatcherComponentBase::unLock ( )
protectedvirtual

Unlock the guarded mutex.

Definition at line 2789 of file CommandDispatcherComponentAc.cpp.

Friends And Related Function Documentation

◆ CommandDispatcherComponentBaseFriend

friend class CommandDispatcherComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 47 of file CommandDispatcherComponentAc.hpp.


The documentation for this class was generated from the following files: