ReadingSetCircularBuffer Class Reference

Reading set circular buffer class. More...

#include <readingset_circularbuffer.h>

Public Member Functions
	ReadingSetCircularBuffer (unsigned long maxBufferSize=10)
	Construct an empty reading set circular buffer. More...
	~ReadingSetCircularBuffer ()
	Destructor for a result set.
void	insert (ReadingSet *)
	Insert a ReadingSet into circular buffer. More...
void	insert (ReadingSet &)
	Insert a ReadingSet into circular buffer. More...
std::vector< std::shared_ptr< ReadingSet > >	extract (bool isExtractSingleElement=true)
	Fetch the vector of ReadingSet from circular buffer. More...

Detailed Description

Reading set circular buffer class.

Reading set circular buffer is a data structure to hold ReadingSet passed to a plugin.

Constructor & Destructor Documentation

ReadingSetCircularBuffer()

ReadingSetCircularBuffer::ReadingSetCircularBuffer

(

unsigned long

maxBufferSize = 10

)

Construct an empty reading set circular buffer.

Parameters

maxBufferSize

Maximum size of the ReadingSet circular buffer. It should be atleast one.

Member Function Documentation

extract()

std::vector< std::shared_ptr< ReadingSet > > ReadingSetCircularBuffer::extract

(

bool

isExtractSingleElement = true

)

Fetch the vector of ReadingSet from circular buffer.

Parameters

isExtractSingleElement

True to extract single ReadingSet otherwise for extract entire buffer

Returns

Return a vector of shared pointer to ReadingSet

insert() [1/2]

void ReadingSetCircularBuffer::insert

(

ReadingSet *

readings

)

Insert a ReadingSet into circular buffer.

Parameters

readings

Pointer for ReadingSet to be inserted into circular buffer

insert() [2/2]

void ReadingSetCircularBuffer::insert

(

ReadingSet &

readings

)

Insert a ReadingSet into circular buffer.

Parameters

readings

Reference for ReadingSet to be inserted into circular buffer

---

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

• C/common/include/readingset_circularbuffer.h
• C/common/readingset_circularbuffer.cpp