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

#include <build-fprime-automatic-native/F-Prime/Svc/CmdDispatcher/CommandDispatcherComponentAc.hpp>

Inheritance diagram for Svc::CommandDispatcherComponentBase:

Public Types
enum	{ NUM_COMPCMDREG_INPUT_PORTS = 30, NUM_COMPCMDSTAT_INPUT_PORTS = 1, NUM_SEQCMDBUFF_INPUT_PORTS = 5, NUM_PINGIN_INPUT_PORTS = 1, NUM_CMDDISP_INPUT_PORTS = 1 }

enum	{ NUM_COMPCMDSEND_OUTPUT_PORTS = 30, NUM_SEQCMDSTATUS_OUTPUT_PORTS = 5, NUM_PINGOUT_OUTPUT_PORTS = 1, NUM_CMDSTATUS_OUTPUT_PORTS = 1, NUM_CMDREG_OUTPUT_PORTS = 1, NUM_TLM_OUTPUT_PORTS = 1, NUM_TIME_OUTPUT_PORTS = 1, NUM_LOG_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1 }

enum	CmdSerError { ERR_BUFFER_TOO_SMALL, ERR_BUFFER_FORMAT, ERR_SIZE_MISMATCH, ERR_TYPE_MISMATCH, ERR_UNEXP_STAT, CmdSerError_MAX }

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 }

Public Member Functions
Fw::InputCmdRegPort *	get_compCmdReg_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputCmdResponsePort *	get_compCmdStat_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputComPort *	get_seqCmdBuff_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputCmdPort *	get_CmdDisp_InputPort (NATIVE_INT_TYPE portNum)

void	set_compCmdSend_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdPort *port)

void	set_seqCmdStatus_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)

void	set_pingOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)

void	set_CmdStatus_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)

void	set_CmdReg_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)

void	set_Tlm_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)

void	set_Time_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)

void	set_Log_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)

void	regCommands (void)
	Register commands with the Command Dispatcher. More...

void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)

virtual	~CommandDispatcherComponentBase (void)

virtual void	unLock (void)

virtual void	compCmdStat_handler (NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)=0
	Handler for input port compCmdStat. More...

virtual void	seqCmdBuff_handler (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)=0
	Handler for input port seqCmdBuff. More...

virtual void	pingIn_handler (NATIVE_INT_TYPE portNum, U32 key)=0
	Handler for input port pingIn. More...

void	compCmdStat_handlerBase (NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)

void	seqCmdBuff_handlerBase (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)

void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)

virtual void	seqCmdBuff_preMsgHook (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)

virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)

void	seqCmdStatus_out (NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)

void	pingOut_out (NATIVE_INT_TYPE portNum, U32 key)

NATIVE_INT_TYPE	getNum_compCmdStat_InputPorts (void)

NATIVE_INT_TYPE	getNum_seqCmdBuff_InputPorts (void)

NATIVE_INT_TYPE	getNum_pingIn_InputPorts (void)

NATIVE_INT_TYPE	getNum_CmdDisp_InputPorts (void)

NATIVE_INT_TYPE	getNum_seqCmdStatus_OutputPorts (void)

NATIVE_INT_TYPE	getNum_pingOut_OutputPorts (void)

NATIVE_INT_TYPE	getNum_CmdStatus_OutputPorts (void)

NATIVE_INT_TYPE	getNum_CmdReg_OutputPorts (void)

NATIVE_INT_TYPE	getNum_Tlm_OutputPorts (void)

NATIVE_INT_TYPE	getNum_Time_OutputPorts (void)

NATIVE_INT_TYPE	getNum_Log_OutputPorts (void)

bool	isConnected_seqCmdStatus_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_CmdStatus_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_CmdReg_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_Tlm_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_Log_OutputPort (NATIVE_INT_TYPE portNum)

virtual void	CMD_NO_OP_STRING_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &arg1)=0
	Handler for command CMD_NO_OP_STRING. More...

virtual void	CMD_TEST_CMD_1_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, I32 arg1, F32 arg2, U8 arg3)=0
	Handler for command CMD_TEST_CMD_1. More...

virtual void	CMD_CLEAR_TRACKING_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
	Handler for command CMD_CLEAR_TRACKING. More...

virtual void	CMD_NO_OP_STRING_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)

virtual void	CMD_TEST_CMD_1_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)

virtual void	CMD_CLEAR_TRACKING_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)

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)

void	log_COMMAND_OpCodeDispatched (U32 Opcode, I32 port)

void	log_COMMAND_OpCodeCompleted (U32 Opcode)

void	log_WARNING_HI_OpCodeError (U32 Opcode, ErrorResponse error)

void	log_WARNING_HI_MalformedCommand (CmdSerError Status)

void	log_WARNING_HI_InvalidCommand (U32 Opcode)

void	log_WARNING_HI_TooManyCommands (U32 Opcode)

void	log_ACTIVITY_HI_NoOpReceived (void)

void	log_ACTIVITY_HI_NoOpStringReceived (Fw::LogStringArg &message)

void	log_ACTIVITY_HI_TestCmd1Args (I32 arg1, F32 arg2, U8 arg3)

void	tlmWrite_CommandErrors (U32 arg)

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1)
	called by instantiator when task is to be started More...

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

Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL More...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	initialization code More...

virtual void	preamble (void)
	A function that will be called before the event loop is entered. More...

virtual void	loop (void)
	The function that will loop dispatching messages. More...

virtual void	finalizer (void)
	A function that will be called after exiting the loop. More...

Public Member Functions inherited from Fw::QueuedComponentBase
virtual	~QueuedComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	initialization function More...

Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)

virtual MsgDispatchStatus	doDispatch (void)=0
	method to dispatch a single message in the queue. More...

NATIVE_INT_TYPE	getNumMsgsDropped (void)
	return number of messages dropped More...

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

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

