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

#include <Svc/CmdDispatcher/CommandDispatcherComponentAc.hpp>

Inheritance diagram for Svc::CommandDispatcherComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize CommandDispatcherComponentBase object. More...

Fw::InputCmdPort *	get_CmdDisp_InputPort (FwIndexType portNum)

Fw::InputCmdRegPort *	get_compCmdReg_InputPort (FwIndexType portNum)

Fw::InputCmdResponsePort *	get_compCmdStat_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_run_InputPort (FwIndexType portNum)

Fw::InputComPort *	get_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 (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(Os::Task::TASK_DEFAULT))
	called by instantiator when task is to be started More...

void	exit ()
	exit task in active component More...

Os::Task::Status	join ()
	Join the thread. More...

	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. More...

Public Member Functions inherited from Fw::QueuedComponentBase
void	deinit () override
	Allows de-initialization on teardown. More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...

FwIdType	getIdBase () const

Protected 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_RUN_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, EVENTID_COMMANDDROPPEDQUEUEOVERFLOW = 0xb }
	Event IDs. More...

enum	{ EVENTID_COMMANDDROPPEDQUEUEOVERFLOW_THROTTLE = 5 }
	Event throttle values: sets initial value of countdown variables. More...

enum	{ CHANNELID_COMMANDSDISPATCHED = 0x0, CHANNELID_COMMANDERRORS = 0x1, CHANNELID_COMMANDSDROPPED = 0x2 }
	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...

bool	isConnected_CmdReg_OutputPort (FwIndexType portNum) const

bool	isConnected_CmdStatus_OutputPort (FwIndexType portNum) const

bool	isConnected_Log_OutputPort (FwIndexType portNum) const

bool	isConnected_Time_OutputPort (FwIndexType portNum) const

bool	isConnected_Tlm_OutputPort (FwIndexType portNum) const

bool	isConnected_compCmdSend_OutputPort (FwIndexType portNum) const

bool	isConnected_pingOut_OutputPort (FwIndexType portNum) const

bool	isConnected_seqCmdStatus_OutputPort (FwIndexType portNum) const

void	CmdDisp_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
	Handler base-class function for input port CmdDisp. More...

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	run_handler (FwIndexType portNum, U32 context)=0
	Handler for input port run. 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	run_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port run. 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	run_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port run. More...

virtual void	seqCmdBuff_preMsgHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Pre-message hook for async input port seqCmdBuff. More...

virtual void	seqCmdBuff_overflowHook (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0
	Overflow hook for async input port seqCmdBuff. More...

void	compCmdSend_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) const
	Invoke output port compCmdSend. More...

void	pingOut_out (FwIndexType portNum, U32 key) const
	Invoke output port pingOut. More...

void	seqCmdStatus_out (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response) const
	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 (FwOpcodeType Opcode, I32 port, I32 slot) const
	Log event OpCodeRegistered. More...

void	log_COMMAND_OpCodeDispatched (FwOpcodeType Opcode, I32 port) const

void	log_COMMAND_OpCodeCompleted (FwOpcodeType Opcode) const

void	log_COMMAND_OpCodeError (FwOpcodeType Opcode, const Fw::CmdResponse &error) const

void	log_WARNING_HI_MalformedCommand (const Fw::DeserialStatus &Status) const

void	log_WARNING_HI_InvalidCommand (FwOpcodeType Opcode) const

