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

#include <Svc/BufferAccumulator/BufferAccumulatorComponentAc.hpp>

Inheritance diagram for Svc::BufferAccumulatorComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize BufferAccumulatorComponentBase object. More...

Fw::InputCmdPort *	get_cmdIn_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputBufferSendPort *	get_bufferSendInFill_InputPort (NATIVE_INT_TYPE portNum)

Fw::InputBufferSendPort *	get_bufferSendInReturn_InputPort (NATIVE_INT_TYPE portNum)

Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)

void	set_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)
	Connect port to cmdRegOut[portNum]. More...

void	set_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
	Connect port to cmdResponseOut[portNum]. More...

void	set_eventOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to eventOut[portNum]. More...

void	set_timeCaller_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to timeCaller[portNum]. More...

void	set_tlmOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
	Connect port to tlmOut[portNum]. More...

void	set_bufferSendOutDrain_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferSendOutDrain[portNum]. More...

void	set_bufferSendOutReturn_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
	Connect port to bufferSendOutReturn[portNum]. More...

void	set_pingOut_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...

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

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

	DEPRECATED (void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1), "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)")
	called by instantiator when task is to be started More...

void	exit ()
	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...

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

U32	getIdBase () const

Protected Types
enum	{ NUM_CMDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of special input ports. More...

enum	{ NUM_BUFFERSENDINFILL_INPUT_PORTS = 1 , NUM_BUFFERSENDINRETURN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUTTEXT_OUTPUT_PORTS = 1 , NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_BUFFERSENDOUTDRAIN_OUTPUT_PORTS = 1 , NUM_BUFFERSENDOUTRETURN_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_BA_SETMODE = 0x0 , OPCODE_BA_DRAINBUFFERS = 0x1 }
	Command opcodes. More...

enum	{ EVENTID_BA_BUFFERACCEPTED = 0x0 , EVENTID_BA_QUEUEFULL = 0x1 , EVENTID_BA_STILLDRAINING = 0x2 , EVENTID_BA_ALREADYDRAINING = 0x3 , EVENTID_BA_DRAINSTALLED = 0x4 , EVENTID_BA_PARTIALDRAINDONE = 0x5 , EVENTID_BA_NONBLOCKDRAIN = 0x6 }
	Event IDs. More...

enum	{ CHANNELID_BA_NUMQUEUEDBUFFERS = 0x0 }
	Channel IDs. More...

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

virtual	~BufferAccumulatorComponentBase ()
	Destroy BufferAccumulatorComponentBase object. More...

NATIVE_INT_TYPE	getNum_cmdIn_InputPorts () const

NATIVE_INT_TYPE	getNum_bufferSendInFill_InputPorts () const

NATIVE_INT_TYPE	getNum_bufferSendInReturn_InputPorts () const

NATIVE_INT_TYPE	getNum_pingIn_InputPorts () const

NATIVE_INT_TYPE	getNum_cmdRegOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_cmdResponseOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_eventOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_timeCaller_OutputPorts () const

NATIVE_INT_TYPE	getNum_tlmOut_OutputPorts () const

NATIVE_INT_TYPE	getNum_bufferSendOutDrain_OutputPorts () const

NATIVE_INT_TYPE	getNum_bufferSendOutReturn_OutputPorts () const

NATIVE_INT_TYPE	getNum_pingOut_OutputPorts () const

bool	isConnected_cmdRegOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_cmdResponseOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_eventOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_timeCaller_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_tlmOut_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_bufferSendOutDrain_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_bufferSendOutReturn_OutputPort (NATIVE_INT_TYPE portNum)

bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)

virtual void	bufferSendInFill_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferSendInFill. More...

virtual void	bufferSendInReturn_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferSendInReturn. More...

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

void	bufferSendInFill_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferSendInFill. More...

void	bufferSendInReturn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferSendInReturn. More...

void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port pingIn. More...

