CbmTbDaqBuffer Class Reference

Singleton buffer class for CBM raw data. More...

#include <CbmTbDaqBuffer.h>

Collaboration diagram for CbmTbDaqBuffer:

Public Types
typedef std::pair< boost::any, ECbmModuleId >	Data

Public Member Functions
	~CbmTbDaqBuffer ()
Data	GetNextData (Double_t time)
Int_t	GetSize () const
Double_t	GetTimeFirst () const
Double_t	GetTimeLast () const
void	PrintStatus () const
template<class Digi>
void	InsertData (Digi *digi)

Static Public Member Functions
static CbmTbDaqBuffer *	Instance ()

Private Member Functions
	CbmTbDaqBuffer ()
	CbmTbDaqBuffer (const CbmTbDaqBuffer &)
CbmTbDaqBuffer &	operator= (const CbmTbDaqBuffer &)
void	InsertData (boost::any digi, Double_t time, ECbmModuleId systemID)

Private Attributes
std::multimap< Double_t, Data >	fData

Static Private Attributes
static CbmTbDaqBuffer *	fgInstance = nullptr

Detailed Description

Singleton buffer class for CBM raw data.

Author

Volker Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e

Date

13 December 2012

The CbmTbDaqBuffer stores and sorts (w.r.t. time) CBM raw data (currently: boost::any) transiently. Data can be send to the buffer by the method InsertData. They can be retrieved by GetNextData, which delivers a time-ordered sequence of raw data objects.

There is only one buffer stream, irrespective of the detector system.

The buffer handles objects only by pointer, i.e. the data have to be instantiated by the sending task (digitiser) and deleted by the receiving class (CbmDaq).

Definition at line 39 of file CbmTbDaqBuffer.h.

Member Typedef Documentation

Data

typedef std::pair<boost::any, ECbmModuleId> CbmTbDaqBuffer::Data

Definition at line 41 of file CbmTbDaqBuffer.h.

Constructor & Destructor Documentation

~CbmTbDaqBuffer()

CbmTbDaqBuffer::~CbmTbDaqBuffer

(

)

Destructor

Definition at line 31 of file CbmTbDaqBuffer.cxx.

CbmTbDaqBuffer() [1/2]

CbmTbDaqBuffer::CbmTbDaqBuffer ( )

private

Default constructor Declared private to prevent instantiation.

Definition at line 26 of file CbmTbDaqBuffer.cxx.

References fData.

Referenced by CbmTbDaqBuffer(), Instance(), and operator=().

CbmTbDaqBuffer() [2/2]

CbmTbDaqBuffer::CbmTbDaqBuffer ( const CbmTbDaqBuffer & )

private

Copy constructor. Defined private to prevent usage.

References CbmTbDaqBuffer().

Member Function Documentation

GetNextData()

CbmTbDaqBuffer::Data CbmTbDaqBuffer::GetNextData

(

Double_t

time

)

Pointer to next raw data object up to given time

Parameters

time	maximal time [ns]

Returns

pointer to raw data object

A NULL pointer will be returned if no further data can be released. This does not mean that the buffer is empty.

Definition at line 51 of file CbmTbDaqBuffer.cxx.

References fData, and kNotExist.

GetSize()

Int_t CbmTbDaqBuffer::GetSize ( ) const

inline

Current buffer size

Returns

number of objects in buffer

Definition at line 61 of file CbmTbDaqBuffer.h.

References fData.

Referenced by GetTimeFirst(), GetTimeLast(), and PrintStatus().

GetTimeFirst()

Double_t CbmTbDaqBuffer::GetTimeFirst

(

)

const

Get first digi time

Definition at line 34 of file CbmTbDaqBuffer.cxx.

References fData, and GetSize().

Referenced by PrintStatus().

GetTimeLast()

Double_t CbmTbDaqBuffer::GetTimeLast

(

)

const

Get last digi time

Definition at line 42 of file CbmTbDaqBuffer.cxx.

References fData, and GetSize().

Referenced by PrintStatus().

InsertData() [1/2]

void CbmTbDaqBuffer::InsertData ( boost::any digi, Double_t time, ECbmModuleId systemID )

inlineprivate

Insert data into the buffer

Parameters

digi	pointer to data object to be inserted

Definition at line 113 of file CbmTbDaqBuffer.h.

References fData.

InsertData() [2/2]

template<class Digi>

void CbmTbDaqBuffer::InsertData ( Digi * digi )

inline

Insert digi of any type into the buffer

Definition at line 80 of file CbmTbDaqBuffer.h.

References InsertData().

Referenced by InsertData().

Instance()

CbmTbDaqBuffer * CbmTbDaqBuffer::Instance ( )

static

Access to singleton instance

Returns

pointer to instance

Definition at line 72 of file CbmTbDaqBuffer.cxx.

References CbmTbDaqBuffer(), and fgInstance.

operator=()

CbmTbDaqBuffer & CbmTbDaqBuffer::operator= ( const CbmTbDaqBuffer & )

private

Assignment operator. Defined private to prevent usage.

References CbmTbDaqBuffer().

PrintStatus()

void CbmTbDaqBuffer::PrintStatus

(

)

const

Print buffer status

Definition at line 80 of file CbmTbDaqBuffer.cxx.

References GetSize(), GetTimeFirst(), GetTimeLast(), and size().

Member Data Documentation

fData

std::multimap<Double_t, Data> CbmTbDaqBuffer::fData

private

Buffer management

Definition at line 89 of file CbmTbDaqBuffer.h.

Referenced by CbmTbDaqBuffer(), GetNextData(), GetSize(), GetTimeFirst(), GetTimeLast(), and InsertData().

fgInstance

CbmTbDaqBuffer * CbmTbDaqBuffer::fgInstance = nullptr

staticprivate

Pointer to singleton instance

Definition at line 93 of file CbmTbDaqBuffer.h.

Referenced by Instance().

---

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

• CbmTbDaqBuffer.h
• CbmTbDaqBuffer.cxx