U32	getIdBase (void) const

virtual	~PassiveComponentBase ()
	Destructor. More...

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

NATIVE_INT_TYPE	getInstance (void) const

Static Public Member Functions
static void	m_p_compCmdStat_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CommandResponse response)

static void	m_p_seqCmdBuff_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)

static void	m_p_pingIn_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, U32 key)

static void	m_p_CmdDisp_in (Fw::PassiveComponentBase *callComp, NATIVE_INT_TYPE portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

Static Public Member Functions inherited from Fw::ActiveComponentBase
static void	s_baseBareTask (void *)
	function provided to task class for new thread. More...

Public Attributes
PROTECTED	__pad0__: CommandDispatcherComponentBase(void)

PROTECTED	__pad1__: virtual void lock(void)

PROTECTED	__pad2__: virtual void compCmdReg_handler( NATIVE_INT_TYPE portNum

PROTECTED FwOpcodeType	opCode = 0

PROTECTED	__pad3__: void compCmdReg_handlerBase( NATIVE_INT_TYPE portNum

PROTECTED	__pad4__: virtual void compCmdStat_preMsgHook( NATIVE_INT_TYPE portNum

PROTECTED FwOpcodeType U32	cmdSeq

PROTECTED FwOpcodeType U32 Fw::CommandResponse	response

PROTECTED	__pad5__: void compCmdSend_out( NATIVE_INT_TYPE portNum

PROTECTED FwOpcodeType U32 Fw::CmdArgBuffer &	args

PROTECTED	__pad6__: NATIVE_INT_TYPE getNum_compCmdReg_InputPorts(void)

PROTECTED	__pad7__: NATIVE_INT_TYPE getNum_compCmdSend_OutputPorts(void)

PROTECTED	__pad8__: bool isConnected_compCmdSend_OutputPort( NATIVE_INT_TYPE portNum )

PROTECTED	__pad9__: enum { OPCODE_CMD_NO_OP = 0

PROTECTED	OPCODE_CMD_NO_OP_STRING = 1

PROTECTED	OPCODE_CMD_TEST_CMD_1 = 2

PROTECTED	OPCODE_CMD_CLEAR_TRACKING = 3

PROTECTED	PROTECTED: virtual void CMD_NO_OP_cmdHandler( FwOpcodeType opCode

PROTECTED U32	cmdSeq = 0

PROTECTED	__pad10__: virtual void CMD_NO_OP_preMsgHook( FwOpcodeType opCode

PROTECTED	__pad11__: void CMD_NO_OP_cmdHandlerBase( FwOpcodeType opCode

PROTECTED U32 Fw::CmdArgBuffer &	args

PROTECTED	__pad12__: void cmdResponse_out( FwOpcodeType opCode

PROTECTED U32 Fw::CommandResponse	response

PROTECTED	__pad13__: enum { EVENTID_OPCODEREGISTERED = 0

PROTECTED	EVENTID_OPCODEDISPATCHED = 1

PROTECTED	EVENTID_OPCODECOMPLETED = 2

PROTECTED	EVENTID_OPCODEERROR = 3

PROTECTED	EVENTID_MALFORMEDCOMMAND = 4

PROTECTED	EVENTID_INVALIDCOMMAND = 5

PROTECTED	EVENTID_TOOMANYCOMMANDS = 6

PROTECTED	EVENTID_NOOPRECEIVED = 7

PROTECTED	EVENTID_NOOPSTRINGRECEIVED = 8

PROTECTED	EVENTID_TESTCMD1ARGS = 9

PROTECTED	ERR_VALIDATION_ERROR

PROTECTED	ERR_FORMAT_ERROR

PROTECTED	ERR_EXECUTION_ERROR

PROTECTED	ERR_BUSY

PROTECTED	ERR_UNEXP

PROTECTED ErrorResponse_MAX	ErrorResponse

PROTECTED	__pad14__: void log_DIAGNOSTIC_OpCodeRegistered( U32 Opcode

PROTECTED I32	port

PROTECTED I32 I32	slot

PROTECTED	__pad15__: enum { CHANNELID_COMMANDSDISPATCHED = 0
	Channel ID for CommandsDispatched. More...

PROTECTED	CHANNELID_COMMANDERRORS = 1
	Channel ID for CommandErrors. More...

PROTECTED	__pad16__: Fw::Time getTime(void)

PRIVATE	__pad17__: Fw::InputCmdRegPort m_compCmdReg_InputPort[NUM_COMPCMDREG_INPUT_PORTS]

Fw::InputCmdResponsePort	m_compCmdStat_InputPort [NUM_COMPCMDSTAT_INPUT_PORTS]

Fw::InputComPort	m_seqCmdBuff_InputPort [NUM_SEQCMDBUFF_INPUT_PORTS]

Svc::InputPingPort	m_pingIn_InputPort [NUM_PINGIN_INPUT_PORTS]

Fw::InputCmdPort	m_CmdDisp_InputPort [NUM_CMDDISP_INPUT_PORTS]

PRIVATE	__pad18__: Fw::OutputCmdPort m_compCmdSend_OutputPort[NUM_COMPCMDSEND_OUTPUT_PORTS]

Fw::OutputCmdResponsePort	m_seqCmdStatus_OutputPort [NUM_SEQCMDSTATUS_OUTPUT_PORTS]

Svc::OutputPingPort	m_pingOut_OutputPort [NUM_PINGOUT_OUTPUT_PORTS]

Fw::OutputCmdResponsePort	m_CmdStatus_OutputPort [NUM_CMDSTATUS_OUTPUT_PORTS]

Fw::OutputCmdRegPort	m_CmdReg_OutputPort [NUM_CMDREG_OUTPUT_PORTS]

Fw::OutputTlmPort	m_Tlm_OutputPort [NUM_TLM_OUTPUT_PORTS]

Fw::OutputTimePort	m_Time_OutputPort [NUM_TIME_OUTPUT_PORTS]

Fw::OutputLogPort	m_Log_OutputPort [NUM_LOG_OUTPUT_PORTS]

PRIVATE	__pad19__: static void m_p_compCmdReg_in( Fw::PassiveComponentBase* callComp

PRIVATE NATIVE_INT_TYPE	portNum

PRIVATE NATIVE_INT_TYPE FwOpcodeType	opCode

PRIVATE	__pad20__: virtual MsgDispatchStatus doDispatch(void)

PRIVATE	__pad21__: Os::Mutex m_guardedPortMutex

PRIVATE	__pad22__: bool m_first_update_CommandsDispatched

bool	m_first_update_CommandErrors

PRIVATE	__pad23__: U32 m_last_CommandsDispatched

U32	m_last_CommandErrors

Public Attributes inherited from Fw::ActiveComponentBase
PROTECTED	__pad0__: ActiveComponentBase(const char* name)
	Constructor. More...

Os::Task	m_task
	task object for active component More...

PRIVATE	__pad1__: static void s_baseTask(void*)
	function provided to task class for new thread. More...

Public Attributes inherited from Fw::QueuedComponentBase
PROTECTED	__pad0__: QueuedComponentBase(const char* name)
	Constructor. More...

Os::Queue	m_queue
	queue object for active component More...

PRIVATE	__pad1__: NATIVE_INT_TYPE m_msgsDropped
	number of messages dropped from full queue More...

Public Attributes inherited from Fw::PassiveComponentBase
PROTECTED	__pad0__: PassiveComponentBase(const char* name)
	Named constructor. More...

PRIVATE	__pad1__: U32 m_idBase
	ID base for opcodes etc. More...

NATIVE_INT_TYPE	m_instance
	instance of component object More...

Friends
class	CommandDispatcherComponentBaseFriend

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

virtual	~ObjBase ()
	Destructor. More...

void	init (void)
	Object initializer. More...

Detailed Description

Auto-generated base for CommandDispatcher component.

Definition at line 48 of file CommandDispatcherComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
NUM_COMPCMDREG_INPUT_PORTS
NUM_COMPCMDSTAT_INPUT_PORTS
NUM_SEQCMDBUFF_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS
NUM_CMDDISP_INPUT_PORTS

Definition at line 492 of file CommandDispatcherComponentAc.hpp.

◆ anonymous enum

anonymous enum

Enumerator
NUM_COMPCMDSEND_OUTPUT_PORTS
NUM_SEQCMDSTATUS_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS
NUM_CMDSTATUS_OUTPUT_PORTS
NUM_CMDREG_OUTPUT_PORTS
NUM_TLM_OUTPUT_PORTS
NUM_TIME_OUTPUT_PORTS
NUM_LOG_OUTPUT_PORTS
NUM_LOGTEXT_OUTPUT_PORTS

Definition at line 563 of file CommandDispatcherComponentAc.hpp.

◆ CmdSerError

enum Svc::CommandDispatcherComponentBase::CmdSerError

Enumerator
ERR_BUFFER_TOO_SMALL
ERR_BUFFER_FORMAT
ERR_SIZE_MISMATCH
ERR_TYPE_MISMATCH
ERR_UNEXP_STAT
CmdSerError_MAX

Definition at line 832 of file CommandDispatcherComponentAc.hpp.

Constructor & Destructor Documentation

◆ ~CommandDispatcherComponentBase()

Svc::CommandDispatcherComponentBase::~CommandDispatcherComponentBase ( void )

virtual

Destroy a CommandDispatcherComponentBase object

Definition at line 730 of file CommandDispatcherComponentAc.cpp.

Member Function Documentation

◆ CMD_CLEAR_TRACKING_cmdHandler()

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

pure virtual

Handler for command CMD_CLEAR_TRACKING.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Implemented in Svc::CommandDispatcherImpl.

◆ CMD_CLEAR_TRACKING_cmdHandlerBase()

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

Base-class handler function for command CMD_CLEAR_TRACKING

Parameters

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

Definition at line 1275 of file CommandDispatcherComponentAc.cpp.

◆ CMD_CLEAR_TRACKING_preMsgHook()

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

virtual

Pre-message hook for command CMD_CLEAR_TRACKING

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1336 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
	)

pure virtual

Handler for command CMD_NO_OP_STRING.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
arg1	The String command argument

Implemented in Svc::CommandDispatcherImpl.

◆ CMD_NO_OP_STRING_cmdHandlerBase()

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

Base-class handler function for command CMD_NO_OP_STRING

Parameters

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

Definition at line 1135 of file CommandDispatcherComponentAc.cpp.

◆ CMD_NO_OP_STRING_preMsgHook()

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

virtual

Pre-message hook for command CMD_NO_OP_STRING

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1196 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
	)

pure virtual

Handler for command CMD_TEST_CMD_1.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
arg1	The I32 command argument
arg2	The F32 command argument
arg3	The U8 command argument

Implemented in Svc::CommandDispatcherImpl.

◆ CMD_TEST_CMD_1_cmdHandlerBase()

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

Base-class handler function for command CMD_TEST_CMD_1

Parameters

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

Definition at line 1205 of file CommandDispatcherComponentAc.cpp.

◆ CMD_TEST_CMD_1_preMsgHook()

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

virtual

Pre-message hook for command CMD_TEST_CMD_1

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1266 of file CommandDispatcherComponentAc.cpp.

◆ compCmdStat_handler()

virtual void Svc::CommandDispatcherComponentBase::compCmdStat_handler	(	NATIVE_INT_TYPE	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CommandResponse	response
	)

pure 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	(	NATIVE_INT_TYPE	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CommandResponse	response
	)

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 2611 of file CommandDispatcherComponentAc.cpp.

◆ get_CmdDisp_InputPort()

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

Get input port at index

Returns: CmdDisp[portNum]

Parameters

portNum The port number

Definition at line 119 of file CommandDispatcherComponentAc.cpp.

◆ get_compCmdReg_InputPort()

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

Get input port at index

Returns: compCmdReg[portNum]

Parameters

portNum The port number

Definition at line 91 of file CommandDispatcherComponentAc.cpp.

◆ get_compCmdStat_InputPort()

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

Get input port at index

Returns: compCmdStat[portNum]

Parameters

portNum The port number

Definition at line 98 of file CommandDispatcherComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 112 of file CommandDispatcherComponentAc.cpp.

◆ get_seqCmdBuff_InputPort()

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

Get input port at index

Returns: seqCmdBuff[portNum]

Parameters

portNum The port number

Definition at line 105 of file CommandDispatcherComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_CmdDisp_InputPorts ( void )

Get the number of CmdDisp input ports

Returns: The number of CmdDisp input ports

Definition at line 829 of file CommandDispatcherComponentAc.cpp.

◆ getNum_CmdReg_OutputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_CmdReg_OutputPorts ( void )

Get the number of CmdReg output ports

Returns: The number of CmdReg output ports

Definition at line 845 of file CommandDispatcherComponentAc.cpp.

◆ getNum_CmdStatus_OutputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_CmdStatus_OutputPorts ( void )

Get the number of CmdStatus output ports

Returns: The number of CmdStatus output ports

Definition at line 837 of file CommandDispatcherComponentAc.cpp.

◆ getNum_compCmdStat_InputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_compCmdStat_InputPorts ( void )

Get the number of compCmdStat input ports

Returns: The number of compCmdStat input ports

Definition at line 789 of file CommandDispatcherComponentAc.cpp.

◆ getNum_Log_OutputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_Log_OutputPorts ( void )

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 869 of file CommandDispatcherComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_pingIn_InputPorts ( void )

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()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_pingOut_OutputPorts ( void )

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 821 of file CommandDispatcherComponentAc.cpp.

◆ getNum_seqCmdBuff_InputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_seqCmdBuff_InputPorts ( void )

Get the number of seqCmdBuff input ports

Returns: The number of seqCmdBuff input ports

Definition at line 805 of file CommandDispatcherComponentAc.cpp.

◆ getNum_seqCmdStatus_OutputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_seqCmdStatus_OutputPorts ( void )

Get the number of seqCmdStatus output ports

Returns: The number of seqCmdStatus output ports

Definition at line 797 of file CommandDispatcherComponentAc.cpp.

◆ getNum_Time_OutputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_Time_OutputPorts ( void )

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 861 of file CommandDispatcherComponentAc.cpp.

◆ getNum_Tlm_OutputPorts()

NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::getNum_Tlm_OutputPorts ( void )

Get the number of Tlm output ports

Returns: The number of Tlm output ports

Definition at line 853 of file CommandDispatcherComponentAc.cpp.

◆ init()

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

Initialize a CommandDispatcherComponentBase object

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 368 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_CmdReg_OutputPort ( NATIVE_INT_TYPE portNum )

Check whether port CmdReg is connected

Returns: Whether port CmdReg is connected

Parameters

portNum The port number

Definition at line 931 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_CmdStatus_OutputPort ( NATIVE_INT_TYPE portNum )

Check whether port CmdStatus is connected

Returns: Whether port CmdStatus is connected

Parameters

portNum The port number

Definition at line 921 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_Log_OutputPort ( NATIVE_INT_TYPE portNum )

Check whether port Log is connected

Returns: Whether port Log is connected

Parameters

portNum The port number

Definition at line 961 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_pingOut_OutputPort ( NATIVE_INT_TYPE portNum )

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 911 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_seqCmdStatus_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_seqCmdStatus_OutputPort ( NATIVE_INT_TYPE portNum )

Check whether port seqCmdStatus is connected

Returns: Whether port seqCmdStatus is connected

Parameters

portNum The port number

Definition at line 901 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_Time_OutputPort ( NATIVE_INT_TYPE portNum )

Check whether port Time is connected

Returns: Whether port Time is connected

Parameters

portNum The port number

Definition at line 951 of file CommandDispatcherComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::CommandDispatcherComponentBase::isConnected_Tlm_OutputPort ( NATIVE_INT_TYPE portNum )

Check whether port Tlm is connected

Returns: Whether port Tlm is connected

Parameters

portNum The port number

Definition at line 941 of file CommandDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_NoOpReceived()

void Svc::CommandDispatcherComponentBase::log_ACTIVITY_HI_NoOpReceived ( void )

Log event NoOpReceived

Definition at line 2213 of file CommandDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_NoOpStringReceived()

void Svc::CommandDispatcherComponentBase::log_ACTIVITY_HI_NoOpStringReceived ( Fw::LogStringArg & message )

Log event NoOpStringReceived

Parameters

message The NO-OP string that is generated

Definition at line 2292 of file CommandDispatcherComponentAc.cpp.

◆ log_ACTIVITY_HI_TestCmd1Args()

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

Log event TestCmd1Args

Parameters

arg1	Arg1
arg2	Arg2
arg3	Arg3

Definition at line 2380 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeCompleted()

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

Log event OpCodeCompleted

Parameters

Opcode The I32 command argument

Definition at line 1705 of file CommandDispatcherComponentAc.cpp.

◆ log_COMMAND_OpCodeDispatched()

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

Log event OpCodeDispatched

Parameters

Opcode	The opcode dispatched
port	The port dispatched to

Definition at line 1589 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_InvalidCommand()

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

Log event InvalidCommand

Parameters

Opcode Invalid opcode

Definition at line 2017 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_MalformedCommand()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_MalformedCommand ( CmdSerError Status )

Log event MalformedCommand

Parameters

Status The deserialization error

Definition at line 1919 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_OpCodeError()

void Svc::CommandDispatcherComponentBase::log_WARNING_HI_OpCodeError	(	U32	Opcode,
		ErrorResponse	error
	)

Log event OpCodeError

Parameters

Opcode	The opcode with the error
error	The error value

Definition at line 1803 of file CommandDispatcherComponentAc.cpp.

◆ log_WARNING_HI_TooManyCommands()

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

Log event TooManyCommands

Parameters

Opcode The opcode that overflowed the list

Definition at line 2115 of file CommandDispatcherComponentAc.cpp.

◆ m_p_CmdDisp_in()

void Svc::CommandDispatcherComponentBase::m_p_CmdDisp_in	(	Fw::PassiveComponentBase *	callComp,
		NATIVE_INT_TYPE	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

static

Callback for port CmdDisp

< No-op command

< No-op string command

< No-op command

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

Parameters

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

Definition at line 987 of file CommandDispatcherComponentAc.cpp.

◆ m_p_compCmdStat_in()

void Svc::CommandDispatcherComponentBase::m_p_compCmdStat_in	(	Fw::PassiveComponentBase *	callComp,
		NATIVE_INT_TYPE	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CommandResponse	response
	)

static

Callback for port compCmdStat

Parameters

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

Definition at line 2547 of file CommandDispatcherComponentAc.cpp.

◆ m_p_pingIn_in()

void Svc::CommandDispatcherComponentBase::m_p_pingIn_in	(	Fw::PassiveComponentBase *	callComp,
		NATIVE_INT_TYPE	portNum,
		U32	key
	)

static

Callback for port pingIn

Parameters

callComp	The component instance
portNum	The port number
key	Value to return to pinger

Definition at line 2573 of file CommandDispatcherComponentAc.cpp.

◆ m_p_seqCmdBuff_in()

void Svc::CommandDispatcherComponentBase::m_p_seqCmdBuff_in	(	Fw::PassiveComponentBase *	callComp,
		NATIVE_INT_TYPE	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

static

Callback for port seqCmdBuff

Parameters

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

Definition at line 2560 of file CommandDispatcherComponentAc.cpp.

◆ pingIn_handler()

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

pure virtual

Handler for input port pingIn.

Parameters

portNum	The port number
key	Value to return to pinger

Implemented in Svc::CommandDispatcherImpl.

◆ pingIn_handlerBase()

void Svc::CommandDispatcherComponentBase::pingIn_handlerBase	(	NATIVE_INT_TYPE	portNum,
		U32	key
	)

Handler base-class function for input port pingIn

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 2738 of file CommandDispatcherComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::CommandDispatcherComponentBase::pingIn_preMsgHook	(	NATIVE_INT_TYPE	portNum,
		U32	key
	)

virtual

Pre-message hook for async input port pingIn

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 2813 of file CommandDispatcherComponentAc.cpp.

◆ pingOut_out()

void Svc::CommandDispatcherComponentBase::pingOut_out	(	NATIVE_INT_TYPE	portNum,
		U32	key
	)

Invoke output port pingOut

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 759 of file CommandDispatcherComponentAc.cpp.

◆ regCommands()

void Svc::CommandDispatcherComponentBase::regCommands ( void )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 326 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdBuff_handler()

virtual void Svc::CommandDispatcherComponentBase::seqCmdBuff_handler	(	NATIVE_INT_TYPE	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

pure virtual

Handler for input port seqCmdBuff.

Parameters

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

Implemented in Svc::CommandDispatcherImpl.

◆ seqCmdBuff_handlerBase()

void Svc::CommandDispatcherComponentBase::seqCmdBuff_handlerBase	(	NATIVE_INT_TYPE	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

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 2678 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdBuff_preMsgHook()

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

virtual

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 2804 of file CommandDispatcherComponentAc.cpp.

◆ seqCmdStatus_out()

void Svc::CommandDispatcherComponentBase::seqCmdStatus_out	(	NATIVE_INT_TYPE	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CommandResponse	response
	)

Invoke output port seqCmdStatus

Parameters

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

Definition at line 749 of file CommandDispatcherComponentAc.cpp.

◆ set_CmdReg_OutputPort()

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

Connect port to CmdReg[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 170 of file CommandDispatcherComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

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

Connect port to CmdStatus[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 160 of file CommandDispatcherComponentAc.cpp.

◆ set_compCmdSend_OutputPort()

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

Connect port to compCmdSend[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 130 of file CommandDispatcherComponentAc.cpp.

◆ set_Log_OutputPort()

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

Connect port to Log[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 200 of file CommandDispatcherComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 150 of file CommandDispatcherComponentAc.cpp.

◆ set_seqCmdStatus_OutputPort()

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

Connect port to seqCmdStatus[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 140 of file CommandDispatcherComponentAc.cpp.

◆ set_Time_OutputPort()

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

Connect port to Time[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 190 of file CommandDispatcherComponentAc.cpp.

◆ set_Tlm_OutputPort()

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

Connect port to Tlm[portNum]

Parameters

portNum	The port number
port	The port

Definition at line 180 of file CommandDispatcherComponentAc.cpp.

◆ tlmWrite_CommandErrors()

void Svc::CommandDispatcherComponentBase::tlmWrite_CommandErrors ( U32 arg )

Write telemetry channel CommandErrors

Parameters

arg	The telemetry value

Definition at line 1392 of file CommandDispatcherComponentAc.cpp.

◆ unLock()

void Svc::CommandDispatcherComponentBase::unLock ( void )

virtual

Unlock the guarded mutex

Definition at line 2524 of file CommandDispatcherComponentAc.cpp.

Friends And Related Function Documentation

◆ CommandDispatcherComponentBaseFriend

friend class CommandDispatcherComponentBaseFriend

friend

Friend class for white-box testing

Definition at line 58 of file CommandDispatcherComponentAc.hpp.

Member Data Documentation

◆ pad0

PROTECTED Svc::CommandDispatcherComponentBase::__pad0__

Definition at line 264 of file CommandDispatcherComponentAc.hpp.

◆ pad10

PROTECTED Svc::CommandDispatcherComponentBase::__pad10__

The opcode

Definition at line 706 of file CommandDispatcherComponentAc.hpp.

◆ pad11

PROTECTED Svc::CommandDispatcherComponentBase::__pad11__

The opcode

Definition at line 744 of file CommandDispatcherComponentAc.hpp.

◆ pad12

PROTECTED Svc::CommandDispatcherComponentBase::__pad12__

The opcode

Definition at line 783 of file CommandDispatcherComponentAc.hpp.

◆ pad13

PROTECTED Svc::CommandDispatcherComponentBase::__pad13__

Definition at line 797 of file CommandDispatcherComponentAc.hpp.

◆ pad14

PROTECTED Svc::CommandDispatcherComponentBase::__pad14__

The opcode to register

Definition at line 841 of file CommandDispatcherComponentAc.hpp.

◆ pad15

PROTECTED Svc::CommandDispatcherComponentBase::__pad15__

Channel ID for CommandsDispatched.

Definition at line 933 of file CommandDispatcherComponentAc.hpp.

◆ pad16

PROTECTED Svc::CommandDispatcherComponentBase::__pad16__

Definition at line 964 of file CommandDispatcherComponentAc.hpp.

◆ pad17

PRIVATE Svc::CommandDispatcherComponentBase::__pad17__

Definition at line 977 of file CommandDispatcherComponentAc.hpp.

◆ pad18

PRIVATE Svc::CommandDispatcherComponentBase::__pad18__

Definition at line 1003 of file CommandDispatcherComponentAc.hpp.

◆ pad19

PRIVATE Svc::CommandDispatcherComponentBase::__pad19__

The component instance

Definition at line 1047 of file CommandDispatcherComponentAc.hpp.

◆ pad1

PROTECTED Svc::CommandDispatcherComponentBase::__pad1__

Definition at line 293 of file CommandDispatcherComponentAc.hpp.

◆ pad20

PRIVATE Svc::CommandDispatcherComponentBase::__pad20__

Definition at line 1098 of file CommandDispatcherComponentAc.hpp.

◆ pad21

PRIVATE Svc::CommandDispatcherComponentBase::__pad21__

Definition at line 1108 of file CommandDispatcherComponentAc.hpp.

◆ pad22

PRIVATE Svc::CommandDispatcherComponentBase::__pad22__

Definition at line 1118 of file CommandDispatcherComponentAc.hpp.

◆ pad23

PRIVATE Svc::CommandDispatcherComponentBase::__pad23__

Definition at line 1132 of file CommandDispatcherComponentAc.hpp.

◆ pad2

PROTECTED Svc::CommandDispatcherComponentBase::__pad2__

The port number

Definition at line 310 of file CommandDispatcherComponentAc.hpp.

◆ pad3

PROTECTED Svc::CommandDispatcherComponentBase::__pad3__

The port number

Definition at line 347 of file CommandDispatcherComponentAc.hpp.

◆ pad4

PROTECTED Svc::CommandDispatcherComponentBase::__pad4__

The port number

Definition at line 386 of file CommandDispatcherComponentAc.hpp.

◆ pad5

PROTECTED Svc::CommandDispatcherComponentBase::__pad5__

The port number

Definition at line 420 of file CommandDispatcherComponentAc.hpp.

◆ pad6

PROTECTED Svc::CommandDispatcherComponentBase::__pad6__

Definition at line 451 of file CommandDispatcherComponentAc.hpp.

◆ pad7

PROTECTED Svc::CommandDispatcherComponentBase::__pad7__

Definition at line 500 of file CommandDispatcherComponentAc.hpp.

◆ pad8

PROTECTED Svc::CommandDispatcherComponentBase::__pad8__

Definition at line 575 of file CommandDispatcherComponentAc.hpp.

◆ pad9

PROTECTED Svc::CommandDispatcherComponentBase::__pad9__

Definition at line 655 of file CommandDispatcherComponentAc.hpp.

◆ args [1/2]

PROTECTED FwOpcodeType U32 Fw::CmdArgBuffer& Svc::CommandDispatcherComponentBase::args

< Buffer containing arguments

Definition at line 432 of file CommandDispatcherComponentAc.hpp.

◆ args [2/2]

PROTECTED U32 Fw::CmdArgBuffer& Svc::CommandDispatcherComponentBase::args

< The command argument buffer

Definition at line 756 of file CommandDispatcherComponentAc.hpp.

◆ CHANNELID_COMMANDERRORS

PROTECTED Svc::CommandDispatcherComponentBase::CHANNELID_COMMANDERRORS = 1

Channel ID for CommandErrors.

Definition at line 941 of file CommandDispatcherComponentAc.hpp.

◆ cmdSeq [1/2]

PROTECTED U32 Svc::CommandDispatcherComponentBase::cmdSeq

Command Sequence

< The command sequence number

The command sequence number

Definition at line 401 of file CommandDispatcherComponentAc.hpp.

◆ cmdSeq [2/2]

PROTECTED U32 Svc::CommandDispatcherComponentBase::cmdSeq = 0

< The command sequence number

The command sequence number

Definition at line 678 of file CommandDispatcherComponentAc.hpp.

◆ ERR_BUSY

PROTECTED Svc::CommandDispatcherComponentBase::ERR_BUSY

Definition at line 827 of file CommandDispatcherComponentAc.hpp.

◆ ERR_EXECUTION_ERROR

PROTECTED Svc::CommandDispatcherComponentBase::ERR_EXECUTION_ERROR

Definition at line 826 of file CommandDispatcherComponentAc.hpp.

◆ ERR_FORMAT_ERROR

PROTECTED Svc::CommandDispatcherComponentBase::ERR_FORMAT_ERROR

Definition at line 825 of file CommandDispatcherComponentAc.hpp.

◆ ERR_UNEXP

PROTECTED Svc::CommandDispatcherComponentBase::ERR_UNEXP

Definition at line 828 of file CommandDispatcherComponentAc.hpp.

◆ ERR_VALIDATION_ERROR

PROTECTED Svc::CommandDispatcherComponentBase::ERR_VALIDATION_ERROR

Definition at line 824 of file CommandDispatcherComponentAc.hpp.

◆ ErrorResponse

PROTECTED ErrorResponse_MAX Svc::CommandDispatcherComponentBase::ErrorResponse

Definition at line 830 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_INVALIDCOMMAND

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_INVALIDCOMMAND = 5

Definition at line 809 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_MALFORMEDCOMMAND

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_MALFORMEDCOMMAND = 4

Definition at line 808 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_NOOPRECEIVED

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_NOOPRECEIVED = 7

Definition at line 811 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_NOOPSTRINGRECEIVED

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_NOOPSTRINGRECEIVED = 8

Definition at line 812 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_OPCODECOMPLETED

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_OPCODECOMPLETED = 2

Definition at line 806 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_OPCODEDISPATCHED

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_OPCODEDISPATCHED = 1

Definition at line 805 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_OPCODEERROR

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_OPCODEERROR = 3

Definition at line 807 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_TESTCMD1ARGS

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_TESTCMD1ARGS = 9

Definition at line 813 of file CommandDispatcherComponentAc.hpp.

◆ EVENTID_TOOMANYCOMMANDS

PROTECTED Svc::CommandDispatcherComponentBase::EVENTID_TOOMANYCOMMANDS = 6

Definition at line 810 of file CommandDispatcherComponentAc.hpp.

◆ m_CmdDisp_InputPort

Fw::InputCmdPort Svc::CommandDispatcherComponentBase::m_CmdDisp_InputPort[NUM_CMDDISP_INPUT_PORTS]

Input port CmdDisp

Definition at line 1001 of file CommandDispatcherComponentAc.hpp.

◆ m_CmdReg_OutputPort

Fw::OutputCmdRegPort Svc::CommandDispatcherComponentBase::m_CmdReg_OutputPort[NUM_CMDREG_OUTPUT_PORTS]

Output port CmdReg

Definition at line 1027 of file CommandDispatcherComponentAc.hpp.

◆ m_CmdStatus_OutputPort

Fw::OutputCmdResponsePort Svc::CommandDispatcherComponentBase::m_CmdStatus_OutputPort[NUM_CMDSTATUS_OUTPUT_PORTS]

Output port CmdStatus

Definition at line 1023 of file CommandDispatcherComponentAc.hpp.

◆ m_compCmdStat_InputPort

Fw::InputCmdResponsePort Svc::CommandDispatcherComponentBase::m_compCmdStat_InputPort[NUM_COMPCMDSTAT_INPUT_PORTS]

Input port compCmdStat

Definition at line 989 of file CommandDispatcherComponentAc.hpp.

◆ m_first_update_CommandErrors

bool Svc::CommandDispatcherComponentBase::m_first_update_CommandErrors

Initialized to true; cleared when channel CommandErrors is first updated

Definition at line 1130 of file CommandDispatcherComponentAc.hpp.

◆ m_last_CommandErrors

U32 Svc::CommandDispatcherComponentBase::m_last_CommandErrors

Records the last emitted value for channel CommandErrors

Definition at line 1144 of file CommandDispatcherComponentAc.hpp.

◆ m_Log_OutputPort

Fw::OutputLogPort Svc::CommandDispatcherComponentBase::m_Log_OutputPort[NUM_LOG_OUTPUT_PORTS]

Output port Log

Definition at line 1039 of file CommandDispatcherComponentAc.hpp.

◆ m_pingIn_InputPort

Svc::InputPingPort Svc::CommandDispatcherComponentBase::m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS]

Input port pingIn

Definition at line 997 of file CommandDispatcherComponentAc.hpp.

◆ m_pingOut_OutputPort

Svc::OutputPingPort Svc::CommandDispatcherComponentBase::m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS]

Output port pingOut

Definition at line 1019 of file CommandDispatcherComponentAc.hpp.

◆ m_seqCmdBuff_InputPort

Fw::InputComPort Svc::CommandDispatcherComponentBase::m_seqCmdBuff_InputPort[NUM_SEQCMDBUFF_INPUT_PORTS]

Input port seqCmdBuff

Definition at line 993 of file CommandDispatcherComponentAc.hpp.

◆ m_seqCmdStatus_OutputPort

Fw::OutputCmdResponsePort Svc::CommandDispatcherComponentBase::m_seqCmdStatus_OutputPort[NUM_SEQCMDSTATUS_OUTPUT_PORTS]

Output port seqCmdStatus

Definition at line 1015 of file CommandDispatcherComponentAc.hpp.

◆ m_Time_OutputPort

Fw::OutputTimePort Svc::CommandDispatcherComponentBase::m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS]

Output port Time

Definition at line 1035 of file CommandDispatcherComponentAc.hpp.

◆ m_Tlm_OutputPort

Fw::OutputTlmPort Svc::CommandDispatcherComponentBase::m_Tlm_OutputPort[NUM_TLM_OUTPUT_PORTS]

Output port Tlm

Definition at line 1031 of file CommandDispatcherComponentAc.hpp.

◆ opCode [1/2]

PROTECTED FwOpcodeType Svc::CommandDispatcherComponentBase::opCode = 0

< Command Op Code

Command Op Code

Definition at line 320 of file CommandDispatcherComponentAc.hpp.

◆ opCode [2/2]

PRIVATE NATIVE_INT_TYPE FwOpcodeType Svc::CommandDispatcherComponentBase::opCode

< Command Op Code

Definition at line 1058 of file CommandDispatcherComponentAc.hpp.

◆ OPCODE_CMD_CLEAR_TRACKING

PROTECTED Svc::CommandDispatcherComponentBase::OPCODE_CMD_CLEAR_TRACKING = 3

Definition at line 665 of file CommandDispatcherComponentAc.hpp.

◆ OPCODE_CMD_NO_OP_STRING

PROTECTED Svc::CommandDispatcherComponentBase::OPCODE_CMD_NO_OP_STRING = 1

Definition at line 663 of file CommandDispatcherComponentAc.hpp.

◆ OPCODE_CMD_TEST_CMD_1

PROTECTED Svc::CommandDispatcherComponentBase::OPCODE_CMD_TEST_CMD_1 = 2

Definition at line 664 of file CommandDispatcherComponentAc.hpp.

◆ port

PROTECTED I32 Svc::CommandDispatcherComponentBase::port

The registration port

Definition at line 852 of file CommandDispatcherComponentAc.hpp.

◆ portNum

PRIVATE NATIVE_INT_TYPE Svc::CommandDispatcherComponentBase::portNum

The port number

Definition at line 1057 of file CommandDispatcherComponentAc.hpp.

◆ PROTECTED

PROTECTED Svc::CommandDispatcherComponentBase::PROTECTED

The opcode

Definition at line 668 of file CommandDispatcherComponentAc.hpp.

◆ response [1/2]

PROTECTED FwOpcodeType U32 Fw::CommandResponse Svc::CommandDispatcherComponentBase::response

< The command response argument

Definition at line 402 of file CommandDispatcherComponentAc.hpp.

◆ response [2/2]

PROTECTED U32 Fw::CommandResponse Svc::CommandDispatcherComponentBase::response

< The command response

Definition at line 794 of file CommandDispatcherComponentAc.hpp.

◆ slot

PROTECTED I32 I32 Svc::CommandDispatcherComponentBase::slot

< The dispatch slot it was placed in

Definition at line 853 of file CommandDispatcherComponentAc.hpp.

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

build-fprime-automatic-native/F-Prime/Svc/CmdDispatcher/CommandDispatcherComponentAc.hpp
build-fprime-automatic-native/F-Prime/Svc/CmdDispatcher/CommandDispatcherComponentAc.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ CmdSerError

Constructor & Destructor Documentation

◆ ~CommandDispatcherComponentBase()

Member Function Documentation

◆ CMD_CLEAR_TRACKING_cmdHandler()

◆ CMD_CLEAR_TRACKING_cmdHandlerBase()

◆ CMD_CLEAR_TRACKING_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()

◆ compCmdStat_handler()

◆ compCmdStat_handlerBase()

◆ get_CmdDisp_InputPort()

◆ get_compCmdReg_InputPort()

◆ get_compCmdStat_InputPort()

◆ get_pingIn_InputPort()

◆ get_seqCmdBuff_InputPort()

◆ getNum_CmdDisp_InputPorts()

◆ getNum_CmdReg_OutputPorts()

◆ getNum_CmdStatus_OutputPorts()

◆ getNum_compCmdStat_InputPorts()

◆ getNum_Log_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_seqCmdBuff_InputPorts()

◆ getNum_seqCmdStatus_OutputPorts()

◆ getNum_Time_OutputPorts()

◆ getNum_Tlm_OutputPorts()

◆ init()

◆ isConnected_CmdReg_OutputPort()

◆ isConnected_CmdStatus_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_seqCmdStatus_OutputPort()

◆ isConnected_Time_OutputPort()

◆ isConnected_Tlm_OutputPort()

◆ log_ACTIVITY_HI_NoOpReceived()

◆ log_ACTIVITY_HI_NoOpStringReceived()

◆ log_ACTIVITY_HI_TestCmd1Args()

◆ log_COMMAND_OpCodeCompleted()

◆ log_COMMAND_OpCodeDispatched()

◆ log_WARNING_HI_InvalidCommand()

◆ log_WARNING_HI_MalformedCommand()

◆ log_WARNING_HI_OpCodeError()

◆ log_WARNING_HI_TooManyCommands()

◆ m_p_CmdDisp_in()

◆ m_p_compCmdStat_in()

◆ m_p_pingIn_in()

◆ m_p_seqCmdBuff_in()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ regCommands()

◆ seqCmdBuff_handler()

◆ seqCmdBuff_handlerBase()

◆ seqCmdBuff_preMsgHook()

◆ seqCmdStatus_out()

◆ set_CmdReg_OutputPort()

◆ set_CmdStatus_OutputPort()

◆ set_compCmdSend_OutputPort()

◆ set_Log_OutputPort()

◆ set_pingOut_OutputPort()

◆ set_seqCmdStatus_OutputPort()

◆ set_Time_OutputPort()

◆ set_Tlm_OutputPort()

◆ tlmWrite_CommandErrors()

◆ pad0

◆ pad10

◆ pad11

◆ pad12

◆ pad13

◆ pad14

◆ pad15

◆ pad16

◆ pad17

◆ pad18

◆ pad19

◆ pad1

◆ pad20

◆ pad21

◆ pad22

◆ pad23

◆ pad2

◆ pad3

◆ pad4

◆ pad5

◆ pad6

◆ pad7

◆ pad8

◆ pad9