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

#include <Svc/ComQueue/ComQueueComponentAc.hpp>

Inheritance diagram for Svc::ComQueueComponentBase:

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

Fw::InputCmdPort *	get_CmdDisp_InputPort (FwIndexType portNum)

Fw::InputBufferSendPort *	get_bufferQueueIn_InputPort (FwIndexType portNum)

Fw::InputComPort *	get_comPacketQueueIn_InputPort (FwIndexType portNum)

Fw::InputSuccessConditionPort *	get_comStatusIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataReturnIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_run_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_bufferReturnOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferReturnOut[portNum]. More...

void	set_dataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataOut[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_BUFFERQUEUEIN_INPUT_PORTS = 1, NUM_COMPACKETQUEUEIN_INPUT_PORTS = 2, NUM_COMSTATUSIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1, NUM_RUN_INPUT_PORTS = 1 }
	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_BUFFERRETURNOUT_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_FLUSH_QUEUE = 0x0, OPCODE_FLUSH_ALL_QUEUES = 0x1, OPCODE_SET_QUEUE_PRIORITY = 0x2 }
	Command opcodes. More...

enum	{ EVENTID_QUEUEOVERFLOW = 0x0, EVENTID_QUEUEPRIORITYCHANGED = 0x1 }
	Event IDs. More...

enum	{ CHANNELID_COMQUEUEDEPTH = 0x0, CHANNELID_BUFFQUEUEDEPTH = 0x1 }
	Channel IDs. More...

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

Protected Member Functions
	ComQueueComponentBase (const char *compName="")
	Construct ComQueueComponentBase object. More...

virtual	~ComQueueComponentBase ()
	Destroy ComQueueComponentBase 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_bufferReturnOut_OutputPort (FwIndexType portNum) const

bool	isConnected_dataOut_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	bufferQueueIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferQueueIn. More...

virtual void	comPacketQueueIn_handler (FwIndexType portNum, Fw::ComBuffer &data, U32 context)=0
	Handler for input port comPacketQueueIn. More...

virtual void	comStatusIn_handler (FwIndexType portNum, Fw::Success &condition)=0
	Handler for input port comStatusIn. More...

virtual void	dataReturnIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0
	Handler for input port dataReturnIn. More...

virtual void	run_handler (FwIndexType portNum, U32 context)=0
	Handler for input port run. More...

void	bufferQueueIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferQueueIn. More...

void	comPacketQueueIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context)
	Handler base-class function for input port comPacketQueueIn. More...

void	comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition)
	Handler base-class function for input port comStatusIn. More...

void	dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Handler base-class function for input port dataReturnIn. More...

void	run_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port run. More...

virtual void	bufferQueueIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferQueueIn. More...

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

virtual void	comStatusIn_preMsgHook (FwIndexType portNum, Fw::Success &condition)
	Pre-message hook for async input port comStatusIn. More...

virtual void	run_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port run. More...

virtual void	bufferQueueIn_overflowHook (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Overflow hook for async input port bufferQueueIn. More...

void	bufferReturnOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const
	Invoke output port bufferReturnOut. More...

void	dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const
	Invoke output port dataOut. More...

void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...

virtual void	FLUSH_QUEUE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Svc::QueueType &queueType, FwIndexType indexType)=0

virtual void	FLUSH_ALL_QUEUES_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0

virtual void	SET_QUEUE_PRIORITY_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Svc::QueueType &queueType, FwIndexType indexType, FwIndexType newPriority)=0

void	FLUSH_QUEUE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	FLUSH_ALL_QUEUES_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	SET_QUEUE_PRIORITY_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

virtual void	FLUSH_QUEUE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command FLUSH_QUEUE. More...

virtual void	FLUSH_ALL_QUEUES_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command FLUSH_ALL_QUEUES. More...

virtual void	SET_QUEUE_PRIORITY_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command SET_QUEUE_PRIORITY. More...

void	log_WARNING_HI_QueueOverflow (const Svc::QueueType &queueType, FwIndexType index) const

void	log_ACTIVITY_HI_QueuePriorityChanged (const Svc::QueueType &queueType, FwIndexType indexType, FwIndexType newPriority) const

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

void	tlmWrite_comQueueDepth (const Svc::ComQueueDepth &arg, Fw::Time _tlmTime=Fw::Time()) const

