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

#include <Svc/BufferManager/BufferManagerComponentAc.hpp>

Inheritance diagram for Svc::BufferManagerComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize BufferManagerComponentBase object.

Fw::InputBufferGetPort *	get_bufferGetCallee_InputPort (FwIndexType portNum)

Fw::InputBufferSendPort *	get_bufferSendIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_schedIn_InputPort (FwIndexType portNum)

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

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

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

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

U32	getIdBase () const

Protected Types
enum	{ NUM_BUFFERGETCALLEE_INPUT_PORTS = 1 , NUM_BUFFERSENDIN_INPUT_PORTS = 1 , NUM_SCHEDIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

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

enum	{ EVENTID_NOBUFFSAVAILABLE = 0x0 , EVENTID_ZEROSIZEBUFFER = 0x1 }
	Event IDs. More...

enum	{ EVENTID_NOBUFFSAVAILABLE_THROTTLE = 10 , EVENTID_ZEROSIZEBUFFER_THROTTLE = 10 }
	Event throttle values: sets initial value of countdown variables. More...

enum	{ CHANNELID_TOTALBUFFS = 0x0 , CHANNELID_CURRBUFFS = 0x1 , CHANNELID_HIBUFFS = 0x2 , CHANNELID_NOBUFFS = 0x3 , CHANNELID_EMPTYBUFFS = 0x4 }
	Channel IDs. More...

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

virtual	~BufferManagerComponentBase ()
	Destroy BufferManagerComponentBase object.

FwIndexType	getNum_bufferGetCallee_InputPorts () const

FwIndexType	getNum_bufferSendIn_InputPorts () const

FwIndexType	getNum_schedIn_InputPorts () const

FwIndexType	getNum_eventOut_OutputPorts () const

FwIndexType	getNum_timeCaller_OutputPorts () const

FwIndexType	getNum_tlmOut_OutputPorts () const

bool	isConnected_eventOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_tlmOut_OutputPort (FwIndexType portNum)

virtual Fw::Buffer	bufferGetCallee_handler (FwIndexType portNum, U32 size)=0
	Handler for input port bufferGetCallee.

virtual void	bufferSendIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferSendIn.

virtual void	schedIn_handler (FwIndexType portNum, U32 context)=0
	Handler for input port schedIn.

Fw::Buffer	bufferGetCallee_handlerBase (FwIndexType portNum, U32 size)
	Handler base-class function for input port bufferGetCallee.

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

void	schedIn_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port schedIn.

void	log_WARNING_HI_NoBuffsAvailable (U32 size)

void	log_WARNING_HI_ZeroSizeBuffer ()

void	log_WARNING_HI_NoBuffsAvailable_ThrottleClear ()
	Reset throttle value for NoBuffsAvailable.

void	log_WARNING_HI_ZeroSizeBuffer_ThrottleClear ()
	Reset throttle value for ZeroSizeBuffer.

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

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

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

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

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

Fw::Time	getTime ()

virtual void	lock ()
	Lock the guarded mutex.

virtual void	unLock ()
	Unlock the guarded mutex.

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

virtual	~PassiveComponentBase ()
	Destructor.

void	init (NATIVE_INT_TYPE instance)
	Initialization function.

NATIVE_INT_TYPE	getInstance () const

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

virtual	~ObjBase ()
	Destructor.

void	init ()
	Object initializer.

Friends
class	BufferManagerComponentBaseFriend
	Friend class for white-box testing.

Detailed Description

Auto-generated base for BufferManager component.

A component for managing memory buffers

Definition at line 33 of file BufferManagerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERGETCALLEE_INPUT_PORTS
NUM_BUFFERSENDIN_INPUT_PORTS
NUM_SCHEDIN_INPUT_PORTS

Definition at line 51 of file BufferManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_EVENTOUT_OUTPUT_PORTS
NUM_TEXTEVENTOUT_OUTPUT_PORTS
NUM_TIMECALLER_OUTPUT_PORTS
NUM_TLMOUT_OUTPUT_PORTS

Definition at line 58 of file BufferManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_NOBUFFSAVAILABLE	The BufferManager was unable to allocate a requested buffer.
EVENTID_ZEROSIZEBUFFER	The buffer manager received a zero-sized buffer as a return. Probably undetected empty buffer allocation.

Definition at line 66 of file BufferManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_NOBUFFSAVAILABLE_THROTTLE	Throttle reset count for NoBuffsAvailable.
EVENTID_ZEROSIZEBUFFER_THROTTLE	Throttle reset count for ZeroSizeBuffer.

Definition at line 72 of file BufferManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_TOTALBUFFS	Channel ID for TotalBuffs.
CHANNELID_CURRBUFFS	Channel ID for CurrBuffs.
CHANNELID_HIBUFFS	Channel ID for HiBuffs.
CHANNELID_NOBUFFS	Channel ID for NoBuffs.
CHANNELID_EMPTYBUFFS	Channel ID for EmptyBuffs.

Definition at line 78 of file BufferManagerComponentAc.hpp.

Constructor & Destructor Documentation

◆ BufferManagerComponentBase()

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

protected

Construct BufferManagerComponentBase object.

Parameters

compName The component name

Definition at line 350 of file BufferManagerComponentAc.cpp.

◆ ~BufferManagerComponentBase()

Svc::BufferManagerComponentBase::~BufferManagerComponentBase ( )

protectedvirtual

Destroy BufferManagerComponentBase object.

Definition at line 378 of file BufferManagerComponentAc.cpp.

Member Function Documentation

◆ bufferGetCallee_handler()

virtual Fw::Buffer Svc::BufferManagerComponentBase::bufferGetCallee_handler	(	FwIndexType	portNum,
		U32	size
	)

protectedpure virtual

Handler for input port bufferGetCallee.

Parameters

portNum	The port number
size	The requested size

◆ bufferGetCallee_handlerBase()

Fw::Buffer Svc::BufferManagerComponentBase::bufferGetCallee_handlerBase	(	FwIndexType	portNum,
		U32	size
	)

protected

Handler base-class function for input port bufferGetCallee.

Parameters

portNum	The port number
size	The requested size

Definition at line 496 of file BufferManagerComponentAc.cpp.

◆ bufferSendIn_handler()

virtual void Svc::BufferManagerComponentBase::bufferSendIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ bufferSendIn_handlerBase()

void Svc::BufferManagerComponentBase::bufferSendIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port bufferSendIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 525 of file BufferManagerComponentAc.cpp.

◆ get_bufferGetCallee_InputPort()

Fw::InputBufferGetPort * Svc::BufferManagerComponentBase::get_bufferGetCallee_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: bufferGetCallee[portNum]

Parameters

portNum The port number

Definition at line 181 of file BufferManagerComponentAc.cpp.

◆ get_bufferSendIn_InputPort()

Fw::InputBufferSendPort * Svc::BufferManagerComponentBase::get_bufferSendIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: bufferSendIn[portNum]

Parameters

portNum The port number

Definition at line 192 of file BufferManagerComponentAc.cpp.

◆ get_schedIn_InputPort()

Svc::InputSchedPort * Svc::BufferManagerComponentBase::get_schedIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: schedIn[portNum]

Parameters

portNum The port number

Definition at line 203 of file BufferManagerComponentAc.cpp.

◆ getNum_bufferGetCallee_InputPorts()

FwIndexType Svc::BufferManagerComponentBase::getNum_bufferGetCallee_InputPorts ( ) const

protected

Get the number of bufferGetCallee input ports

Returns: The number of bufferGetCallee input ports

Definition at line 388 of file BufferManagerComponentAc.cpp.

◆ getNum_bufferSendIn_InputPorts()

FwIndexType Svc::BufferManagerComponentBase::getNum_bufferSendIn_InputPorts ( ) const

protected

Get the number of bufferSendIn input ports

Returns: The number of bufferSendIn input ports

Definition at line 394 of file BufferManagerComponentAc.cpp.

◆ getNum_eventOut_OutputPorts()

FwIndexType Svc::BufferManagerComponentBase::getNum_eventOut_OutputPorts ( ) const

protected

Get the number of eventOut output ports

Returns: The number of eventOut output ports

Definition at line 410 of file BufferManagerComponentAc.cpp.

◆ getNum_schedIn_InputPorts()

FwIndexType Svc::BufferManagerComponentBase::getNum_schedIn_InputPorts ( ) const

protected

Get the number of schedIn input ports

Returns: The number of schedIn input ports

Definition at line 400 of file BufferManagerComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Svc::BufferManagerComponentBase::getNum_timeCaller_OutputPorts ( ) const

protected

Get the number of timeCaller output ports

Returns: The number of timeCaller output ports

Definition at line 426 of file BufferManagerComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

FwIndexType Svc::BufferManagerComponentBase::getNum_tlmOut_OutputPorts ( ) const

protected

Get the number of tlmOut output ports

Returns: The number of tlmOut output ports

Definition at line 432 of file BufferManagerComponentAc.cpp.

◆ getTime()

Fw::Time Svc::BufferManagerComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 1002 of file BufferManagerComponentAc.cpp.

◆ init()

void Svc::BufferManagerComponentBase::init ( FwEnumStoreType instance = 0 )

Initialize BufferManagerComponentBase object.

Parameters

instance The instance number

Definition at line 20 of file BufferManagerComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::BufferManagerComponentBase::isConnected_eventOut_OutputPort ( FwIndexType portNum )

protected

Check whether port eventOut is connected

Returns: Whether port eventOut is connected

Parameters

portNum The port number

Definition at line 442 of file BufferManagerComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::BufferManagerComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType portNum )

