CbmEventTriggers Class Reference

Class to store different triggers for a given event. More...

#include <CbmEventTriggers.h>

Public Types
enum class	ETrigger : uint32_t { Lambda = 0x00000001 , Ks = 0x00000002 }
	Defines a trigger bitmask. More...
using	Trigger_t = uint32_t

Public Member Functions
	CbmEventTriggers ()=default
	Default constructor.
	CbmEventTriggers (uint32_t bitmap)
	A constructor from integer.
	CbmEventTriggers (const CbmEventTriggers &)=default
	Copy constructor.
	CbmEventTriggers (CbmEventTriggers &&)=default
	Move constructor.
	~CbmEventTriggers ()=default
	Destructor.
CbmEventTriggers &	operator= (const CbmEventTriggers &)=default
	Copy assignment operator.
CbmEventTriggers &	operator= (CbmEventTriggers &&)=default
	Move assignment operator.
Trigger_t	GetBitmap () const
	Gets a bitmap.
void	Set (ETrigger key)
	Sets a trigger.
void	Reset (ETrigger key)
	Resets a trigger.
void	ResetAll ()
	Resets all the triggers.
bool	Test (ETrigger key) const
	Tests a particular single trigger.
bool	TestAll (Trigger_t bitmask) const
	Tests, if ALL the triggers in the bitmask are on.
bool	TestAny (Trigger_t bitmask) const
	Tests, if ANY of the triggers in the bitmask are on.
std::string	ToString () const
	String representation of the class content.

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int)
	ClassDefNV (CbmEventTriggers, 2)

Private Attributes
Trigger_t	fBitmap {0}
	bitmap storing the triggers according to ETrigger

Friends
class	boost::serialization::access

Detailed Description

Class to store different triggers for a given event.

Definition at line 23 of file CbmEventTriggers.h.

Member Typedef Documentation

Trigger_t

using CbmEventTriggers::Trigger_t = uint32_t

Definition at line 34 of file CbmEventTriggers.h.

Member Enumeration Documentation

ETrigger

enum class CbmEventTriggers::ETrigger : uint32_t

strong

Defines a trigger bitmask.

Enumerator
Lambda	Lambda-trigger.
Ks	Ks-trigger.

Definition at line 27 of file CbmEventTriggers.h.

Constructor & Destructor Documentation

CbmEventTriggers() [1/4]

CbmEventTriggers::CbmEventTriggers ( )

default

Default constructor.

CbmEventTriggers() [2/4]

CbmEventTriggers::CbmEventTriggers ( uint32_t bitmap )

inlineexplicit

A constructor from integer.

Parameters

bitmap

A bitmap of the triggers

Definition at line 41 of file CbmEventTriggers.h.

References fBitmap.

CbmEventTriggers() [3/4]

CbmEventTriggers::CbmEventTriggers ( const CbmEventTriggers & )

default

Copy constructor.

CbmEventTriggers() [4/4]

CbmEventTriggers::CbmEventTriggers ( CbmEventTriggers && )

default

Move constructor.

~CbmEventTriggers()

CbmEventTriggers::~CbmEventTriggers ( )

default

Destructor.

Member Function Documentation

ClassDefNV()

CbmEventTriggers::ClassDefNV ( CbmEventTriggers , 2  )

private

GetBitmap()

Trigger_t CbmEventTriggers::GetBitmap ( ) const

inline

Gets a bitmap.

Returns

bitmap (integer)

Definition at line 60 of file CbmEventTriggers.h.

References fBitmap.

operator=() [1/2]

CbmEventTriggers & CbmEventTriggers::operator= ( CbmEventTriggers && )

default

Move assignment operator.

operator=() [2/2]

CbmEventTriggers & CbmEventTriggers::operator= ( const CbmEventTriggers & )

default

Copy assignment operator.

Reset()

void CbmEventTriggers::Reset ( ETrigger key )

inline

Resets a trigger.

Parameters

key	Trigger key

Definition at line 68 of file CbmEventTriggers.h.

References fBitmap.

ResetAll()

void CbmEventTriggers::ResetAll ( )

inline

Resets all the triggers.

Definition at line 71 of file CbmEventTriggers.h.

References fBitmap.

Referenced by CbmDigiEvent::Clear().

serialize()

template<class Archive >

void CbmEventTriggers::serialize ( Archive & ar, const unsigned int  )

inlineprivate

Definition at line 93 of file CbmEventTriggers.h.

References fBitmap.

Set()

void CbmEventTriggers::Set ( ETrigger key )

inline

Sets a trigger.

Parameters

key	Trigger key

Definition at line 64 of file CbmEventTriggers.h.

References fBitmap.

Referenced by cbm::algo::kfp::V0Finder::Process().

Test()

bool CbmEventTriggers::Test ( ETrigger key ) const

inline

Tests a particular single trigger.

Parameters

key	Trigger key

Definition at line 75 of file CbmEventTriggers.h.

References fBitmap.

Referenced by cbm::algo::Reco::ReconstructEvent(), and ToString().

TestAll()

bool CbmEventTriggers::TestAll ( Trigger_t bitmask ) const

inline

Tests, if ALL the triggers in the bitmask are on.

Parameters

bitmask

Trigger bitmask

Definition at line 79 of file CbmEventTriggers.h.

References fBitmap.

TestAny()

bool CbmEventTriggers::TestAny ( Trigger_t bitmask ) const

inline

Tests, if ANY of the triggers in the bitmask are on.

Parameters

bitmask

Trigger bitmask

Definition at line 83 of file CbmEventTriggers.h.

References fBitmap.

ToString()

std::string CbmEventTriggers::ToString

(

)

const

String representation of the class content.

Definition at line 16 of file CbmEventTriggers.cxx.

References Ks, Lambda, and Test().

Friends And Related Symbol Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 91 of file CbmEventTriggers.h.

Member Data Documentation

fBitmap

Trigger_t CbmEventTriggers::fBitmap {0}

private

bitmap storing the triggers according to ETrigger

Definition at line 89 of file CbmEventTriggers.h.

Referenced by CbmEventTriggers(), GetBitmap(), Reset(), ResetAll(), serialize(), Set(), Test(), TestAll(), and TestAny().

---

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

• CbmEventTriggers.h
• CbmEventTriggers.cxx