void	tlmWrite_buffQueueDepth (const Svc::BuffQueueDepth &arg, Fw::Time _tlmTime=Fw::Time()) const

Fw::Time	getTime () const

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

static constexpr FwIndexType	getNum_comPacketQueueIn_InputPorts ()

static constexpr FwIndexType	getNum_comStatusIn_InputPorts ()

static constexpr FwIndexType	getNum_dataReturnIn_InputPorts ()

static constexpr FwIndexType	getNum_run_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_bufferReturnOut_OutputPorts ()

static constexpr FwIndexType	getNum_dataOut_OutputPorts ()

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

class	ComQueueTester
	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 ComQueue component.

Component used to queue buffer types

Definition at line 46 of file ComQueueComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDDISP_INPUT_PORTS

Definition at line 66 of file ComQueueComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERQUEUEIN_INPUT_PORTS
NUM_COMPACKETQUEUEIN_INPUT_PORTS
NUM_COMSTATUSIN_INPUT_PORTS
NUM_DATARETURNIN_INPUT_PORTS
NUM_RUN_INPUT_PORTS

Definition at line 71 of file ComQueueComponentAc.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 80 of file ComQueueComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERRETURNOUT_OUTPUT_PORTS
NUM_DATAOUT_OUTPUT_PORTS

Definition at line 90 of file ComQueueComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_FLUSH_QUEUE	Flush a specific queue. This will discard all queued data in the specified queue removing it from eventual downlink. Buffers requiring ownership return will be returned via the bufferReturnOut port.
OPCODE_FLUSH_ALL_QUEUES	Flush all queues. This will discard all queued data removing it from eventual downlink. Buffers requiring ownership return will be returned via the bufferReturnOut port.
OPCODE_SET_QUEUE_PRIORITY	Set the priority of a specific queue at runtime.

Definition at line 96 of file ComQueueComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_QUEUEOVERFLOW	Queue overflow event.
EVENTID_QUEUEPRIORITYCHANGED	Queue priority changed event.

Definition at line 105 of file ComQueueComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_COMQUEUEDEPTH	Channel ID for comQueueDepth.
CHANNELID_BUFFQUEUEDEPTH	Channel ID for buffQueueDepth.

Definition at line 111 of file ComQueueComponentAc.hpp.

Constructor & Destructor Documentation

◆ ComQueueComponentBase()

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

protected

Construct ComQueueComponentBase object.

Parameters

compName The component name

Definition at line 790 of file ComQueueComponentAc.cpp.

◆ ~ComQueueComponentBase()

Svc::ComQueueComponentBase::~ComQueueComponentBase ( )

protectedvirtual

Destroy ComQueueComponentBase object.

Definition at line 797 of file ComQueueComponentAc.cpp.

Member Function Documentation

◆ bufferQueueIn_handler()

virtual void Svc::ComQueueComponentBase::bufferQueueIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port bufferQueueIn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferQueueIn_handlerBase()

void Svc::ComQueueComponentBase::bufferQueueIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port bufferQueueIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 969 of file ComQueueComponentAc.cpp.

◆ bufferQueueIn_overflowHook()

virtual void Svc::ComQueueComponentBase::bufferQueueIn_overflowHook	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Overflow hook for async input port bufferQueueIn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferQueueIn_preMsgHook()

void Svc::ComQueueComponentBase::bufferQueueIn_preMsgHook	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedvirtual

Pre-message hook for async input port bufferQueueIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1234 of file ComQueueComponentAc.cpp.

◆ bufferReturnOut_out()

void Svc::ComQueueComponentBase::bufferReturnOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)		const

protected

Invoke output port bufferReturnOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1277 of file ComQueueComponentAc.cpp.

◆ CmdDisp_handlerBase()

void Svc::ComQueueComponentBase::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 917 of file ComQueueComponentAc.cpp.

◆ cmdResponse_out()

void Svc::ComQueueComponentBase::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 1325 of file ComQueueComponentAc.cpp.

◆ comPacketQueueIn_handler()

virtual void Svc::ComQueueComponentBase::comPacketQueueIn_handler	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protectedpure virtual

Handler for input port comPacketQueueIn.

Parameters

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

◆ comPacketQueueIn_handlerBase()

void Svc::ComQueueComponentBase::comPacketQueueIn_handlerBase	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protected

Handler base-class function for input port comPacketQueueIn.

Parameters

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

Definition at line 1027 of file ComQueueComponentAc.cpp.

