Svc::BufferAccumulator Class Reference

#include <Svc/BufferAccumulator/BufferAccumulator.hpp>

Inheritance diagram for Svc::BufferAccumulator:

Public Member Functions
	BufferAccumulator (const char *const compName)
void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance=0)
	~BufferAccumulator ()
void	allocateQueue (NATIVE_INT_TYPE identifier, Fw::MemAllocator &allocator, NATIVE_UINT_TYPE maxNumBuffers)
void	deallocateQueue (Fw::MemAllocator &allocator)
	Return allocated queue. Should be done during shutdown.

Detailed Description

Definition at line 23 of file BufferAccumulator.hpp.

Constructor & Destructor Documentation

BufferAccumulator()

Svc::BufferAccumulator::BufferAccumulator

(

const char *const

compName

)

Construct BufferAccumulator instance

Parameters

compName

The component name

Definition at line 26 of file BufferAccumulator.cpp.

~BufferAccumulator()

Svc::BufferAccumulator::~BufferAccumulator

(

)

Destroy BufferAccumulator instance

Definition at line 47 of file BufferAccumulator.cpp.

Member Function Documentation

allocateQueue()

void Svc::BufferAccumulator::allocateQueue	(	NATIVE_INT_TYPE	identifier,
		Fw::MemAllocator &	allocator,
		NATIVE_UINT_TYPE	maxNumBuffers
	)

Give the class a memory buffer. Should be called after constructor and init, but before task is spawned.

Parameters

maxNumBuffers

The maximum number of buffers

Definition at line 53 of file BufferAccumulator.cpp.

deallocateQueue()

void Svc::BufferAccumulator::deallocateQueue

(

Fw::MemAllocator &

allocator

)

Return allocated queue. Should be done during shutdown.

Definition at line 67 of file BufferAccumulator.cpp.

init()

void Svc::BufferAccumulator::init	(	const NATIVE_INT_TYPE	queueDepth,
		const NATIVE_INT_TYPE	instance = 0
	)

Initialize BufferAccumulator instance

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 42 of file BufferAccumulator.cpp.

---

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

• Svc/BufferAccumulator/BufferAccumulator.hpp
• Svc/BufferAccumulator/BufferAccumulator.cpp