virtual void	bufferSendInFill_preMsgHook (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferSendInFill. More...

virtual void	bufferSendInReturn_preMsgHook (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Pre-message hook for async input port bufferSendInReturn. More...

virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port pingIn. More...

void	bufferSendOutDrain_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferSendOutDrain. More...

void	bufferSendOutReturn_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferSendOutReturn. More...

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

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

virtual void	BA_SetMode_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::BufferAccumulator_OpState mode)=0

virtual void	BA_DrainBuffers_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 numToDrain, Svc::BufferAccumulator_BlockMode blockMode)=0

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

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

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

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

void	log_ACTIVITY_HI_BA_BufferAccepted ()

void	log_WARNING_HI_BA_QueueFull ()

void	log_WARNING_HI_BA_StillDraining (U32 numDrained, U32 numToDrain)

void	log_WARNING_HI_BA_AlreadyDraining ()

void	log_WARNING_HI_BA_DrainStalled (U32 numDrained, U32 numToDrain)

void	log_ACTIVITY_HI_BA_PartialDrainDone (U32 numDrained)

void	log_WARNING_LO_BA_NonBlockDrain (U32 numWillDrain, U32 numReqDrain)

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

Fw::Time	getTime ()

Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

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

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

virtual void	loop ()
	The function that will loop 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 (NATIVE_INT_TYPE instance)
	initialization function More...

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

NATIVE_INT_TYPE	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 (NATIVE_INT_TYPE instance)
	Initialization function. More...

NATIVE_INT_TYPE	getInstance () const

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

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Friends
class	BufferAccumulatorComponentBaseFriend
	Friend class for white-box testing. More...

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

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

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

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

Detailed Description

Auto-generated base for BufferAccumulator component.

Definition at line 35 of file BufferAccumulatorComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS

Definition at line 53 of file BufferAccumulatorComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERSENDINFILL_INPUT_PORTS
NUM_BUFFERSENDINRETURN_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 58 of file BufferAccumulatorComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS
NUM_CMDRESPONSEOUT_OUTPUT_PORTS
NUM_EVENTOUT_OUTPUT_PORTS
NUM_EVENTOUTTEXT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 65 of file BufferAccumulatorComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_BUFFERSENDOUTDRAIN_OUTPUT_PORTS
NUM_BUFFERSENDOUTRETURN_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 75 of file BufferAccumulatorComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_BA_SETMODE	Set the mode.
OPCODE_BA_DRAINBUFFERS	Drain the commanded number of buffers.

Definition at line 82 of file BufferAccumulatorComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_BA_BUFFERACCEPTED	The Buffer Accumulator instance accepted and enqueued a buffer. To avoid uncontrolled sending of events, this event occurs only when the previous buffer received caused a QueueFull error.
EVENTID_BA_QUEUEFULL	The Buffer Accumulator instance received a buffer when its queue was full. To avoid uncontrolled sending of events, this event occurs only when the previous buffer received did not cause a QueueFull error.
EVENTID_BA_STILLDRAINING	Got DrainBuffers command while executing DrainBuffers command.
EVENTID_BA_ALREADYDRAINING	Got DrainBuffers command while in DRAIN mode.
EVENTID_BA_DRAINSTALLED	Ran out of buffers while executing DrainBuffers command.
EVENTID_BA_PARTIALDRAINDONE	Finished DrainBuffers command.
EVENTID_BA_NONBLOCKDRAIN	Not enough buffers to complete requested drain, and NOBLOCK was set; will only drain what we have.

Definition at line 88 of file BufferAccumulatorComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_BA_NUMQUEUEDBUFFERS	Channel ID for BA_NumQueuedBuffers.

Definition at line 99 of file BufferAccumulatorComponentAc.hpp.

Constructor & Destructor Documentation

◆ BufferAccumulatorComponentBase()

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

protected

Construct BufferAccumulatorComponentBase object.

Parameters

compName The component name

Definition at line 825 of file BufferAccumulatorComponentAc.cpp.

◆ ~BufferAccumulatorComponentBase()

Svc::BufferAccumulatorComponentBase::~BufferAccumulatorComponentBase ( )

protectedvirtual

Destroy BufferAccumulatorComponentBase object.

