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

#include <Svc/BufferRepeater/BufferRepeaterComponentAc.hpp>

Inheritance diagram for Svc::BufferRepeaterComponentBase:

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

Fw::InputBufferSendPort *	get_portIn_InputPort (FwIndexType portNum)

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

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

void	set_allocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
	Connect port to allocate[portNum].

void	set_deallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to deallocate[portNum].

void	set_portOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to portOut[portNum].

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

U32	getIdBase () const

Protected Types
enum	{ NUM_PORTIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_ALLOCATE_OUTPUT_PORTS = 1 , NUM_DEALLOCATE_OUTPUT_PORTS = 1 , NUM_PORTOUT_OUTPUT_PORTS = 10 }
	Enumerations for numbers of typed output ports. More...

enum	{ EVENTID_ALLOCATIONSOFTFAILURE = 0x0 , EVENTID_ALLOCATIONHARDFAILURE = 0x1 }
	Event IDs. More...

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

virtual	~BufferRepeaterComponentBase ()
	Destroy BufferRepeaterComponentBase object.

FwIndexType	getNum_portIn_InputPorts () const

FwIndexType	getNum_Log_OutputPorts () const

FwIndexType	getNum_Time_OutputPorts () const

FwIndexType	getNum_allocate_OutputPorts () const

FwIndexType	getNum_deallocate_OutputPorts () const

FwIndexType	getNum_portOut_OutputPorts () const

bool	isConnected_Log_OutputPort (FwIndexType portNum)

bool	isConnected_Time_OutputPort (FwIndexType portNum)

bool	isConnected_allocate_OutputPort (FwIndexType portNum)

bool	isConnected_deallocate_OutputPort (FwIndexType portNum)

bool	isConnected_portOut_OutputPort (FwIndexType portNum)

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

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

Fw::Buffer	allocate_out (FwIndexType portNum, U32 size)
	Invoke output port allocate.

void	deallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port deallocate.

void	portOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port portOut.

void	log_WARNING_HI_AllocationSoftFailure (I32 port, U32 size) const

void	log_FATAL_AllocationHardFailure (I32 port, U32 size) const

Fw::Time	getTime ()

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	BufferRepeaterComponentBaseFriend
	Friend class for white-box testing.

Detailed Description

Auto-generated base for BufferRepeater component.

A component for repeating Fw.BufferSend calls to multiple consumers

Definition at line 29 of file BufferRepeaterComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_PORTIN_INPUT_PORTS

Definition at line 47 of file BufferRepeaterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOG_OUTPUT_PORTS
NUM_LOGTEXT_OUTPUT_PORTS
NUM_TIME_OUTPUT_PORTS

Definition at line 52 of file BufferRepeaterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_ALLOCATE_OUTPUT_PORTS
NUM_DEALLOCATE_OUTPUT_PORTS
NUM_PORTOUT_OUTPUT_PORTS

Definition at line 59 of file BufferRepeaterComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_ALLOCATIONSOFTFAILURE	Soft failure in allocation.
EVENTID_ALLOCATIONHARDFAILURE	Hard failure in allocation.

Definition at line 66 of file BufferRepeaterComponentAc.hpp.

Constructor & Destructor Documentation

◆ BufferRepeaterComponentBase()

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

protected

Construct BufferRepeaterComponentBase object.

Parameters

compName The component name

Definition at line 372 of file BufferRepeaterComponentAc.cpp.

◆ ~BufferRepeaterComponentBase()

Svc::BufferRepeaterComponentBase::~BufferRepeaterComponentBase ( )

protectedvirtual

Destroy BufferRepeaterComponentBase object.

Definition at line 379 of file BufferRepeaterComponentAc.cpp.

Member Function Documentation

◆ allocate_out()

Fw::Buffer Svc::BufferRepeaterComponentBase::allocate_out	(	FwIndexType	portNum,
		U32	size
	)

protected

Invoke output port allocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 550 of file BufferRepeaterComponentAc.cpp.

◆ deallocate_out()

void Svc::BufferRepeaterComponentBase::deallocate_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port deallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 565 of file BufferRepeaterComponentAc.cpp.

◆ get_portIn_InputPort()

Fw::InputBufferSendPort * Svc::BufferRepeaterComponentBase::get_portIn_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: portIn[portNum]

Parameters

portNum The port number

Definition at line 171 of file BufferRepeaterComponentAc.cpp.

◆ getNum_allocate_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_allocate_OutputPorts ( ) const

protected

Get the number of allocate output ports

Returns: The number of allocate output ports

Definition at line 425 of file BufferRepeaterComponentAc.cpp.

◆ getNum_deallocate_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_deallocate_OutputPorts ( ) const

protected

Get the number of deallocate output ports

Returns: The number of deallocate output ports

Definition at line 431 of file BufferRepeaterComponentAc.cpp.

◆ getNum_Log_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_Log_OutputPorts ( ) const

protected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 399 of file BufferRepeaterComponentAc.cpp.

◆ getNum_portIn_InputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_portIn_InputPorts ( ) const

protected

Get the number of portIn input ports

Returns: The number of portIn input ports

Definition at line 389 of file BufferRepeaterComponentAc.cpp.

◆ getNum_portOut_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_portOut_OutputPorts ( ) const

