#include <Svc/FrameAccumulator/FrameAccumulator.hpp>

Inheritance diagram for Svc::FrameAccumulator:

Public Member Functions
	FrameAccumulator (const char *const compName)
	Construct FrameAccumulator object. More...

	~FrameAccumulator ()
	Destroy FrameAccumulator object. More...

void	configure (const FrameDetector &detector, FwEnumStoreType allocationId, Fw::MemAllocator &allocator, FwSizeType store_size)
	configure memory allocation for the circular buffer More...

void	cleanup ()
	Deallocate internal resources (set up by configure() call) More...

Public Member Functions inherited from Svc::FrameAccumulatorComponentBase
void	init (FwEnumStoreType instance=0)
	Initialize FrameAccumulatorComponentBase object. More...

Svc::InputComDataWithContextPort *	get_dataIn_InputPort (FwIndexType portNum)

Svc::InputComDataWithContextPort *	get_dataReturnIn_InputPort (FwIndexType portNum)

void	set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to logOut[portNum]. More...

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

void	set_bufferAllocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
	Connect port to bufferAllocate[portNum]. More...

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

void	set_dataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataOut[portNum]. More...

void	set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
	Connect port to dataReturnOut[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...

Friends
class	FrameAccumulatorTester

Additional Inherited Members
Protected Types inherited from Svc::FrameAccumulatorComponentBase
enum	{ NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXTOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_BUFFERALLOCATE_OUTPUT_PORTS = 1, NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ EVENTID_NOBUFFERAVAILABLE = 0x0, EVENTID_FRAMEDETECTIONSIZEERROR = 0x1 }
	Event IDs. More...

Protected Member Functions inherited from Svc::FrameAccumulatorComponentBase
	FrameAccumulatorComponentBase (const char *compName="")
	Construct FrameAccumulatorComponentBase object. More...

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

bool	isConnected_logOut_OutputPort (FwIndexType portNum)

bool	isConnected_timeCaller_OutputPort (FwIndexType portNum)

bool	isConnected_bufferAllocate_OutputPort (FwIndexType portNum)

bool	isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)

bool	isConnected_dataOut_OutputPort (FwIndexType portNum)

bool	isConnected_dataReturnOut_OutputPort (FwIndexType portNum)

void	dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Handler base-class function for input port dataIn. More...

void	dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Handler base-class function for input port dataReturnIn. More...

Fw::Buffer	bufferAllocate_out (FwIndexType portNum, FwSizeType size)
	Invoke output port bufferAllocate. More...

void	bufferDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port bufferDeallocate. More...

void	dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Invoke output port dataOut. More...

void	dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
	Invoke output port dataReturnOut. More...

void	log_WARNING_HI_NoBufferAvailable () const

void	log_WARNING_HI_FrameDetectionSizeError (FwSizeType size_out) const

Fw::Time	getTime () const

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 (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::FrameAccumulatorComponentBase
static constexpr FwIndexType	getNum_dataIn_InputPorts ()

static constexpr FwIndexType	getNum_dataReturnIn_InputPorts ()

static constexpr FwIndexType	getNum_logOut_OutputPorts ()

static constexpr FwIndexType	getNum_timeCaller_OutputPorts ()

static constexpr FwIndexType	getNum_bufferAllocate_OutputPorts ()

static constexpr FwIndexType	getNum_bufferDeallocate_OutputPorts ()

static constexpr FwIndexType	getNum_dataOut_OutputPorts ()

static constexpr FwIndexType	getNum_dataReturnOut_OutputPorts ()

Detailed Description

Definition at line 17 of file FrameAccumulator.hpp.

Constructor & Destructor Documentation

◆ FrameAccumulator()

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

Construct FrameAccumulator object.

Parameters

compName The component name

Definition at line 17 of file FrameAccumulator.cpp.

◆ ~FrameAccumulator()

Svc::FrameAccumulator::~FrameAccumulator ( )

Destroy FrameAccumulator object.

Definition at line 24 of file FrameAccumulator.cpp.

Member Function Documentation

◆ cleanup()

void Svc::FrameAccumulator::cleanup ( )

Deallocate internal resources (set up by configure() call)

Definition at line 41 of file FrameAccumulator.cpp.

◆ configure()

void Svc::FrameAccumulator::configure	(	const FrameDetector &	detector,
		FwEnumStoreType	allocationId,
		Fw::MemAllocator &	allocator,
		FwSizeType	store_size
	)

configure memory allocation for the circular buffer

Takes in parameters used in the Fw::MemAllocator pattern and configures a memory allocation for storing the circular buffer.

Parameters

detector	Frame detector helper instance
allocationId	Identifier used when dealing with the Fw::MemAllocator
allocator	Fw::MemAllocator used to acquire memory
store_size	Size to request for circular buffer

Definition at line 26 of file FrameAccumulator.cpp.

Friends And Related Function Documentation

◆ FrameAccumulatorTester

friend class FrameAccumulatorTester

friend

Definition at line 18 of file FrameAccumulator.hpp.

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

Svc/FrameAccumulator/FrameAccumulator.hpp
Svc/FrameAccumulator/FrameAccumulator.cpp

Public Member Functions

Friends

Additional Inherited Members