AtBaseEvent Class Reference

Base class for all event types in ATTPCROOT. More...

#include <AtBaseEvent.h>

Inheritance diagram for AtBaseEvent:

Collaboration diagram for AtBaseEvent:

Public Member Functions
	AtBaseEvent (std::string name="AtBaseEvent")
virtual	~AtBaseEvent ()=default
	AtBaseEvent (AtBaseEvent &&)=default
	AtBaseEvent (const AtBaseEvent &)=default
AtBaseEvent &	operator= (AtBaseEvent object)
void	Clear (Option_t *opt) override
std::pair< AtAuxPad *, bool >	AddAuxPad (std::string auxName)
	Add new auxilary pad (AtAuxPad) to event. More...
void	SetEventID (ULong_t evtid)
void	SetIsGood (Bool_t value)
void	SetTimestamp (ULong64_t timestamp, int index=0)
void	SetNumberOfTimestamps (int numTS)
void	SetIsExtGate (Bool_t value)
void	SetEventName (std::string name)
ULong_t	GetEventID () const
ULong64_t	GetTimestamp (int index=0) const
const std::vector< ULong64_t > &	GetTimestamps () const
Bool_t	IsGood () const
Bool_t	GetIsExtGate () const
std::string	GetEventName () const
AtAuxPad *	GetAuxPad (std::string auxPad)
const AtAuxPad *	GetAuxPad (std::string auxPad) const
const AuxPadMap &	GetAuxPads () const

Protected Types
using	AuxPadMap = std::map< std::string, AtAuxPad >

Protected Attributes
ULong_t	fEventID = -1
Bool_t	fIsGood = true
Bool_t	fIsInGate = false
std::vector< ULong64_t >	fTimestamp {1}
AuxPadMap	fAuxPadMap
std::string	fEventName

Friends
void	swap (AtBaseEvent &first, AtBaseEvent &second)

Detailed Description

Base class for all event types in ATTPCROOT.

Definition at line 20 of file AtBaseEvent.h.

Member Typedef Documentation

AuxPadMap

using AtBaseEvent::AuxPadMap = std::map<std::string, AtAuxPad>

protected

Definition at line 23 of file AtBaseEvent.h.

Constructor & Destructor Documentation

AtBaseEvent() [1/3]

AtBaseEvent::AtBaseEvent

(

std::string

name = "AtBaseEvent"

)

Definition at line 5 of file AtBaseEvent.cxx.

~AtBaseEvent()

virtual AtBaseEvent::~AtBaseEvent ( )

virtualdefault

AtBaseEvent() [2/3]

AtBaseEvent::AtBaseEvent ( AtBaseEvent &&  )

default

AtBaseEvent() [3/3]

AtBaseEvent::AtBaseEvent ( const AtBaseEvent &  )

default

Member Function Documentation

AddAuxPad()

std::pair< AtAuxPad *, bool > AtBaseEvent::AddAuxPad

(

std::string

auxName

)

Add new auxilary pad (AtAuxPad) to event.

Parameters

Name	of new auxiliary pad

Returns

Returns a pointer to the newly added pad, or existing pad if auxName is already used, bool returned is true if insert occurred.

Definition at line 44 of file AtBaseEvent.cxx.

Clear()

void AtBaseEvent::Clear ( Option_t *  opt )

override

Definition at line 13 of file AtBaseEvent.cxx.

GetAuxPad() [1/2]

AtAuxPad* AtBaseEvent::GetAuxPad ( std::string  auxPad )

inline

Definition at line 74 of file AtBaseEvent.h.

GetAuxPad() [2/2]

const AtAuxPad * AtBaseEvent::GetAuxPad

(

std::string

auxPad

)

const

Definition at line 26 of file AtBaseEvent.cxx.

GetAuxPads()

const AuxPadMap& AtBaseEvent::GetAuxPads ( ) const

inline

Definition at line 79 of file AtBaseEvent.h.

GetEventID()

ULong_t AtBaseEvent::GetEventID ( ) const

inline

Definition at line 67 of file AtBaseEvent.h.

GetEventName()

std::string AtBaseEvent::GetEventName ( ) const

inline

Definition at line 72 of file AtBaseEvent.h.

GetIsExtGate()

Bool_t AtBaseEvent::GetIsExtGate ( ) const

inline

Definition at line 71 of file AtBaseEvent.h.

GetTimestamp()

ULong64_t AtBaseEvent::GetTimestamp ( int  index = 0 ) const

inline

Definition at line 68 of file AtBaseEvent.h.

GetTimestamps()

const std::vector<ULong64_t>& AtBaseEvent::GetTimestamps ( ) const

inline

Definition at line 69 of file AtBaseEvent.h.

IsGood()

Bool_t AtBaseEvent::IsGood ( ) const

inline

Definition at line 70 of file AtBaseEvent.h.

operator=()

AtBaseEvent & AtBaseEvent::operator=

(

AtBaseEvent

object

)

Definition at line 7 of file AtBaseEvent.cxx.

SetEventID()

void AtBaseEvent::SetEventID ( ULong_t  evtid )

inline

Definition at line 60 of file AtBaseEvent.h.

SetEventName()

void AtBaseEvent::SetEventName ( std::string  name )

inline

Definition at line 65 of file AtBaseEvent.h.

SetIsExtGate()

void AtBaseEvent::SetIsExtGate ( Bool_t  value )

inline

Definition at line 64 of file AtBaseEvent.h.

SetIsGood()

void AtBaseEvent::SetIsGood ( Bool_t  value )

inline

Definition at line 61 of file AtBaseEvent.h.

SetNumberOfTimestamps()

void AtBaseEvent::SetNumberOfTimestamps ( int  numTS )

inline

Definition at line 63 of file AtBaseEvent.h.

SetTimestamp()

void AtBaseEvent::SetTimestamp	(	ULong64_t	timestamp,
		int	index = 0
	)

Definition at line 35 of file AtBaseEvent.cxx.

Friends And Related Function Documentation

swap

void swap ( AtBaseEvent &  first, AtBaseEvent &  second  )

friend

Definition at line 39 of file AtBaseEvent.h.

Member Data Documentation

fAuxPadMap

AuxPadMap AtBaseEvent::fAuxPadMap

protected

Definition at line 29 of file AtBaseEvent.h.

fEventID

ULong_t AtBaseEvent::fEventID = -1

protected

Definition at line 24 of file AtBaseEvent.h.

fEventName

std::string AtBaseEvent::fEventName

protected

Definition at line 30 of file AtBaseEvent.h.

fIsGood

Bool_t AtBaseEvent::fIsGood = true

protected

Definition at line 25 of file AtBaseEvent.h.

fIsInGate

Bool_t AtBaseEvent::fIsInGate = false

protected

Definition at line 26 of file AtBaseEvent.h.

fTimestamp

std::vector<ULong64_t> AtBaseEvent::fTimestamp {1}

protected

Definition at line 28 of file AtBaseEvent.h.

---

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

• /github/workspace/AtData/AtBaseEvent.h
• /github/workspace/AtData/AtBaseEvent.cxx