protected

Get the number of portOut output ports

Returns: The number of portOut output ports

Definition at line 437 of file BufferRepeaterComponentAc.cpp.

◆ getNum_Time_OutputPorts()

FwIndexType Svc::BufferRepeaterComponentBase::getNum_Time_OutputPorts ( ) const

protected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 415 of file BufferRepeaterComponentAc.cpp.

◆ getTime()

Fw::Time Svc::BufferRepeaterComponentBase::getTime ( )

protected

Get the time

\return The current time

Definition at line 820 of file BufferRepeaterComponentAc.cpp.

◆ init()

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

Initialize BufferRepeaterComponentBase object.

Parameters

instance The instance number

Definition at line 20 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_allocate_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_allocate_OutputPort ( FwIndexType portNum )

protected

Check whether port allocate is connected

Returns: Whether port allocate is connected

Parameters

portNum The port number

Definition at line 488 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_deallocate_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_deallocate_OutputPort ( FwIndexType portNum )

protected

Check whether port deallocate is connected

Returns: Whether port deallocate is connected

Parameters

portNum The port number

Definition at line 499 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_Log_OutputPort ( FwIndexType portNum )

protected

Check whether port Log is connected

Returns: Whether port Log is connected

Parameters

portNum The port number

Definition at line 447 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_portOut_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_portOut_OutputPort ( FwIndexType portNum )

protected

Check whether port portOut is connected

Returns: Whether port portOut is connected

Parameters

portNum The port number

Definition at line 510 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::BufferRepeaterComponentBase::isConnected_Time_OutputPort ( FwIndexType portNum )

protected

Check whether port Time is connected

Returns: Whether port Time is connected

Parameters

portNum The port number

Definition at line 473 of file BufferRepeaterComponentAc.cpp.

◆ log_FATAL_AllocationHardFailure()

void Svc::BufferRepeaterComponentBase::log_FATAL_AllocationHardFailure	(	I32	port,
		U32	size
	)		const

protected

Log event AllocationHardFailure

Hard failure in allocation

Parameters

port	The port index that needed an allocation
size	The requested allocation size

Definition at line 701 of file BufferRepeaterComponentAc.cpp.

◆ log_WARNING_HI_AllocationSoftFailure()

void Svc::BufferRepeaterComponentBase::log_WARNING_HI_AllocationSoftFailure	(	I32	port,
		U32	size
	)		const

protected

Log event AllocationSoftFailure

Soft failure in allocation

Parameters

port	The port index that needed an allocation
size	The requested allocation size

Definition at line 599 of file BufferRepeaterComponentAc.cpp.

◆ portIn_handler()

virtual void Svc::BufferRepeaterComponentBase::portIn_handler	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port portIn.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ portIn_handlerBase()

void Svc::BufferRepeaterComponentBase::portIn_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port portIn.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 527 of file BufferRepeaterComponentAc.cpp.

◆ portOut_out()

void Svc::BufferRepeaterComponentBase::portOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Invoke output port portOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 580 of file BufferRepeaterComponentAc.cpp.

◆ set_allocate_OutputPort()

void Svc::BufferRepeaterComponentBase::set_allocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferGetPort *	port
	)

Connect port to allocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 236 of file BufferRepeaterComponentAc.cpp.

◆ set_deallocate_OutputPort()

void Svc::BufferRepeaterComponentBase::set_deallocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to deallocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 250 of file BufferRepeaterComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::BufferRepeaterComponentBase::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 186 of file BufferRepeaterComponentAc.cpp.

◆ set_portOut_OutputPort()

void Svc::BufferRepeaterComponentBase::set_portOut_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to portOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 264 of file BufferRepeaterComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::BufferRepeaterComponentBase::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 218 of file BufferRepeaterComponentAc.cpp.

Friends And Related Symbol Documentation

◆ BufferRepeaterComponentBaseFriend

friend class BufferRepeaterComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 38 of file BufferRepeaterComponentAc.hpp.

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

Svc/BufferRepeater/BufferRepeaterComponentAc.hpp
Svc/BufferRepeater/BufferRepeaterComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ BufferRepeaterComponentBase()

◆ ~BufferRepeaterComponentBase()

Member Function Documentation

◆ allocate_out()

◆ deallocate_out()

◆ get_portIn_InputPort()

◆ getNum_allocate_OutputPorts()

◆ getNum_deallocate_OutputPorts()

◆ getNum_Log_OutputPorts()

◆ getNum_portIn_InputPorts()

◆ getNum_portOut_OutputPorts()

◆ getNum_Time_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_allocate_OutputPort()

◆ isConnected_deallocate_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_portOut_OutputPort()

◆ isConnected_Time_OutputPort()

◆ log_FATAL_AllocationHardFailure()

◆ log_WARNING_HI_AllocationSoftFailure()

◆ portIn_handler()

◆ portIn_handlerBase()

◆ portOut_out()

◆ set_allocate_OutputPort()

◆ set_deallocate_OutputPort()

◆ set_Log_OutputPort()

◆ set_portOut_OutputPort()

◆ set_Time_OutputPort()

Friends And Related Symbol Documentation

◆ BufferRepeaterComponentBaseFriend