void	log_WARNING_HI_TooManyCommands (FwOpcodeType 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 (FwOpcodeType Opcode, I32 port) const

void	log_WARNING_HI_CommandDroppedQueueOverflow (FwOpcodeType OpCode, U32 Context)

void	log_WARNING_HI_CommandDroppedQueueOverflow_ThrottleClear ()
	Reset throttle value for CommandDroppedQueueOverflow. More...

void	tlmWrite (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const

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

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

void	tlmWrite_CommandsDropped (U32 arg, Fw::Time _tlmTime=Fw::Time())

Fw::Time	getTime () const

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)

MsgDispatchStatus	dispatchAvailableMessages ()
	dispatches all messages currently in the queue, returning status of the dispatch More...

FwSizeType	getNumMsgsDropped ()
	return number of messages dropped More...

void	incNumMsgDropped ()
	increment the number of messages dropped More...

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	Initialization function. More...

FwEnumStoreType	getInstance () const

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Static Protected Member Functions
static constexpr FwIndexType	getNum_CmdDisp_InputPorts ()

static constexpr FwIndexType	getNum_compCmdReg_InputPorts ()

static constexpr FwIndexType	getNum_compCmdStat_InputPorts ()

static constexpr FwIndexType	getNum_pingIn_InputPorts ()

static constexpr FwIndexType	getNum_run_InputPorts ()

static constexpr FwIndexType	getNum_seqCmdBuff_InputPorts ()

static constexpr FwIndexType	getNum_CmdReg_OutputPorts ()

static constexpr FwIndexType	getNum_CmdStatus_OutputPorts ()

static constexpr FwIndexType	getNum_Log_OutputPorts ()

static constexpr FwIndexType	getNum_Time_OutputPorts ()

static constexpr FwIndexType	getNum_Tlm_OutputPorts ()

static constexpr FwIndexType	getNum_compCmdSend_OutputPorts ()

static constexpr FwIndexType	getNum_pingOut_OutputPorts ()

static constexpr FwIndexType	getNum_seqCmdStatus_OutputPorts ()

Friends
class	CommandDispatcherTesterBase
	Friend class tester to support autocoded test harness. More...

class	CommandDispatcherTester
	Friend class tester implementation to support white-box testing. More...

Additional Inherited Members
Public Types inherited from Fw::ActiveComponentBase
enum	{ ACTIVE_COMPONENT_EXIT }

Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT }

Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task	m_task
	task object for active component More...

Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component More...

Detailed Description

Auto-generated base for CommandDispatcher component.

A component for dispatching commands

Definition at line 45 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 65 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_RUN_INPUT_PORTS
NUM_SEQCMDBUFF_INPUT_PORTS

Definition at line 70 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 79 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 89 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 96 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.
EVENTID_COMMANDDROPPEDQUEUEOVERFLOW	This log event reports the Command Sequence Buffer port queue has overflowed.

Definition at line 104 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_COMMANDDROPPEDQUEUEOVERFLOW_THROTTLE	Throttle reset count for CommandDroppedQueueOverflow.

Definition at line 120 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_COMMANDSDISPATCHED	Channel ID for CommandsDispatched.
CHANNELID_COMMANDERRORS	Channel ID for CommandErrors.
CHANNELID_COMMANDSDROPPED	Channel ID for CommandsDropped.

Definition at line 125 of file CommandDispatcherComponentAc.hpp.

Constructor & Destructor Documentation

◆ CommandDispatcherComponentBase()

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

protected

Construct CommandDispatcherComponentBase object.

Parameters

compName The component name

Definition at line 845 of file CommandDispatcherComponentAc.cpp.

◆ ~CommandDispatcherComponentBase()

Svc::CommandDispatcherComponentBase::~CommandDispatcherComponentBase ( )

protectedvirtual

Destroy CommandDispatcherComponentBase object.

Definition at line 852 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

opCode	The opcode
cmdSeq	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1634 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1734 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

opCode	The opcode
cmdSeq	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1457 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1701 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

opCode	The opcode
cmdSeq	The command sequence number
arg1	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1516 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1712 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

opCode	The opcode
cmdSeq	The command sequence number
arg1	The I32 command argument
arg2	The F32 command argument
arg3	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1575 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1723 of file CommandDispatcherComponentAc.cpp.

◆ CmdDisp_handlerBase()

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

protected

Handler base-class function for input port CmdDisp.

Parameters

portNum	The port number
opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 983 of file CommandDispatcherComponentAc.cpp.

◆ cmdResponse_out()

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

protected

Emit command response.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 1440 of file CommandDispatcherComponentAc.cpp.

