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. More...

Fw::InputBufferSendPort *	get_portIn_InputPort (FwIndexType portNum)

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_allocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
	Connect port to allocate[portNum]. More...

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

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

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

FwIdType	getIdBase () const

virtual void	deinit ()
	Deinitialization function. More...

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. More...

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

bool	isConnected_Log_OutputPort (FwIndexType portNum) const

bool	isConnected_Time_OutputPort (FwIndexType portNum) const

bool	isConnected_allocate_OutputPort (FwIndexType portNum) const

bool	isConnected_deallocate_OutputPort (FwIndexType portNum) const

bool	isConnected_portOut_OutputPort (FwIndexType portNum) const

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

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

Fw::Buffer	allocate_out (FwIndexType portNum, FwSizeType size) const
	Invoke output port allocate. More...

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

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

void	log_WARNING_HI_AllocationSoftFailure (I32 port, FwSizeType size) const

void	log_FATAL_AllocationHardFailure (I32 port, FwSizeType size) const

Fw::Time	getTime () const

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

static constexpr FwIndexType	getNum_Log_OutputPorts ()

static constexpr FwIndexType	getNum_Time_OutputPorts ()

static constexpr FwIndexType	getNum_allocate_OutputPorts ()

static constexpr FwIndexType	getNum_deallocate_OutputPorts ()

static constexpr FwIndexType	getNum_portOut_OutputPorts ()

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

class	BufferRepeaterTester
	Friend class tester implementation to support white-box testing. More...

Detailed Description

Auto-generated base for BufferRepeater component.

A component for repeating Fw.BufferSend calls to multiple consumers

Definition at line 36 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 56 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 61 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 68 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 75 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 397 of file BufferRepeaterComponentAc.cpp.

◆ ~BufferRepeaterComponentBase()

Svc::BufferRepeaterComponentBase::~BufferRepeaterComponentBase ( )

protectedvirtual

Destroy BufferRepeaterComponentBase object.

Definition at line 404 of file BufferRepeaterComponentAc.cpp.

Member Function Documentation

◆ allocate_out()

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

protected

Invoke output port allocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 527 of file BufferRepeaterComponentAc.cpp.

◆ deallocate_out()

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

protected

Invoke output port deallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 547 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 186 of file BufferRepeaterComponentAc.cpp.

◆ getNum_allocate_OutputPorts()

static constexpr FwIndexType Svc::BufferRepeaterComponentBase::getNum_allocate_OutputPorts ( )

inlinestaticprotected

Get the number of allocate output ports

Returns: The number of allocate output ports

Definition at line 289 of file BufferRepeaterComponentAc.hpp.

◆ getNum_deallocate_OutputPorts()

static constexpr FwIndexType Svc::BufferRepeaterComponentBase::getNum_deallocate_OutputPorts ( )

inlinestaticprotected

Get the number of deallocate output ports

Returns: The number of deallocate output ports

Definition at line 296 of file BufferRepeaterComponentAc.hpp.

◆ getNum_Log_OutputPorts()

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

inlinestaticprotected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 258 of file BufferRepeaterComponentAc.hpp.

◆ getNum_portIn_InputPorts()

static constexpr FwIndexType Svc::BufferRepeaterComponentBase::getNum_portIn_InputPorts ( )

inlinestaticprotected

Get the number of portIn input ports

Returns: The number of portIn input ports

Definition at line 245 of file BufferRepeaterComponentAc.hpp.

◆ getNum_portOut_OutputPorts()

static constexpr FwIndexType Svc::BufferRepeaterComponentBase::getNum_portOut_OutputPorts ( )

inlinestaticprotected

Get the number of portOut output ports

Returns: The number of portOut output ports

Definition at line 303 of file BufferRepeaterComponentAc.hpp.

◆ getNum_Time_OutputPorts()

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

inlinestaticprotected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 276 of file BufferRepeaterComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 814 of file BufferRepeaterComponentAc.cpp.

◆ init()

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

Initialize BufferRepeaterComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_allocate_OutputPort()

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

protected

Check whether port allocate is connected

Returns: Whether port allocate is connected

Parameters

portNum The port number

Definition at line 461 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_deallocate_OutputPort()

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

protected

Check whether port deallocate is connected

Returns: Whether port deallocate is connected

Parameters

portNum The port number

Definition at line 472 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_Log_OutputPort()

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

◆ isConnected_portOut_OutputPort()

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

protected

Check whether port portOut is connected

Returns: Whether port portOut is connected

Parameters

portNum The port number

Definition at line 483 of file BufferRepeaterComponentAc.cpp.

◆ isConnected_Time_OutputPort()

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

◆ log_FATAL_AllocationHardFailure()

void Svc::BufferRepeaterComponentBase::log_FATAL_AllocationHardFailure	(	I32	port,
		FwSizeType	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 695 of file BufferRepeaterComponentAc.cpp.

◆ log_WARNING_HI_AllocationSoftFailure()

void Svc::BufferRepeaterComponentBase::log_WARNING_HI_AllocationSoftFailure	(	I32	port,
		FwSizeType	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 593 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 502 of file BufferRepeaterComponentAc.cpp.

◆ portOut_out()

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

protected

Invoke output port portOut.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 567 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 259 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 273 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 205 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 287 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 237 of file BufferRepeaterComponentAc.cpp.

Friends And Related Function Documentation

◆ BufferRepeaterTester

friend class BufferRepeaterTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 47 of file BufferRepeaterComponentAc.hpp.

◆ BufferRepeaterTesterBase

friend class BufferRepeaterTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 45 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

Static 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 Function Documentation

◆ BufferRepeaterTester

◆ BufferRepeaterTesterBase