std::vector implementation of CbmDigiContainer More...

#include <CbmDigiVector.h>

Inheritance diagram for CbmDigiVector< Digi >:

Collaboration diagram for CbmDigiVector< Digi >:

Public Member Functions
	CbmDigiVector (bool hasMatches=false)
	Constructor.

virtual	~CbmDigiVector ()
	Destructor.

virtual void	AddDigi (boost::any digi, const CbmMatch *match=nullptr)
	Add a digi (and match) to the vector.

virtual bool	ConnectToTree ()
	Connect to a ROOT TTree.

virtual boost::any	GetDigi (uint32_t index)
	Get digi object.

virtual const CbmMatch *	GetDigiMatch (uint32_t index)
	Get digi match object.

virtual bool	HasMatches () const
	Presence of match objects.

virtual uint64_t	GetNofDigis () const
	Number of digis in the vector.

virtual std::string	ToString () const
	String output.

virtual const char *	GetName () const
	Name of container.

	ClassDef (CbmDigiContainer, 1)

Private Member Functions
	ClassDef (CbmDigiVector, 1)

Private Attributes
std::vector< Digi >	fDigis {}

std::vector< CbmMatch >	fMatches {}

bool	fHasMatches = false

bool	fIsLocked = false

Detailed Description

template<class Digi>
class CbmDigiVector< Digi >

std::vector implementation of CbmDigiContainer

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

Since: 11 March 2020

Definition at line 28 of file CbmDigiVector.h.

Constructor & Destructor Documentation

◆ CbmDigiVector()

template<class Digi >

CbmDigiVector< Digi >::CbmDigiVector ( bool hasMatches = false )

inline

Constructor.

Parameters

hasMatches If true, a match vector will be managed.

Definition at line 34 of file CbmDigiVector.h.

◆ ~CbmDigiVector()

template<class Digi >

virtual CbmDigiVector< Digi >::~CbmDigiVector ( )

inlinevirtual

Destructor.

Definition at line 43 of file CbmDigiVector.h.

Member Function Documentation

◆ AddDigi()

template<class Digi >

virtual void CbmDigiVector< Digi >::AddDigi	(	boost::any	digi,
		const CbmMatch *	match = nullptr )

inlinevirtual

Add a digi (and match) to the vector.

Parameters

digi	Pointer to digi object
match	Pointer to match object

After the first call to GetDigi or GetMatch, the vector is locked; adding more digis is then not possible.

Reimplemented from CbmDigiContainer.

Definition at line 53 of file CbmDigiVector.h.

References CbmDigiVector< Digi >::fDigis, CbmDigiVector< Digi >::fHasMatches, CbmDigiVector< Digi >::fIsLocked, CbmDigiVector< Digi >::fMatches, and CbmDigiContainer::GetName().

◆ ClassDef() [1/2]

CbmDigiContainer::ClassDef	(	CbmDigiContainer	,
		1	)

inherited

◆ ClassDef() [2/2]

template<class Digi >

CbmDigiVector< Digi >::ClassDef	(	CbmDigiVector< Digi >	,
		1	)

private

◆ ConnectToTree()

template<class Digi >

virtual bool CbmDigiVector< Digi >::ConnectToTree ( )

inlinevirtual

Connect to a ROOT TTree.

Abstract from base class; no implementation here.

Reimplemented from CbmDigiContainer.

Definition at line 80 of file CbmDigiVector.h.

◆ GetDigi()

template<class Digi >

virtual boost::any CbmDigiVector< Digi >::GetDigi ( uint32_t index )

inlinevirtual

Get digi object.

Parameters

index Index of digi in the vector

Returns: Pointer to constant digi object

Returns a null pointer if index is out of range.

Implements CbmDigiContainer.

Definition at line 93 of file CbmDigiVector.h.

References CbmDigiVector< Digi >::fDigis, and CbmDigiVector< Digi >::fIsLocked.

◆ GetDigiMatch()

template<class Digi >

virtual const CbmMatch * CbmDigiVector< Digi >::GetDigiMatch ( uint32_t index )

inlinevirtual