◆ comPacketQueueIn_preMsgHook()

void Svc::ComQueueComponentBase::comPacketQueueIn_preMsgHook	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)

protectedvirtual

Pre-message hook for async input port comPacketQueueIn.

Parameters

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

Definition at line 1243 of file ComQueueComponentAc.cpp.

◆ comStatusIn_handler()

virtual void Svc::ComQueueComponentBase::comStatusIn_handler	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protectedpure virtual

Handler for input port comStatusIn.

Parameters

portNum	The port number
condition	Condition success/failure

◆ comStatusIn_handlerBase()

void Svc::ComQueueComponentBase::comStatusIn_handlerBase	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protected

Handler base-class function for input port comStatusIn.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 1094 of file ComQueueComponentAc.cpp.

◆ comStatusIn_preMsgHook()

void Svc::ComQueueComponentBase::comStatusIn_preMsgHook	(	FwIndexType	portNum,
		Fw::Success &	condition
	)

protectedvirtual

Pre-message hook for async input port comStatusIn.

Parameters

portNum	The port number
condition	Condition success/failure

Definition at line 1253 of file ComQueueComponentAc.cpp.

◆ dataOut_out()

void Svc::ComQueueComponentBase::dataOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)		const

protected

Invoke output port dataOut.

Parameters

portNum The port number

Definition at line 1297 of file ComQueueComponentAc.cpp.

◆ dataReturnIn_handler()

virtual void Svc::ComQueueComponentBase::dataReturnIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

protectedpure virtual

Handler for input port dataReturnIn.

Parameters

portNum The port number

◆ dataReturnIn_handlerBase()

void Svc::ComQueueComponentBase::dataReturnIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	data,
		const ComCfg::FrameContext &	context
	)

protected

Handler base-class function for input port dataReturnIn.

Parameters

portNum The port number

Definition at line 1147 of file ComQueueComponentAc.cpp.

◆ FLUSH_ALL_QUEUES_cmdHandler()

virtual void Svc::ComQueueComponentBase::FLUSH_ALL_QUEUES_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedpure virtual

Handler for command FLUSH_ALL_QUEUES

Flush all queues. This will discard all queued data removing it from eventual downlink. Buffers requiring ownership return will be returned via the bufferReturnOut port.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ FLUSH_ALL_QUEUES_cmdHandlerBase()

void Svc::ComQueueComponentBase::FLUSH_ALL_QUEUES_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command FLUSH_ALL_QUEUES

Flush all queues. This will discard all queued data removing it from eventual downlink. Buffers requiring ownership return will be returned via the bufferReturnOut port.

Parameters

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

Definition at line 1401 of file ComQueueComponentAc.cpp.

◆ FLUSH_ALL_QUEUES_preMsgHook()

void Svc::ComQueueComponentBase::FLUSH_ALL_QUEUES_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command FLUSH_ALL_QUEUES.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1538 of file ComQueueComponentAc.cpp.

◆ FLUSH_QUEUE_cmdHandler()

virtual void Svc::ComQueueComponentBase::FLUSH_QUEUE_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		const Svc::QueueType &	queueType,
		FwIndexType	indexType
	)

protectedpure virtual

Handler for command FLUSH_QUEUE

Flush a specific queue. This will discard all queued data in the specified queue removing it from eventual downlink. Buffers requiring ownership return will be returned via the bufferReturnOut port.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
queueType	The Queue data type
indexType	The index of the queue (within the supplied type) to flush

◆ FLUSH_QUEUE_cmdHandlerBase()

void Svc::ComQueueComponentBase::FLUSH_QUEUE_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command FLUSH_QUEUE

Flush a specific queue. This will discard all queued data in the specified queue removing it from eventual downlink. Buffers requiring ownership return will be returned via the bufferReturnOut port.

Parameters

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

Definition at line 1342 of file ComQueueComponentAc.cpp.

◆ FLUSH_QUEUE_preMsgHook()

void Svc::ComQueueComponentBase::FLUSH_QUEUE_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command FLUSH_QUEUE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1527 of file ComQueueComponentAc.cpp.

◆ get_bufferQueueIn_InputPort()

Fw::InputBufferSendPort * Svc::ComQueueComponentBase::get_bufferQueueIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: bufferQueueIn[portNum]

Parameters

portNum The port number

Definition at line 440 of file ComQueueComponentAc.cpp.