◆ compCmdReg_handler()

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

protectedpure virtual

Handler for input port compCmdReg.

Parameters

portNum	The port number
opCode	Command Op Code

◆ compCmdReg_handlerBase()

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

protected

Handler base-class function for input port compCmdReg.

Parameters

portNum	The port number
opCode	Command Op Code

Definition at line 1044 of file CommandDispatcherComponentAc.cpp.

◆ compCmdSend_out()

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

protected

Invoke output port compCmdSend.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
args	Buffer containing arguments

Definition at line 1366 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

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The 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

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 1069 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

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 1321 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

portNum The port number

Definition at line 443 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

portNum The port number

Definition at line 462 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

portNum The port number

Definition at line 473 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

portNum The port number

Definition at line 484 of file CommandDispatcherComponentAc.cpp.

◆ get_run_InputPort()

Svc::InputSchedPort * Svc::CommandDispatcherComponentBase::get_run_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: run[portNum]

Parameters

portNum The port number

Definition at line 495 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

portNum The port number

Definition at line 506 of file CommandDispatcherComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_CmdDisp_InputPorts ( )

inlinestaticprotected

Get the number of CmdDisp input ports

Returns: The number of CmdDisp input ports

Definition at line 395 of file CommandDispatcherComponentAc.hpp.

◆ getNum_CmdReg_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_CmdReg_OutputPorts ( )

inlinestaticprotected

Get the number of CmdReg output ports

Returns: The number of CmdReg output ports

Definition at line 449 of file CommandDispatcherComponentAc.hpp.

◆ getNum_CmdStatus_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_CmdStatus_OutputPorts ( )

inlinestaticprotected

Get the number of CmdStatus output ports

Returns: The number of CmdStatus output ports

Definition at line 456 of file CommandDispatcherComponentAc.hpp.

◆ getNum_compCmdReg_InputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_compCmdReg_InputPorts ( )

inlinestaticprotected

Get the number of compCmdReg input ports

Returns: The number of compCmdReg input ports

Definition at line 408 of file CommandDispatcherComponentAc.hpp.

◆ getNum_compCmdSend_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_compCmdSend_OutputPorts ( )

inlinestaticprotected

Get the number of compCmdSend output ports

Returns: The number of compCmdSend output ports

Definition at line 501 of file CommandDispatcherComponentAc.hpp.

◆ getNum_compCmdStat_InputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_compCmdStat_InputPorts ( )

inlinestaticprotected

Get the number of compCmdStat input ports

Returns: The number of compCmdStat input ports

Definition at line 415 of file CommandDispatcherComponentAc.hpp.

◆ getNum_Log_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_Log_OutputPorts ( )

inlinestaticprotected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 463 of file CommandDispatcherComponentAc.hpp.

◆ getNum_pingIn_InputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_pingIn_InputPorts ( )

inlinestaticprotected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 422 of file CommandDispatcherComponentAc.hpp.

◆ getNum_pingOut_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_pingOut_OutputPorts ( )

inlinestaticprotected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 508 of file CommandDispatcherComponentAc.hpp.

◆ getNum_run_InputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_run_InputPorts ( )

inlinestaticprotected

Get the number of run input ports

Returns: The number of run input ports

Definition at line 429 of file CommandDispatcherComponentAc.hpp.

◆ getNum_seqCmdBuff_InputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_seqCmdBuff_InputPorts ( )

inlinestaticprotected

Get the number of seqCmdBuff input ports

Returns: The number of seqCmdBuff input ports

Definition at line 436 of file CommandDispatcherComponentAc.hpp.

◆ getNum_seqCmdStatus_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_seqCmdStatus_OutputPorts ( )

inlinestaticprotected

Get the number of seqCmdStatus output ports

Returns: The number of seqCmdStatus output ports

Definition at line 515 of file CommandDispatcherComponentAc.hpp.

◆ getNum_Time_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_Time_OutputPorts ( )

