ATTPCROOT  0.3.0-alpha
A ROOT-based framework for analyzing data from active target detectors
Public Member Functions | Friends | List of all members
AtRawEvent Class Reference

#include <AtRawEvent.h>

Inheritance diagram for AtRawEvent:
Inheritance graph
[legend]
Collaboration diagram for AtRawEvent:
Collaboration graph
[legend]

Public Member Functions

 AtRawEvent ()
 
 AtRawEvent (AtRawEvent &&obj)=default
 
 AtRawEvent (const AtRawEvent &object)
 
 AtRawEvent (const AtBaseEvent &object)
 
AtRawEvent & operator= (AtRawEvent object)
 
virtual ~AtRawEvent ()=default
 
void Clear (Option_t *opt=nullptr) override
 Copy everything but the data (pads, aux pads, and MCPointMap) to this event. More...
 
template<typename... Ts>
AtPad * AddPad (Ts &&...params)
 Create a new pad in this event. More...
 
template<typename T , typename = std::enable_if_t<std::is_base_of<AtPad, std::decay_t<T>>::value>>
AtPad * AddPad (std::unique_ptr< T > ptr)
 Move a pad into the event. More...
 
AtPad * AddFPN (const AtPadReference &ref)
 Create a new FPN channel. More...
 
void RemovePad (Int_t padNum)
 
void SetSimMCPointMap (std::multimap< Int_t, std::size_t > map)
 
template<typename... Ts>
AtGenericTrace * AddGenericTrace (Ts &&...params)
 
AtGenericTrace * AddGenericTrace (std::unique_ptr< AtGenericTrace > ptr)
 
Int_t GetNumPads () const
 
Int_t GetNumAuxPads () const
 
AtPad * GetPad (Int_t padNum)
 
const AtPad * GetPad (Int_t padNum) const
 
AtPad * GetFpn (const AtPadReference &ref)
 
const AtPad * GetFpn (const AtPadReference &ref) const
 
const PadVector & GetPads () const
 
PadVector & GetPads ()
 
const GenTraceVector & GetGenTraces () const
 
const FpnMap & GetFpnPads () const
 
std::multimap< Int_t, std::size_t > & GetSimMCPointMap ()
 
 ClassDefOverride (AtRawEvent, 7)
 
- Public Member Functions inherited from AtBaseEvent
 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
 

Friends

class AtFilterTask
 
class AtFilterFFT
 
void swap (AtRawEvent &first, AtRawEvent &second)
 

Additional Inherited Members

- Protected Types inherited from AtBaseEvent
using AuxPadMap = std::map< std::string, AtAuxPad >
 
- Protected Attributes inherited from AtBaseEvent
ULong_t fEventID = -1
 
Bool_t fIsGood = true
 
Bool_t fIsInGate = false
 
std::vector< ULong64_t > fTimestamp {1}
 
AuxPadMap fAuxPadMap
 
std::string fEventName
 

Detailed Description

Definition at line 34 of file AtRawEvent.h.

Constructor & Destructor Documentation

◆ AtRawEvent() [1/4]

AtRawEvent::AtRawEvent ( )
inline

Definition at line 52 of file AtRawEvent.h.

◆ AtRawEvent() [2/4]

AtRawEvent::AtRawEvent ( AtRawEvent &&  obj)
default

◆ AtRawEvent() [3/4]

AtRawEvent::AtRawEvent ( const AtRawEvent &  object)

Definition at line 16 of file AtRawEvent.cxx.

◆ AtRawEvent() [4/4]

AtRawEvent::AtRawEvent ( const AtBaseEvent &  object)
inline

Definition at line 55 of file AtRawEvent.h.

◆ ~AtRawEvent()

virtual AtRawEvent::~AtRawEvent ( )
virtualdefault

Member Function Documentation

◆ AddFPN()

AtPad * AtRawEvent::AddFPN ( const AtPadReference &  ref)

Create a new FPN channel.

Returns
Pointer to newly created pad

Definition at line 77 of file AtRawEvent.cxx.

◆ AddGenericTrace() [1/2]

AtGenericTrace* AtRawEvent::AddGenericTrace ( std::unique_ptr< AtGenericTrace >  ptr)
inline

Definition at line 115 of file AtRawEvent.h.

◆ AddGenericTrace() [2/2]