Definition at line 832 of file BufferAccumulatorComponentAc.cpp.

Member Function Documentation

◆ BA_DrainBuffers_cmdHandler()

virtual void Svc::BufferAccumulatorComponentBase::BA_DrainBuffers_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		U32	numToDrain,
		Svc::BufferAccumulator_BlockMode	blockMode
	)

protectedpure virtual

Handler for command BA_DrainBuffers

Drain the commanded number of buffers

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ BA_DrainBuffers_cmdHandlerBase()

void Svc::BufferAccumulatorComponentBase::BA_DrainBuffers_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command BA_DrainBuffers

Drain the commanded number of buffers

Parameters

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

Definition at line 1376 of file BufferAccumulatorComponentAc.cpp.

◆ BA_DrainBuffers_preMsgHook()

void Svc::BufferAccumulatorComponentBase::BA_DrainBuffers_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command BA_DrainBuffers.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1454 of file BufferAccumulatorComponentAc.cpp.

◆ BA_SetMode_cmdHandler()

virtual void Svc::BufferAccumulatorComponentBase::BA_SetMode_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Svc::BufferAccumulator_OpState	mode
	)

protectedpure virtual

Handler for command BA_SetMode

Set the mode

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ BA_SetMode_cmdHandlerBase()

void Svc::BufferAccumulatorComponentBase::BA_SetMode_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command BA_SetMode

Set the mode

Parameters

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

Definition at line 1317 of file BufferAccumulatorComponentAc.cpp.

◆ BA_SetMode_preMsgHook()

void Svc::BufferAccumulatorComponentBase::BA_SetMode_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command BA_SetMode.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1443 of file BufferAccumulatorComponentAc.cpp.

◆ bufferSendInFill_handler()

virtual void Svc::BufferAccumulatorComponentBase::bufferSendInFill_handler	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port bufferSendInFill.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferSendInFill_handlerBase()

void Svc::BufferAccumulatorComponentBase::bufferSendInFill_handlerBase	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port bufferSendInFill.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1053 of file BufferAccumulatorComponentAc.cpp.

◆ bufferSendInFill_preMsgHook()

void Svc::BufferAccumulatorComponentBase::bufferSendInFill_preMsgHook	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedvirtual

Pre-message hook for async input port bufferSendInFill.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1220 of file BufferAccumulatorComponentAc.cpp.

◆ bufferSendInReturn_handler()

virtual void Svc::BufferAccumulatorComponentBase::bufferSendInReturn_handler	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port bufferSendInReturn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferSendInReturn_handlerBase()

void Svc::BufferAccumulatorComponentBase::bufferSendInReturn_handlerBase	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port bufferSendInReturn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1106 of file BufferAccumulatorComponentAc.cpp.

◆ bufferSendInReturn_preMsgHook()

void Svc::BufferAccumulatorComponentBase::bufferSendInReturn_preMsgHook	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedvirtual

Pre-message hook for async input port bufferSendInReturn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1229 of file BufferAccumulatorComponentAc.cpp.

◆ bufferSendOutDrain_out()

void Svc::BufferAccumulatorComponentBase::bufferSendOutDrain_out	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port bufferSendOutDrain.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1251 of file BufferAccumulatorComponentAc.cpp.

◆ bufferSendOutReturn_out()