inlinestaticprotected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 481 of file CommandDispatcherComponentAc.hpp.

◆ getNum_Tlm_OutputPorts()

static constexpr FwIndexType Svc::CommandDispatcherComponentBase::getNum_Tlm_OutputPorts ( )

inlinestaticprotected

Get the number of Tlm output ports

Returns: The number of Tlm output ports

Definition at line 488 of file CommandDispatcherComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 3040 of file CommandDispatcherComponentAc.cpp.

◆ init()

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

Initialize CommandDispatcherComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 72 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

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

protected

Check whether port CmdReg is connected

Returns: Whether port CmdReg is connected

Parameters

portNum The port number

Definition at line 864 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

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

protected

Check whether port CmdStatus is connected

Returns: Whether port CmdStatus is connected

Parameters

portNum The port number

Definition at line 875 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_compCmdSend_OutputPort()

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

protected

Check whether port compCmdSend is connected

Returns: Whether port compCmdSend is connected

Parameters

portNum The port number

Definition at line 942 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Log_OutputPort()

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

protected

Check whether port Log is connected

Returns: Whether port Log is connected

Parameters

portNum The port number

Definition at line 886 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

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

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 953 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_seqCmdStatus_OutputPort()

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

protected

Check whether port seqCmdStatus is connected

Returns: Whether port seqCmdStatus is connected

Parameters

portNum The port number

Definition at line 964 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Time_OutputPort()

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

protected

Check whether port Time is connected

Returns: Whether port Time is connected

Parameters

portNum The port number

Definition at line 912 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

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

protected

Check whether port Tlm is connected

Returns: Whether port Tlm is connected

Parameters

portNum The port number

Definition at line 923 of file CommandDispatcherComponentAc.cpp.

◆ lock()

void Svc::CommandDispatcherComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 3060 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 2407 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

message The NO-OP string that is generated

Definition at line 2472 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

arg1	Arg1
arg2	Arg2
arg3	Arg3

Definition at line 2547 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeCompleted()

void Svc::CommandDispatcherComponentBase::log_COMMAND_OpCodeCompleted ( FwOpcodeType Opcode ) const

protected

Log event OpCodeCompleted

Op code completed event

Parameters

Opcode The I32 command argument

Definition at line 1971 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeDispatched()

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

protected

Log event OpCodeDispatched

Op code dispatched event

Parameters

Opcode	The opcode dispatched
port	The port dispatched to

Definition at line 1869 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeError()

void Svc::CommandDispatcherComponentBase::log_COMMAND_OpCodeError	(	FwOpcodeType	Opcode,
		const Fw::CmdResponse &	error
	)		const

protected

Log event OpCodeError

Op code completed with error event

Parameters

Opcode	The opcode with the error
error	The error value

Definition at line 2053 of file CommandDispatcherComponentAc.cpp.

◆ log_DIAGNOSTIC_OpCodeRegistered()

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

protected

Log event OpCodeRegistered.

Parameters

Opcode	The opcode to register
port	The registration port
slot	The dispatch slot it was placed in

Definition at line 1749 of file CommandDispatcherComponentAc.cpp.

◆ log_DIAGNOSTIC_OpCodeReregistered()

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

protected

Log event OpCodeReregistered

Op code reregistered event

Parameters

Opcode	The opcode reregistered
port	The reregistration port

Definition at line 2667 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_CommandDroppedQueueOverflow()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_CommandDroppedQueueOverflow	(	FwOpcodeType	OpCode,
		U32	Context
	)

protected

Log event CommandDroppedQueueOverflow

This log event reports the Command Sequence Buffer port queue has overflowed.

Parameters

OpCode	The command opcode dropped
Context	The call order

Definition at line 2769 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_CommandDroppedQueueOverflow_ThrottleClear()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_CommandDroppedQueueOverflow_ThrottleClear ( )

protected

Reset throttle value for CommandDroppedQueueOverflow.

Definition at line 2883 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_InvalidCommand()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_InvalidCommand ( FwOpcodeType Opcode ) const