◆ get_CmdDisp_InputPort()

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

Get special input port at index

Returns: CmdDisp[portNum]

Parameters

portNum The port number

Definition at line 421 of file ComQueueComponentAc.cpp.

◆ get_comPacketQueueIn_InputPort()

Fw::InputComPort * Svc::ComQueueComponentBase::get_comPacketQueueIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: comPacketQueueIn[portNum]

Parameters

portNum The port number

Definition at line 451 of file ComQueueComponentAc.cpp.

◆ get_comStatusIn_InputPort()

Fw::InputSuccessConditionPort * Svc::ComQueueComponentBase::get_comStatusIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: comStatusIn[portNum]

Parameters

portNum The port number

Definition at line 462 of file ComQueueComponentAc.cpp.

◆ get_dataReturnIn_InputPort()

Svc::InputComDataWithContextPort * Svc::ComQueueComponentBase::get_dataReturnIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: dataReturnIn[portNum]

Parameters

portNum The port number

Definition at line 473 of file ComQueueComponentAc.cpp.

◆ get_run_InputPort()

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

Get typed input port at index

Returns: run[portNum]

Parameters

portNum The port number

Definition at line 484 of file ComQueueComponentAc.cpp.

◆ getNum_bufferQueueIn_InputPorts()

static constexpr FwIndexType Svc::ComQueueComponentBase::getNum_bufferQueueIn_InputPorts ( )

inlinestaticprotected

Get the number of bufferQueueIn input ports

Returns: The number of bufferQueueIn input ports

Definition at line 381 of file ComQueueComponentAc.hpp.

◆ getNum_bufferReturnOut_OutputPorts()

static constexpr FwIndexType Svc::ComQueueComponentBase::getNum_bufferReturnOut_OutputPorts ( )

inlinestaticprotected

Get the number of bufferReturnOut output ports

Returns: The number of bufferReturnOut output ports

Definition at line 474 of file ComQueueComponentAc.hpp.

◆ getNum_CmdDisp_InputPorts()

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

inlinestaticprotected

Get the number of CmdDisp input ports

Returns: The number of CmdDisp input ports

Definition at line 368 of file ComQueueComponentAc.hpp.

◆ getNum_CmdReg_OutputPorts()

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

inlinestaticprotected

Get the number of CmdReg output ports

Returns: The number of CmdReg output ports

Definition at line 422 of file ComQueueComponentAc.hpp.

◆ getNum_CmdStatus_OutputPorts()

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

inlinestaticprotected

Get the number of CmdStatus output ports

Returns: The number of CmdStatus output ports

Definition at line 429 of file ComQueueComponentAc.hpp.

◆ getNum_comPacketQueueIn_InputPorts()

static constexpr FwIndexType Svc::ComQueueComponentBase::getNum_comPacketQueueIn_InputPorts ( )

inlinestaticprotected

Get the number of comPacketQueueIn input ports

Returns: The number of comPacketQueueIn input ports

Definition at line 388 of file ComQueueComponentAc.hpp.

◆ getNum_comStatusIn_InputPorts()

static constexpr FwIndexType Svc::ComQueueComponentBase::getNum_comStatusIn_InputPorts ( )

inlinestaticprotected

Get the number of comStatusIn input ports

Returns: The number of comStatusIn input ports

Definition at line 395 of file ComQueueComponentAc.hpp.

◆ getNum_dataOut_OutputPorts()

static constexpr FwIndexType Svc::ComQueueComponentBase::getNum_dataOut_OutputPorts ( )

inlinestaticprotected

Get the number of dataOut output ports

Returns: The number of dataOut output ports

Definition at line 481 of file ComQueueComponentAc.hpp.

◆ getNum_dataReturnIn_InputPorts()

static constexpr FwIndexType Svc::ComQueueComponentBase::getNum_dataReturnIn_InputPorts ( )

inlinestaticprotected

Get the number of dataReturnIn input ports

Returns: The number of dataReturnIn input ports

Definition at line 402 of file ComQueueComponentAc.hpp.

◆ getNum_Log_OutputPorts()

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

inlinestaticprotected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 436 of file ComQueueComponentAc.hpp.

◆ getNum_run_InputPorts()

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

inlinestaticprotected

Get the number of run input ports

Returns: The number of run input ports

Definition at line 409 of file ComQueueComponentAc.hpp.

◆ getNum_Time_OutputPorts()

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