protected

Check whether port timeCaller is connected

Returns: Whether port timeCaller is connected

Parameters

portNum The port number

Definition at line 468 of file BufferManagerComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::BufferManagerComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType portNum )

protected

Check whether port tlmOut is connected

Returns: Whether port tlmOut is connected

Parameters

portNum The port number

Definition at line 479 of file BufferManagerComponentAc.cpp.

◆ lock()

void Svc::BufferManagerComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 1022 of file BufferManagerComponentAc.cpp.

◆ log_WARNING_HI_NoBuffsAvailable()

void Svc::BufferManagerComponentBase::log_WARNING_HI_NoBuffsAvailable ( U32 size )

protected

Log event NoBuffsAvailable

The BufferManager was unable to allocate a requested buffer

Parameters

size	The requested size

Definition at line 573 of file BufferManagerComponentAc.cpp.

◆ log_WARNING_HI_NoBuffsAvailable_ThrottleClear()

void Svc::BufferManagerComponentBase::log_WARNING_HI_NoBuffsAvailable_ThrottleClear ( )

protected

Reset throttle value for NoBuffsAvailable.

Definition at line 740 of file BufferManagerComponentAc.cpp.

◆ log_WARNING_HI_ZeroSizeBuffer()

void Svc::BufferManagerComponentBase::log_WARNING_HI_ZeroSizeBuffer ( )