template<typename... Ts>
AtGenericTrace* AtRawEvent::AddGenericTrace ( Ts &&...  params)
inline

Definition at line 109 of file AtRawEvent.h.

◆ AddPad() [1/2]

template<typename T , typename = std::enable_if_t<std::is_base_of<AtPad, std::decay_t<T>>::value>>
AtPad* AtRawEvent::AddPad ( std::unique_ptr< T >  ptr)
inline

Move a pad into the event.

Moves a std::unique_ptr of AtPad, or any type derived from AtPad, into the event.

Parameters
paramsstd::unique_ptr of pad to move into the event
Returns
Pointer to moved pad

Definition at line 97 of file AtRawEvent.h.

◆ AddPad() [2/2]

template<typename... Ts>
AtPad* AtRawEvent::AddPad ( Ts &&...  params)
inline

Create a new pad in this event.

Adds a new pad, calling a constructor of AtPad using the passed parameters.

Parameters
paramsParameters to perfect-forward to the constructor of AtPad
Returns
Pointer to newly created pad

Definition at line 82 of file AtRawEvent.h.

◆ ClassDefOverride()

AtRawEvent::ClassDefOverride ( AtRawEvent  ,
7   
)

◆ Clear()

void AtRawEvent::Clear ( Option_t *  opt = nullptr)
override

Copy everything but the data (pads, aux pads, and MCPointMap) to this event.

Definition at line 39 of file AtRawEvent.cxx.

◆ GetFpn() [1/2]

AtPad* AtRawEvent::GetFpn ( const AtPadReference &  ref)
inline

Definition at line 126 of file AtRawEvent.h.

◆ GetFpn() [2/2]

const AtPad * AtRawEvent::GetFpn ( const AtPadReference &  ref) const

Definition at line 64 of file AtRawEvent.cxx.

◆ GetFpnPads()

const FpnMap& AtRawEvent::GetFpnPads ( ) const
inline

Definition at line 136 of file AtRawEvent.h.

◆ GetGenTraces()

const GenTraceVector& AtRawEvent::GetGenTraces ( ) const
inline

Definition at line 134 of file AtRawEvent.h.

◆ GetNumAuxPads()

Int_t AtRawEvent::GetNumAuxPads ( ) const
inline

Definition at line 123 of file AtRawEvent.h.

◆ GetNumPads()

Int_t AtRawEvent::GetNumPads ( ) const
inline

Definition at line 122 of file AtRawEvent.h.

◆ GetPad() [1/2]

AtPad* AtRawEvent::GetPad ( Int_t  padNum)
inline

Definition at line 124 of file AtRawEvent.h.

◆ GetPad() [2/2]

const AtPad * AtRawEvent::GetPad ( Int_t  padNum) const

Definition at line 56 of file AtRawEvent.cxx.

◆ GetPads() [1/2]

PadVector& AtRawEvent::GetPads ( )
inline

Definition at line 132 of file AtRawEvent.h.

◆ GetPads() [2/2]

const PadVector& AtRawEvent::GetPads ( ) const
inline

Definition at line 131 of file AtRawEvent.h.

◆ GetSimMCPointMap()

std::multimap<Int_t, std::size_t>& AtRawEvent::GetSimMCPointMap ( )
inline

Definition at line 137 of file AtRawEvent.h.

◆ operator=()

AtRawEvent & AtRawEvent::operator= ( AtRawEvent  object)

Definition at line 23 of file AtRawEvent.cxx.

◆ RemovePad()

void AtRawEvent::RemovePad ( Int_t  padNum)

Definition at line 49 of file AtRawEvent.cxx.

◆ SetSimMCPointMap()

void AtRawEvent::SetSimMCPointMap ( std::multimap< Int_t, std::size_t >  map)
inline

Definition at line 106 of file AtRawEvent.h.

Friends And Related Function Documentation

◆ AtFilterFFT

friend class AtFilterFFT
friend

Definition at line 49 of file AtRawEvent.h.

◆ AtFilterTask

friend class AtFilterTask
friend

Definition at line 48 of file AtRawEvent.h.

◆ swap

void swap ( AtRawEvent &  first,
AtRawEvent &  second 
)
friend

Definition at line 59 of file AtRawEvent.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 11 2023 15:30:40 for ATTPCROOT by   doxygen 1.8.18