inlinestaticprotected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 454 of file ComQueueComponentAc.hpp.

◆ getNum_Tlm_OutputPorts()

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

inlinestaticprotected

Get the number of Tlm output ports

Returns: The number of Tlm output ports

Definition at line 461 of file ComQueueComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 1875 of file ComQueueComponentAc.cpp.

◆ init()

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

Initialize ComQueueComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 71 of file ComQueueComponentAc.cpp.

◆ isConnected_bufferReturnOut_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_bufferReturnOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port bufferReturnOut is connected

Returns: Whether port bufferReturnOut is connected

Parameters

portNum The port number

Definition at line 887 of file ComQueueComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::ComQueueComponentBase::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 809 of file ComQueueComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::ComQueueComponentBase::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 820 of file ComQueueComponentAc.cpp.

◆ isConnected_dataOut_OutputPort()

bool Svc::ComQueueComponentBase::isConnected_dataOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port dataOut is connected

Returns: Whether port dataOut is connected

Parameters

portNum The port number

Definition at line 898 of file ComQueueComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::ComQueueComponentBase::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 831 of file ComQueueComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::ComQueueComponentBase::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 857 of file ComQueueComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::ComQueueComponentBase::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 868 of file ComQueueComponentAc.cpp.

◆ log_ACTIVITY_HI_QueuePriorityChanged()

void Svc::ComQueueComponentBase::log_ACTIVITY_HI_QueuePriorityChanged	(	const Svc::QueueType &	queueType,
		FwIndexType	indexType,
		FwIndexType	newPriority
	)		const

protected

Log event QueuePriorityChanged

Queue priority changed event

Parameters

queueType	The Queue data type
indexType	The index of the queue (within the supplied type) that was modified
newPriority	New priority value

Definition at line 1669 of file ComQueueComponentAc.cpp.

◆ log_WARNING_HI_QueueOverflow()

void Svc::ComQueueComponentBase::log_WARNING_HI_QueueOverflow	(	const Svc::QueueType &	queueType,
		FwIndexType	index
	)		const

protected

Log event QueueOverflow

Queue overflow event

Parameters

queueType	The Queue data type
index	index of overflowed queue

Definition at line 1564 of file ComQueueComponentAc.cpp.

◆ regCommands()

void Svc::ComQueueComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 765 of file ComQueueComponentAc.cpp.

◆ run_handler()

virtual void Svc::ComQueueComponentBase::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::ComQueueComponentBase::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 1168 of file ComQueueComponentAc.cpp.

◆ run_preMsgHook()

void Svc::ComQueueComponentBase::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 1262 of file ComQueueComponentAc.cpp.

◆ set_bufferReturnOut_OutputPort()

void Svc::ComQueueComponentBase::set_bufferReturnOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferReturnOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 599 of file ComQueueComponentAc.cpp.

◆ set_CmdReg_OutputPort()

void Svc::ComQueueComponentBase::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 503 of file ComQueueComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

void Svc::ComQueueComponentBase::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 517 of file ComQueueComponentAc.cpp.

◆ set_dataOut_OutputPort()

void Svc::ComQueueComponentBase::set_dataOut_OutputPort	(	FwIndexType	portNum,
		Svc::InputComDataWithContextPort *	port
	)

Connect port to dataOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 613 of file ComQueueComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::ComQueueComponentBase::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 531 of file ComQueueComponentAc.cpp.

◆ SET_QUEUE_PRIORITY_cmdHandler()

virtual void Svc::ComQueueComponentBase::SET_QUEUE_PRIORITY_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		const Svc::QueueType &	queueType,
		FwIndexType	indexType,
		FwIndexType	newPriority
	)

protectedpure virtual

Handler for command SET_QUEUE_PRIORITY

Set the priority of a specific queue at runtime

Parameters

opCode	The opcode
cmdSeq	The command sequence number
queueType	The Queue data type
indexType	The index of the queue (within the supplied type) to modify
newPriority	New priority value for the queue

◆ SET_QUEUE_PRIORITY_cmdHandlerBase()

void Svc::ComQueueComponentBase::SET_QUEUE_PRIORITY_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command SET_QUEUE_PRIORITY

Set the priority of a specific queue at runtime

Parameters

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

Definition at line 1460 of file ComQueueComponentAc.cpp.

◆ SET_QUEUE_PRIORITY_preMsgHook()