protected

Log event ZeroSizeBuffer

The buffer manager received a zero-sized buffer as a return. Probably undetected empty buffer allocation

Definition at line 663 of file BufferManagerComponentAc.cpp.

◆ log_WARNING_HI_ZeroSizeBuffer_ThrottleClear()

void Svc::BufferManagerComponentBase::log_WARNING_HI_ZeroSizeBuffer_ThrottleClear ( )

protected

Reset throttle value for ZeroSizeBuffer.

Definition at line 747 of file BufferManagerComponentAc.cpp.

◆ schedIn_handler()

virtual void Svc::BufferManagerComponentBase::schedIn_handler	(	FwIndexType	portNum,
		U32	context
	)

protectedpure virtual

Handler for input port schedIn.

Parameters

portNum	The port number
context	The call order

◆ schedIn_handlerBase()

void Svc::BufferManagerComponentBase::schedIn_handlerBase	(	FwIndexType	portNum,
		U32	context
	)

protected

Handler base-class function for input port schedIn.

Parameters

portNum	The port number
context	The call order

Definition at line 550 of file BufferManagerComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::BufferManagerComponentBase::set_eventOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputLogPort *	port
	)

Connect port to eventOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 218 of file BufferManagerComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::BufferManagerComponentBase::set_timeCaller_OutputPort	(	FwIndexType	portNum,
		Fw::InputTimePort *	port
	)