Get digi match object.

Parameters

index Index of digi in the vector

Returns: Pointer to corresponding match object

Returns a null pointer if matches are not present or index is out of range.

Implements CbmDigiContainer.

Definition at line 109 of file CbmDigiVector.h.

References CbmDigiVector< Digi >::fHasMatches, CbmDigiVector< Digi >::fIsLocked, and CbmDigiVector< Digi >::fMatches.

◆ GetName()

virtual const char * CbmDigiContainer::GetName ( ) const

inlinevirtualinherited

Name of container.

Definition at line 83 of file CbmDigiContainer.h.

Referenced by CbmDigiVector< Digi >::AddDigi(), CbmDigiContainer::ToString(), and CbmDigiVector< Digi >::ToString().

◆ GetNofDigis()

template<class Digi >

virtual uint64_t CbmDigiVector< Digi >::GetNofDigis ( ) const

inlinevirtual

Number of digis in the vector.

Returns: Number of digi objects

Implements CbmDigiContainer.

Definition at line 127 of file CbmDigiVector.h.

References CbmDigiVector< Digi >::fDigis, CbmDigiVector< Digi >::fHasMatches, and CbmDigiVector< Digi >::fMatches.

◆ HasMatches()

template<class Digi >

virtual bool CbmDigiVector< Digi >::HasMatches ( ) const

inlinevirtual

Presence of match objects.

Returns: True if matches are present; else false.

Implements CbmDigiContainer.

Definition at line 121 of file CbmDigiVector.h.

References CbmDigiVector< Digi >::fHasMatches.

Referenced by CbmDigiVector< Digi >::ToString().

◆ ToString()

template<class Digi >

virtual std::string CbmDigiVector< Digi >::ToString ( ) const

inlinevirtual

String output.

Info to string

Reimplemented from CbmDigiContainer.

Definition at line 137 of file CbmDigiVector.h.

References CbmDigiVector< Digi >::fDigis, CbmDigiContainer::GetName(), and CbmDigiVector< Digi >::HasMatches().

Member Data Documentation

◆ fDigis

template<class Digi >

std::vector<Digi> CbmDigiVector< Digi >::fDigis {}

private

Definition at line 147 of file CbmDigiVector.h.

Referenced by CbmDigiVector< Digi >::AddDigi(), CbmDigiVector< Digi >::GetDigi(), CbmDigiVector< Digi >::GetNofDigis(), and CbmDigiVector< Digi >::ToString().

◆ fHasMatches

template<class Digi >

bool CbmDigiVector< Digi >::fHasMatches = false

private

Definition at line 149 of file CbmDigiVector.h.

Referenced by CbmDigiVector< Digi >::AddDigi(), CbmDigiVector< Digi >::GetDigiMatch(), CbmDigiVector< Digi >::GetNofDigis(), and CbmDigiVector< Digi >::HasMatches().

◆ fIsLocked

template<class Digi >

bool CbmDigiVector< Digi >::fIsLocked = false

private

Definition at line 150 of file CbmDigiVector.h.

Referenced by CbmDigiVector< Digi >::AddDigi(), CbmDigiVector< Digi >::GetDigi(), and CbmDigiVector< Digi >::GetDigiMatch().

◆ fMatches

template<class Digi >

std::vector<CbmMatch> CbmDigiVector< Digi >::fMatches {}

private

Definition at line 148 of file CbmDigiVector.h.

Referenced by CbmDigiVector< Digi >::AddDigi(), CbmDigiVector< Digi >::GetDigiMatch(), and CbmDigiVector< Digi >::GetNofDigis().

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

CbmDigiVector.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbmDigiVector()

◆ ~CbmDigiVector()

Member Function Documentation

◆ AddDigi()

◆ ClassDef() [1/2]

◆ ClassDef() [2/2]

◆ ConnectToTree()

◆ GetDigi()

◆ GetDigiMatch()

◆ GetName()

◆ GetNofDigis()

◆ HasMatches()

◆ ToString()

Member Data Documentation

◆ fDigis

◆ fHasMatches

◆ fIsLocked

◆ fMatches