void Svc::BufferAccumulatorComponentBase::bufferSendOutReturn_out	(	NATIVE_INT_TYPE	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port bufferSendOutReturn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 1266 of file BufferAccumulatorComponentAc.cpp.

◆ cmdResponse_out()

void Svc::BufferAccumulatorComponentBase::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 1300 of file BufferAccumulatorComponentAc.cpp.

◆ get_bufferSendInFill_InputPort()

Fw::InputBufferSendPort * Svc::BufferAccumulatorComponentBase::get_bufferSendInFill_InputPort ( NATIVE_INT_TYPE portNum )

Get typed input port at index

Returns: bufferSendInFill[portNum]

Parameters

portNum The port number

Definition at line 486 of file BufferAccumulatorComponentAc.cpp.

◆ get_bufferSendInReturn_InputPort()

Fw::InputBufferSendPort * Svc::BufferAccumulatorComponentBase::get_bufferSendInReturn_InputPort ( NATIVE_INT_TYPE portNum )

Get typed input port at index

Returns: bufferSendInReturn[portNum]

Parameters

portNum The port number

Definition at line 497 of file BufferAccumulatorComponentAc.cpp.

◆ get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::BufferAccumulatorComponentBase::get_cmdIn_InputPort ( NATIVE_INT_TYPE portNum )

Get special input port at index

Returns: cmdIn[portNum]

Parameters

portNum The port number

Definition at line 471 of file BufferAccumulatorComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 508 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_bufferSendInFill_InputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_bufferSendInFill_InputPorts ( ) const

protected

Get the number of bufferSendInFill input ports

Returns: The number of bufferSendInFill input ports

Definition at line 852 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_bufferSendInReturn_InputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_bufferSendInReturn_InputPorts ( ) const

protected

Get the number of bufferSendInReturn input ports

Returns: The number of bufferSendInReturn input ports

Definition at line 858 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_bufferSendOutDrain_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_bufferSendOutDrain_OutputPorts ( ) const

protected

Get the number of bufferSendOutDrain output ports

Returns: The number of bufferSendOutDrain output ports

Definition at line 918 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_bufferSendOutReturn_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_bufferSendOutReturn_OutputPorts ( ) const

protected

Get the number of bufferSendOutReturn output ports

Returns: The number of bufferSendOutReturn output ports

Definition at line 924 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_cmdIn_InputPorts ( ) const

protected

Get the number of cmdIn input ports

Returns: The number of cmdIn input ports

Definition at line 842 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_cmdRegOut_OutputPorts ( ) const

protected

Get the number of cmdRegOut output ports

Returns: The number of cmdRegOut output ports

Definition at line 874 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const

protected

Get the number of cmdResponseOut output ports

Returns: The number of cmdResponseOut output ports

Definition at line 880 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_eventOut_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_eventOut_OutputPorts ( ) const

protected

Get the number of eventOut output ports

Returns: The number of eventOut output ports

Definition at line 886 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 864 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 930 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 902 of file BufferAccumulatorComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

NATIVE_INT_TYPE Svc::BufferAccumulatorComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 908 of file BufferAccumulatorComponentAc.cpp.

◆ getTime()

Fw::Time Svc::BufferAccumulatorComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 2135 of file BufferAccumulatorComponentAc.cpp.

◆ init()

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

Initialize BufferAccumulatorComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 75 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_bufferSendOutDrain_OutputPort()

bool Svc::BufferAccumulatorComponentBase::isConnected_bufferSendOutDrain_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port bufferSendOutDrain is connected

Returns: Whether port bufferSendOutDrain is connected

Parameters

portNum The port number

Definition at line 1014 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_bufferSendOutReturn_OutputPort()

bool Svc::BufferAccumulatorComponentBase::isConnected_bufferSendOutReturn_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port bufferSendOutReturn is connected

Returns: Whether port bufferSendOutReturn is connected

Parameters

portNum The port number

Definition at line 1025 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::BufferAccumulatorComponentBase::isConnected_cmdRegOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port cmdRegOut is connected

Returns: Whether port cmdRegOut is connected

Parameters

portNum The port number

Definition at line 940 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::BufferAccumulatorComponentBase::isConnected_cmdResponseOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port cmdResponseOut is connected

Returns: Whether port cmdResponseOut is connected

Parameters

portNum The port number

Definition at line 951 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::BufferAccumulatorComponentBase::isConnected_eventOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port eventOut is connected

Returns: Whether port eventOut is connected

Parameters

portNum The port number

Definition at line 962 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

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

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 1036 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::BufferAccumulatorComponentBase::isConnected_timeCaller_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 988 of file BufferAccumulatorComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::BufferAccumulatorComponentBase::isConnected_tlmOut_OutputPort ( NATIVE_INT_TYPE portNum )

protected

Check whether port tlmOut is connected

Returns: Whether port tlmOut is connected

Parameters

portNum The port number

Definition at line 999 of file BufferAccumulatorComponentAc.cpp.

◆ log_ACTIVITY_HI_BA_BufferAccepted()

void Svc::BufferAccumulatorComponentBase::log_ACTIVITY_HI_BA_BufferAccepted ( )

protected

Log event BA_BufferAccepted

The Buffer Accumulator instance accepted and enqueued a buffer. To avoid uncontrolled sending of events, this event occurs only when the previous buffer received caused a QueueFull error.

Definition at line 1469 of file BufferAccumulatorComponentAc.cpp.

◆ log_ACTIVITY_HI_BA_PartialDrainDone()

void Svc::BufferAccumulatorComponentBase::log_ACTIVITY_HI_BA_PartialDrainDone ( U32 numDrained )

protected

Log event BA_PartialDrainDone

Finished DrainBuffers command

Definition at line 1898 of file BufferAccumulatorComponentAc.cpp.

◆ log_WARNING_HI_BA_AlreadyDraining()

void Svc::BufferAccumulatorComponentBase::log_WARNING_HI_BA_AlreadyDraining ( )

protected

Log event BA_AlreadyDraining

Got DrainBuffers command while in DRAIN mode

Definition at line 1719 of file BufferAccumulatorComponentAc.cpp.

◆ log_WARNING_HI_BA_DrainStalled()

void Svc::BufferAccumulatorComponentBase::log_WARNING_HI_BA_DrainStalled	(	U32	numDrained,
		U32	numToDrain
	)

protected

Log event BA_DrainStalled

Ran out of buffers while executing DrainBuffers command

Definition at line 1790 of file BufferAccumulatorComponentAc.cpp.

◆ log_WARNING_HI_BA_QueueFull()

void Svc::BufferAccumulatorComponentBase::log_WARNING_HI_BA_QueueFull ( )

protected

Log event BA_QueueFull

The Buffer Accumulator instance received a buffer when its queue was full. To avoid uncontrolled sending of events, this event occurs only when the previous buffer received did not cause a QueueFull error.

Definition at line 1540 of file BufferAccumulatorComponentAc.cpp.

◆ log_WARNING_HI_BA_StillDraining()

void Svc::BufferAccumulatorComponentBase::log_WARNING_HI_BA_StillDraining	(	U32	numDrained,
		U32	numToDrain
	)

protected

Log event BA_StillDraining

Got DrainBuffers command while executing DrainBuffers command

Definition at line 1611 of file BufferAccumulatorComponentAc.cpp.

◆ log_WARNING_LO_BA_NonBlockDrain()

void Svc::BufferAccumulatorComponentBase::log_WARNING_LO_BA_NonBlockDrain	(	U32	numWillDrain,
		U32	numReqDrain
	)

protected

Log event BA_NonBlockDrain

Not enough buffers to complete requested drain, and NOBLOCK was set; will only drain what we have

Definition at line 1986 of file BufferAccumulatorComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::BufferAccumulatorComponentBase::pingIn_handler	(	NATIVE_INT_TYPE	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::BufferAccumulatorComponentBase::pingIn_handlerBase	(	NATIVE_INT_TYPE	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 1159 of file BufferAccumulatorComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::BufferAccumulatorComponentBase::pingIn_preMsgHook	(	NATIVE_INT_TYPE	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 1238 of file BufferAccumulatorComponentAc.cpp.

◆ pingOut_out()

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

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1281 of file BufferAccumulatorComponentAc.cpp.

◆ regCommands()

void Svc::BufferAccumulatorComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 807 of file BufferAccumulatorComponentAc.cpp.

◆ set_bufferSendOutDrain_OutputPort()

void Svc::BufferAccumulatorComponentBase::set_bufferSendOutDrain_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferSendOutDrain[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 615 of file BufferAccumulatorComponentAc.cpp.

◆ set_bufferSendOutReturn_OutputPort()

void Svc::BufferAccumulatorComponentBase::set_bufferSendOutReturn_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to bufferSendOutReturn[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 629 of file BufferAccumulatorComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::BufferAccumulatorComponentBase::set_cmdRegOut_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputCmdRegPort *	port
	)

Connect port to cmdRegOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 523 of file BufferAccumulatorComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::BufferAccumulatorComponentBase::set_cmdResponseOut_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputCmdResponsePort *	port
	)

Connect port to cmdResponseOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 537 of file BufferAccumulatorComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::BufferAccumulatorComponentBase::set_eventOut_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputLogPort *	port
	)

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 551 of file BufferAccumulatorComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 643 of file BufferAccumulatorComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::BufferAccumulatorComponentBase::set_timeCaller_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 583 of file BufferAccumulatorComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::BufferAccumulatorComponentBase::set_tlmOut_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 597 of file BufferAccumulatorComponentAc.cpp.

◆ tlmWrite_BA_NumQueuedBuffers()

void Svc::BufferAccumulatorComponentBase::tlmWrite_BA_NumQueuedBuffers	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel BA_NumQueuedBuffers

The number of buffers queued

Parameters

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

Definition at line 2098 of file BufferAccumulatorComponentAc.cpp.

Friends And Related Function Documentation

◆ BufferAccumulatorComponentBaseFriend

friend class BufferAccumulatorComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 44 of file BufferAccumulatorComponentAc.hpp.

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

Svc/BufferAccumulator/BufferAccumulatorComponentAc.hpp
Svc/BufferAccumulator/BufferAccumulatorComponentAc.cpp

Public Member Functions

Protected Types

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

◆ BufferAccumulatorComponentBase()

◆ ~BufferAccumulatorComponentBase()

Member Function Documentation

◆ BA_DrainBuffers_cmdHandler()

◆ BA_DrainBuffers_cmdHandlerBase()

◆ BA_DrainBuffers_preMsgHook()

◆ BA_SetMode_cmdHandler()

◆ BA_SetMode_cmdHandlerBase()

◆ BA_SetMode_preMsgHook()

◆ bufferSendInFill_handler()

◆ bufferSendInFill_handlerBase()

◆ bufferSendInFill_preMsgHook()

◆ bufferSendInReturn_handler()

◆ bufferSendInReturn_handlerBase()

◆ bufferSendInReturn_preMsgHook()

◆ bufferSendOutDrain_out()

◆ bufferSendOutReturn_out()

◆ cmdResponse_out()

◆ get_bufferSendInFill_InputPort()

◆ get_bufferSendInReturn_InputPort()

◆ get_cmdIn_InputPort()

◆ get_pingIn_InputPort()

◆ getNum_bufferSendInFill_InputPorts()

◆ getNum_bufferSendInReturn_InputPorts()

◆ getNum_bufferSendOutDrain_OutputPorts()

◆ getNum_bufferSendOutReturn_OutputPorts()

◆ getNum_cmdIn_InputPorts()

◆ getNum_cmdRegOut_OutputPorts()

◆ getNum_cmdResponseOut_OutputPorts()

◆ getNum_eventOut_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_bufferSendOutDrain_OutputPort()

◆ isConnected_bufferSendOutReturn_OutputPort()

◆ isConnected_cmdRegOut_OutputPort()

◆ isConnected_cmdResponseOut_OutputPort()

◆ isConnected_eventOut_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ log_ACTIVITY_HI_BA_BufferAccepted()

◆ log_ACTIVITY_HI_BA_PartialDrainDone()

◆ log_WARNING_HI_BA_AlreadyDraining()

◆ log_WARNING_HI_BA_DrainStalled()

◆ log_WARNING_HI_BA_QueueFull()

◆ log_WARNING_HI_BA_StillDraining()

◆ log_WARNING_LO_BA_NonBlockDrain()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ regCommands()

◆ set_bufferSendOutDrain_OutputPort()

◆ set_bufferSendOutReturn_OutputPort()

◆ set_cmdRegOut_OutputPort()

◆ set_cmdResponseOut_OutputPort()

◆ set_eventOut_OutputPort()

◆ set_pingOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ set_tlmOut_OutputPort()

◆ tlmWrite_BA_NumQueuedBuffers()