Svc::StaticMemoryComponentBase Class Reference

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

#include <Svc/StaticMemory/StaticMemoryComponentAc.hpp>

Inheritance diagram for Svc::StaticMemoryComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE instance=0)
	Initialize StaticMemoryComponentBase object. More...
Fw::InputBufferGetPort *	get_bufferAllocate_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputBufferSendPort *	get_bufferDeallocate_InputPort (NATIVE_INT_TYPE portNum)
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...
U32	getIdBase () const

Protected Types
enum	{ NUM_BUFFERALLOCATE_INPUT_PORTS = 4 , NUM_BUFFERDEALLOCATE_INPUT_PORTS = 4 }
	Enumerations for numbers of typed input ports. More...

Protected Member Functions
	StaticMemoryComponentBase (const char *compName="")
	Construct StaticMemoryComponentBase object. More...
virtual	~StaticMemoryComponentBase ()
	Destroy StaticMemoryComponentBase object. More...
NATIVE_INT_TYPE	getNum_bufferAllocate_InputPorts () const
NATIVE_INT_TYPE	getNum_bufferDeallocate_InputPorts () const
virtual Fw::Buffer	bufferAllocate_handler (NATIVE_INT_TYPE portNum, U32 size)=0
	Handler for input port bufferAllocate. More...
virtual void	bufferDeallocate_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port bufferDeallocate. More...
Fw::Buffer	bufferAllocate_handlerBase (NATIVE_INT_TYPE portNum, U32 size)
	Handler base-class function for input port bufferAllocate. More...
void	bufferDeallocate_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port bufferDeallocate. More...
virtual void	lock ()
	Lock the guarded mutex. More...
virtual void	unLock ()
	Unlock the guarded mutex. 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	StaticMemoryComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for StaticMemory component.

A component that provides statically allocated memory

Definition at line 24 of file StaticMemoryComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_BUFFERALLOCATE_INPUT_PORTS
NUM_BUFFERDEALLOCATE_INPUT_PORTS

Definition at line 42 of file StaticMemoryComponentAc.hpp.

Constructor & Destructor Documentation

StaticMemoryComponentBase()

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

protected

Construct StaticMemoryComponentBase object.

Parameters

compName

The component name

Definition at line 122 of file StaticMemoryComponentAc.cpp.

~StaticMemoryComponentBase()

Svc::StaticMemoryComponentBase::~StaticMemoryComponentBase ( )

protectedvirtual

Destroy StaticMemoryComponentBase object.

Definition at line 129 of file StaticMemoryComponentAc.cpp.

Member Function Documentation

bufferAllocate_handler()

virtual Fw::Buffer Svc::StaticMemoryComponentBase::bufferAllocate_handler ( NATIVE_INT_TYPE  portNum, U32  size  )

protectedpure virtual

Handler for input port bufferAllocate.

Parameters

portNum	The port number
size	The requested size

bufferAllocate_handlerBase()

Fw::Buffer Svc::StaticMemoryComponentBase::bufferAllocate_handlerBase ( NATIVE_INT_TYPE  portNum, U32  size  )

protected

Handler base-class function for input port bufferAllocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 157 of file StaticMemoryComponentAc.cpp.

bufferDeallocate_handler()

virtual void Svc::StaticMemoryComponentBase::bufferDeallocate_handler ( NATIVE_INT_TYPE  portNum, Fw::Buffer &  fwBuffer  )

protectedpure virtual

Handler for input port bufferDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

bufferDeallocate_handlerBase()

void Svc::StaticMemoryComponentBase::bufferDeallocate_handlerBase ( NATIVE_INT_TYPE  portNum, Fw::Buffer &  fwBuffer  )

protected

Handler base-class function for input port bufferDeallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 186 of file StaticMemoryComponentAc.cpp.

get_bufferAllocate_InputPort()

Fw::InputBufferGetPort * Svc::StaticMemoryComponentBase::get_bufferAllocate_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

bufferAllocate[portNum]

Parameters

portNum

The port number

Definition at line 96 of file StaticMemoryComponentAc.cpp.

get_bufferDeallocate_InputPort()

Fw::InputBufferSendPort * Svc::StaticMemoryComponentBase::get_bufferDeallocate_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

bufferDeallocate[portNum]

Parameters

portNum

The port number

Definition at line 107 of file StaticMemoryComponentAc.cpp.

getNum_bufferAllocate_InputPorts()

NATIVE_INT_TYPE Svc::StaticMemoryComponentBase::getNum_bufferAllocate_InputPorts ( ) const

protected

Get the number of bufferAllocate input ports

Returns

The number of bufferAllocate input ports

Definition at line 139 of file StaticMemoryComponentAc.cpp.

getNum_bufferDeallocate_InputPorts()

NATIVE_INT_TYPE Svc::StaticMemoryComponentBase::getNum_bufferDeallocate_InputPorts ( ) const

protected

Get the number of bufferDeallocate input ports

Returns

The number of bufferDeallocate input ports

Definition at line 145 of file StaticMemoryComponentAc.cpp.

init()

void Svc::StaticMemoryComponentBase::init

(

NATIVE_INT_TYPE

instance = 0

)

Initialize StaticMemoryComponentBase object.

Parameters

instance

The instance number

Definition at line 21 of file StaticMemoryComponentAc.cpp.

lock()

void Svc::StaticMemoryComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 218 of file StaticMemoryComponentAc.cpp.

unLock()

void Svc::StaticMemoryComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 224 of file StaticMemoryComponentAc.cpp.

Friends And Related Function Documentation

StaticMemoryComponentBaseFriend

friend class StaticMemoryComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 33 of file StaticMemoryComponentAc.hpp.

---

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

• Svc/StaticMemory/StaticMemoryComponentAc.hpp
• Svc/StaticMemory/StaticMemoryComponentAc.cpp