BmnDigitize Class Reference

Abstract base class for BMN digitisation tasks. More...

#include <BmnDigitize.h>

Inheritance diagram for BmnDigitize:

Collaboration diagram for BmnDigitize:

Public Member Functions
	BmnDigitize ()
	Constructor.
	BmnDigitize (const char *name)
	Constructor with name.
virtual	~BmnDigitize ()
	Destructor.
virtual void	FillCustomData (Double_t, Bool_t=kTRUE)
	Fill custom data into time slice.
void	GetEventInfo ()
	Get event information.
Double_t	GetEventTime () const
	Current event time @value Start time of current event [ns].
void	SendDigi (BmnDigi *digi)
	Send a digi object to the DAQ.
void	SetDaqBuffer (BmnDaqBuffer *buffer)
	Set the DAQ buffer instance.
void	SetEventMode (Bool_t choice=kTRUE)
	Set event-by-event mode.
virtual void	ResetArrays ()=0
	Reset the output arrays.
virtual void	WriteDigi (BmnDigi *digi)=0
	Write a digi object to the output array.

Protected Attributes
Bool_t	fEventMode
Int_t	fCurrentInput
Int_t	fCurrentEvent
Double_t	fCurrentEventTime
BmnDaqBuffer *	fDaqBuffer

Detailed Description

Abstract base class for BMN digitisation tasks.

Date

18.12.2018

Derived classes have to implement the abstract method WriteDigi.

Definition at line 22 of file BmnDigitize.h.

Constructor & Destructor Documentation

BmnDigitize() [1/2]

BmnDigitize::BmnDigitize

(

)

Constructor.

Definition at line 17 of file BmnDigitize.cxx.

BmnDigitize() [2/2]

BmnDigitize::BmnDigitize

(

const char *

name

)

Constructor with name.

Parameters

name

Task name

Definition at line 30 of file BmnDigitize.cxx.

~BmnDigitize()

BmnDigitize::~BmnDigitize ( )

virtual

Destructor.

Definition at line 74 of file BmnDigitize.cxx.

Member Function Documentation

FillCustomData()

virtual void BmnDigitize::FillCustomData ( Double_t  , Bool_t  = kTRUE  )

inlinevirtual

Fill custom data into time slice.

Parameters

fillTime	Time until data can be filled
limit	If kTRUE, only data up to fillTime will be treated; otherwise, all.

This method allows the digitizer to implement additional functionality than writing digis and match objects. It will be called from BmnDaq.

Definition at line 48 of file BmnDigitize.h.

GetEventInfo()

void BmnDigitize::GetEventInfo

(

)

Get event information.

Definition at line 43 of file BmnDigitize.cxx.

References fCurrentEvent, fCurrentEventTime, and fCurrentInput.

Referenced by BmnSsdDigitize::Exec().

GetEventTime()

Double_t BmnDigitize::GetEventTime ( ) const

inline

Current event time @value Start time of current event [ns].

Definition at line 59 of file BmnDigitize.h.

References fCurrentEventTime.

ResetArrays()

virtual void BmnDigitize::ResetArrays ( )

pure virtual

Reset the output arrays.

This method is called from BmnDaq after a tree->Fill is triggered. To be implemented by the derived class.

Implemented in BmnSsdDigitize.

SendDigi()

void BmnDigitize::SendDigi

(

BmnDigi *

digi

)

Send a digi object to the DAQ.

Parameters

digi	Pointer to digi object

Definition at line 65 of file BmnDigitize.cxx.

References fDaqBuffer, and BmnDaqBuffer::InsertData().

Referenced by BmnSsdDigitize::CreateDigi().

SetDaqBuffer()

void BmnDigitize::SetDaqBuffer ( BmnDaqBuffer *  buffer )

inline

Set the DAQ buffer instance.

Definition at line 71 of file BmnDigitize.h.

References fDaqBuffer.

SetEventMode()

void BmnDigitize::SetEventMode ( Bool_t  choice = kTRUE )

inline

Set event-by-event mode.

Parameters

Choice

If kTRUE, the digitizer will run in event-by-event mode

Definition at line 79 of file BmnDigitize.h.

References fEventMode.

WriteDigi()

virtual void BmnDigitize::WriteDigi ( BmnDigi *  digi )

pure virtual

Write a digi object to the output array.

Parameters

digi	Pointer to digi object

A copy of the digi object has to be created and inserted into the output array registered to the FairRootManager in the Init method. The corresponding match object has to be treated accordingly. This method will be called from BmnDaq.

Implemented in BmnSsdDigitize.

Member Data Documentation

fCurrentEvent

Int_t BmnDigitize::fCurrentEvent

protected

Definition at line 105 of file BmnDigitize.h.

Referenced by BmnSsdDigitize::Exec(), and GetEventInfo().

fCurrentEventTime

Double_t BmnDigitize::fCurrentEventTime

protected

Definition at line 106 of file BmnDigitize.h.

Referenced by BmnSsdDigitize::Exec(), GetEventInfo(), and GetEventTime().

fCurrentInput

Int_t BmnDigitize::fCurrentInput

protected

Definition at line 104 of file BmnDigitize.h.

Referenced by GetEventInfo().

fDaqBuffer

BmnDaqBuffer* BmnDigitize::fDaqBuffer

protected

Definition at line 107 of file BmnDigitize.h.

Referenced by SendDigi(), and SetDaqBuffer().

fEventMode

Bool_t BmnDigitize::fEventMode

protected

Definition at line 103 of file BmnDigitize.h.

Referenced by BmnSsdDigitize::Exec(), and SetEventMode().

---

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

• detectors/ssd/auxx/data/BmnDigitize.h
• detectors/ssd/auxx/data/BmnDigitize.cxx