#include <Svc/BufferRepeater/BufferRepeater.hpp>

Inheritance diagram for Svc::BufferRepeater:

Public Types
enum	BufferRepeaterFailureOption { NO_RESPONSE_ON_OUT_OF_MEMORY, WARNING_ON_OUT_OF_MEMORY, FATAL_ON_OUT_OF_MEMORY, NUM_BUFFER_REPEATER_FAILURE_OPTIONS }

Public Member Functions
	BufferRepeater (const char *const compName)

	~BufferRepeater ()

void	configure (BufferRepeaterFailureOption allocation_failure_response)

Public Member Functions inherited from Svc::BufferRepeaterComponentBase
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...

Additional Inherited Members
Protected Types inherited from Svc::BufferRepeaterComponentBase
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 inherited from Svc::BufferRepeaterComponentBase
	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

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 inherited from Svc::BufferRepeaterComponentBase
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 ()

Detailed Description

Definition at line 20 of file BufferRepeater.hpp.

Member Enumeration Documentation

◆ BufferRepeaterFailureOption

enum Svc::BufferRepeater::BufferRepeaterFailureOption

Set of responses to failures to allocate a buffer when requested

Enumerator
NO_RESPONSE_ON_OUT_OF_MEMORY	The component will continue regardless of allocation failures
WARNING_ON_OUT_OF_MEMORY	The component will produce a warning on allocation failures
FATAL_ON_OUT_OF_MEMORY	The component will produce a FATAL on allocation failures
NUM_BUFFER_REPEATER_FAILURE_OPTIONS	Maximum value of this setting. Used to mark as uninitialized.

Definition at line 25 of file BufferRepeater.hpp.

Constructor & Destructor Documentation

◆ BufferRepeater()

Svc::BufferRepeater::BufferRepeater ( const char *const compName )

Construct object BufferRepeater

Parameters

compName The component name

Definition at line 23 of file BufferRepeater.cpp.

◆ ~BufferRepeater()

Svc::BufferRepeater::~BufferRepeater ( )

Destroy object BufferRepeater

Definition at line 27 of file BufferRepeater.cpp.

Member Function Documentation

◆ configure()

void Svc::BufferRepeater::configure ( BufferRepeater::BufferRepeaterFailureOption allocation_failure_response )

Set the response used when an allocation request fails to produce a buffer. By default this will assert.

Parameters

allocation_failure_response set response

Definition at line 29 of file BufferRepeater.cpp.

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

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

Public Types

Public Member Functions

Additional Inherited Members