void Svc::ComQueueComponentBase::SET_QUEUE_PRIORITY_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command SET_QUEUE_PRIORITY.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1549 of file ComQueueComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::ComQueueComponentBase::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 563 of file ComQueueComponentAc.cpp.

◆ set_Tlm_OutputPort()

void Svc::ComQueueComponentBase::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 577 of file ComQueueComponentAc.cpp.

◆ tlmWrite()

void Svc::ComQueueComponentBase::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 1796 of file ComQueueComponentAc.cpp.

◆ tlmWrite_buffQueueDepth()

void Svc::ComQueueComponentBase::tlmWrite_buffQueueDepth	(	const Svc::BuffQueueDepth &	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel buffQueueDepth

Depth of queues of Fw::Buffer type

Parameters

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

Definition at line 1849 of file ComQueueComponentAc.cpp.

◆ tlmWrite_comQueueDepth()

void Svc::ComQueueComponentBase::tlmWrite_comQueueDepth	(	const Svc::ComQueueDepth &	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel comQueueDepth

Depth of queues of Fw::ComBuffer type

Parameters

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

Definition at line 1827 of file ComQueueComponentAc.cpp.

Friends And Related Function Documentation

◆ ComQueueTester

friend class ComQueueTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 57 of file ComQueueComponentAc.hpp.

◆ ComQueueTesterBase

friend class ComQueueTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 55 of file ComQueueComponentAc.hpp.

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

Svc/ComQueue/ComQueueComponentAc.hpp
Svc/ComQueue/ComQueueComponentAc.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

Constructor & Destructor Documentation

◆ ComQueueComponentBase()

◆ ~ComQueueComponentBase()

Member Function Documentation

◆ bufferQueueIn_handler()

◆ bufferQueueIn_handlerBase()

◆ bufferQueueIn_overflowHook()

◆ bufferQueueIn_preMsgHook()

◆ bufferReturnOut_out()

◆ CmdDisp_handlerBase()

◆ cmdResponse_out()

◆ comPacketQueueIn_handler()

◆ comPacketQueueIn_handlerBase()

◆ comPacketQueueIn_preMsgHook()

◆ comStatusIn_handler()

◆ comStatusIn_handlerBase()

◆ comStatusIn_preMsgHook()

◆ dataOut_out()

◆ dataReturnIn_handler()

◆ dataReturnIn_handlerBase()

◆ FLUSH_ALL_QUEUES_cmdHandler()

◆ FLUSH_ALL_QUEUES_cmdHandlerBase()

◆ FLUSH_ALL_QUEUES_preMsgHook()

◆ FLUSH_QUEUE_cmdHandler()

◆ FLUSH_QUEUE_cmdHandlerBase()

◆ FLUSH_QUEUE_preMsgHook()

◆ get_bufferQueueIn_InputPort()

◆ get_CmdDisp_InputPort()

◆ get_comPacketQueueIn_InputPort()

◆ get_comStatusIn_InputPort()

◆ get_dataReturnIn_InputPort()

◆ get_run_InputPort()

◆ getNum_bufferQueueIn_InputPorts()

◆ getNum_bufferReturnOut_OutputPorts()

◆ getNum_CmdDisp_InputPorts()

◆ getNum_CmdReg_OutputPorts()

◆ getNum_CmdStatus_OutputPorts()

◆ getNum_comPacketQueueIn_InputPorts()

◆ getNum_comStatusIn_InputPorts()

◆ getNum_dataOut_OutputPorts()

◆ getNum_dataReturnIn_InputPorts()

◆ getNum_Log_OutputPorts()

◆ getNum_run_InputPorts()

◆ getNum_Time_OutputPorts()

◆ getNum_Tlm_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_bufferReturnOut_OutputPort()

◆ isConnected_CmdReg_OutputPort()

◆ isConnected_CmdStatus_OutputPort()

◆ isConnected_dataOut_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_Time_OutputPort()

◆ isConnected_Tlm_OutputPort()

◆ log_ACTIVITY_HI_QueuePriorityChanged()

◆ log_WARNING_HI_QueueOverflow()

◆ regCommands()

◆ run_handler()

◆ run_handlerBase()

◆ run_preMsgHook()

◆ set_bufferReturnOut_OutputPort()

◆ set_CmdReg_OutputPort()

◆ set_CmdStatus_OutputPort()

◆ set_dataOut_OutputPort()

◆ set_Log_OutputPort()