Connect port to timeCaller[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 250 of file BufferManagerComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::BufferManagerComponentBase::set_tlmOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to tlmOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 264 of file BufferManagerComponentAc.cpp.

◆ tlmWrite_CurrBuffs()

void Svc::BufferManagerComponentBase::tlmWrite_CurrBuffs	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel CurrBuffs

The current number of allocated buffers

Parameters

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

Definition at line 806 of file BufferManagerComponentAc.cpp.

◆ tlmWrite_EmptyBuffs()

void Svc::BufferManagerComponentBase::tlmWrite_EmptyBuffs	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel EmptyBuffs

The number of empty buffers returned

Parameters

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

Definition at line 950 of file BufferManagerComponentAc.cpp.

◆ tlmWrite_HiBuffs()

void Svc::BufferManagerComponentBase::tlmWrite_HiBuffs	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel HiBuffs

The high water mark of allocated buffers

Parameters

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

Definition at line 854 of file BufferManagerComponentAc.cpp.

◆ tlmWrite_NoBuffs()

void Svc::BufferManagerComponentBase::tlmWrite_NoBuffs	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel NoBuffs

The number of requests that couldn't return a buffer

Parameters

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

Definition at line 902 of file BufferManagerComponentAc.cpp.

◆ tlmWrite_TotalBuffs()

void Svc::BufferManagerComponentBase::tlmWrite_TotalBuffs	(	U32	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel TotalBuffs

The total buffers allocated

Parameters

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

Definition at line 758 of file BufferManagerComponentAc.cpp.

◆ unLock()

void Svc::BufferManagerComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 1028 of file BufferManagerComponentAc.cpp.

Friends And Related Symbol Documentation

◆ BufferManagerComponentBaseFriend

friend class BufferManagerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 42 of file BufferManagerComponentAc.hpp.

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

Svc/BufferManager/BufferManagerComponentAc.hpp
Svc/BufferManager/BufferManagerComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ BufferManagerComponentBase()

◆ ~BufferManagerComponentBase()

Member Function Documentation

◆ bufferGetCallee_handler()

◆ bufferGetCallee_handlerBase()

◆ bufferSendIn_handler()

◆ bufferSendIn_handlerBase()

◆ get_bufferGetCallee_InputPort()

◆ get_bufferSendIn_InputPort()

◆ get_schedIn_InputPort()

◆ getNum_bufferGetCallee_InputPorts()

◆ getNum_bufferSendIn_InputPorts()

◆ getNum_eventOut_OutputPorts()

◆ getNum_schedIn_InputPorts()

◆ getNum_timeCaller_OutputPorts()

◆ getNum_tlmOut_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_eventOut_OutputPort()

◆ isConnected_timeCaller_OutputPort()

◆ isConnected_tlmOut_OutputPort()

◆ lock()

◆ log_WARNING_HI_NoBuffsAvailable()

◆ log_WARNING_HI_NoBuffsAvailable_ThrottleClear()

◆ log_WARNING_HI_ZeroSizeBuffer()

◆ log_WARNING_HI_ZeroSizeBuffer_ThrottleClear()

◆ schedIn_handler()

◆ schedIn_handlerBase()

◆ set_eventOut_OutputPort()

◆ set_timeCaller_OutputPort()

◆ set_tlmOut_OutputPort()

◆ tlmWrite_CurrBuffs()

◆ tlmWrite_EmptyBuffs()

◆ tlmWrite_HiBuffs()

◆ tlmWrite_NoBuffs()

◆ tlmWrite_TotalBuffs()

◆ unLock()

Friends And Related Symbol Documentation

◆ BufferManagerComponentBaseFriend