protected

Log event InvalidCommand

Received an invalid opcode

Parameters

Opcode Invalid opcode

Definition at line 2243 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_MalformedCommand()

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

protected

Log event MalformedCommand

Received a malformed command packet

Parameters

Status The deserialization error

Definition at line 2158 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_TooManyCommands()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_TooManyCommands ( FwOpcodeType Opcode ) const

protected

Log event TooManyCommands

Exceeded the number of commands that can be simultaneously executed

Parameters

Opcode The opcode that overflowed the list

Definition at line 2325 of file CommandDispatcherComponentAc.cpp.

◆ pingIn_handler()

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

protectedpure virtual

Handler for input port pingIn.

Parameters

portNum	The port number
key	Value 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

portNum	The port number
key	Value to return to pinger

Definition at line 1140 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

portNum	The port number
key	Value to return to pinger

Definition at line 1332 of file CommandDispatcherComponentAc.cpp.

◆ pingOut_out()

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

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1390 of file CommandDispatcherComponentAc.cpp.

◆ regCommands()

void Svc::CommandDispatcherComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 815 of file CommandDispatcherComponentAc.cpp.

◆ run_handler()

virtual void Svc::CommandDispatcherComponentBase::run_handler	(	FwIndexType	portNum,
		U32	context
	)

protectedpure virtual

Handler for input port run.

Parameters

portNum	The port number
context	The call order

◆ run_handlerBase()

void Svc::CommandDispatcherComponentBase::run_handlerBase	(	FwIndexType	portNum,
		U32	context
	)

protected

Handler base-class function for input port run.

Parameters

portNum	The port number
context	The call order

Definition at line 1193 of file CommandDispatcherComponentAc.cpp.

◆ run_preMsgHook()

void Svc::CommandDispatcherComponentBase::run_preMsgHook	(	FwIndexType	portNum,
		U32	context
	)

protectedvirtual

Pre-message hook for async input port run.

Parameters

portNum	The port number
context	The call order

Definition at line 1341 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

portNum	The port number
data	Buffer containing packet data
context	Call 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

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 1246 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdBuff_overflowHook()

virtual void Svc::CommandDispatcherComponentBase::seqCmdBuff_overflowHook	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protectedpure virtual

Overflow hook for async input port seqCmdBuff.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

◆ seqCmdBuff_preMsgHook()

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

protectedvirtual

Pre-message hook for async input port seqCmdBuff.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 1350 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdStatus_out()

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

protected

Invoke output port seqCmdStatus.

Parameters

portNum	The port number
opCode	Command Op Code
cmdSeq	Command Sequence
response	The command response argument

Definition at line 1410 of file CommandDispatcherComponentAc.cpp.

◆ set_CmdReg_OutputPort()

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

Connect port to CmdReg[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 525 of file CommandDispatcherComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

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

Connect port to CmdStatus[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 539 of file CommandDispatcherComponentAc.cpp.

◆ set_compCmdSend_OutputPort()

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

Connect port to compCmdSend[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 621 of file CommandDispatcherComponentAc.cpp.

◆ set_Log_OutputPort()

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

Connect port to Log[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 553 of file CommandDispatcherComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 635 of file CommandDispatcherComponentAc.cpp.

◆ set_seqCmdStatus_OutputPort()

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

Connect port to seqCmdStatus[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 649 of file CommandDispatcherComponentAc.cpp.

◆ set_Time_OutputPort()

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

Connect port to Time[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 585 of file CommandDispatcherComponentAc.cpp.

◆ set_Tlm_OutputPort()

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

Connect port to Tlm[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 599 of file CommandDispatcherComponentAc.cpp.

◆ tlmWrite()

void Svc::CommandDispatcherComponentBase::tlmWrite	(	FwChanIdType	id,
		Fw::TlmBuffer &	_tlmBuff,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel given its local id and serialized value. Warning: This is a low level telemetry interface that does not guarentee channel type safety. It is up to the caller to make sure the serialized data matches the definition in the model. Update on change semantics are ignored, this telemetry is always written

Parameters

id	The channel id
_tlmBuff	The serialized telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 2894 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

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 2962 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

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 2925 of file CommandDispatcherComponentAc.cpp.

◆ tlmWrite_CommandsDropped()

void Svc::CommandDispatcherComponentBase::tlmWrite_CommandsDropped	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel CommandsDropped

Number of commands drooped due to buffer overflow

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 2999 of file CommandDispatcherComponentAc.cpp.

◆ unLock()

void Svc::CommandDispatcherComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 3066 of file CommandDispatcherComponentAc.cpp.

Friends And Related Function Documentation

◆ CommandDispatcherTester

friend class CommandDispatcherTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 56 of file CommandDispatcherComponentAc.hpp.

◆ CommandDispatcherTesterBase

friend class CommandDispatcherTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 54 of file CommandDispatcherComponentAc.hpp.

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

Svc/CmdDispatcher/CommandDispatcherComponentAc.hpp
Svc/CmdDispatcher/CommandDispatcherComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ CommandDispatcherComponentBase()

◆ ~CommandDispatcherComponentBase()

Member Function Documentation

◆ CMD_CLEAR_TRACKING_cmdHandler()

◆ CMD_CLEAR_TRACKING_cmdHandlerBase()

◆ CMD_CLEAR_TRACKING_preMsgHook()

◆ CMD_NO_OP_cmdHandler()

◆ CMD_NO_OP_cmdHandlerBase()

◆ CMD_NO_OP_preMsgHook()

◆ CMD_NO_OP_STRING_cmdHandler()

◆ CMD_NO_OP_STRING_cmdHandlerBase()

◆ CMD_NO_OP_STRING_preMsgHook()

◆ CMD_TEST_CMD_1_cmdHandler()

◆ CMD_TEST_CMD_1_cmdHandlerBase()

◆ CMD_TEST_CMD_1_preMsgHook()

◆ CmdDisp_handlerBase()

◆ cmdResponse_out()

◆ compCmdReg_handler()

◆ compCmdReg_handlerBase()

◆ compCmdSend_out()

◆ compCmdStat_handler()

◆ compCmdStat_handlerBase()

◆ compCmdStat_preMsgHook()

◆ get_CmdDisp_InputPort()

◆ get_compCmdReg_InputPort()

◆ get_compCmdStat_InputPort()

◆ get_pingIn_InputPort()

◆ get_run_InputPort()

◆ get_seqCmdBuff_InputPort()

◆ getNum_CmdDisp_InputPorts()

◆ getNum_CmdReg_OutputPorts()

◆ getNum_CmdStatus_OutputPorts()

◆ getNum_compCmdReg_InputPorts()

◆ getNum_compCmdSend_OutputPorts()

◆ getNum_compCmdStat_InputPorts()

◆ getNum_Log_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_run_InputPorts()

◆ getNum_seqCmdBuff_InputPorts()

◆ getNum_seqCmdStatus_OutputPorts()

◆ getNum_Time_OutputPorts()

◆ getNum_Tlm_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_CmdReg_OutputPort()

◆ isConnected_CmdStatus_OutputPort()

◆ isConnected_compCmdSend_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_seqCmdStatus_OutputPort()

◆ isConnected_Time_OutputPort()

◆ isConnected_Tlm_OutputPort()

◆ lock()

◆ log_ACTIVITY_HI_NoOpReceived()

◆ log_ACTIVITY_HI_NoOpStringReceived()

◆ log_ACTIVITY_HI_TestCmd1Args()

◆ log_COMMAND_OpCodeCompleted()

◆ log_COMMAND_OpCodeDispatched()

◆ log_COMMAND_OpCodeError()

◆ log_DIAGNOSTIC_OpCodeRegistered()

◆ log_DIAGNOSTIC_OpCodeReregistered()

◆ log_WARNING_HI_CommandDroppedQueueOverflow()