GSI Object Oriented Online Offline (Go4)  GO4-6.3.0
Public Member Functions | Protected Attributes | Private Attributes | List of all members
TGo4EventElement Class Reference

#include <TGo4EventElement.h>

+ Inheritance diagram for TGo4EventElement:

Public Member Functions

 TGo4EventElement ()
 
 TGo4EventElement (const char *name)
 
 TGo4EventElement (const char *aName, const char *aTitle, Short_t aBaseCat=0)
 
virtual ~TGo4EventElement ()
 
void SetValid (Bool_t on)
 
Bool_t IsValid () const
 
void SetEventSource (TGo4EventSource *src)
 
void SetParent (TGo4EventElement *par)
 
void SetKeepContents (Bool_t on=kTRUE)
 
TGo4EventElementGetParent () const
 
virtual TGo4EventElementGetChild (const char *name)
 
TGo4EventSourceGetEventSource () const
 
Bool_t CheckEventSource (const char *classname)
 
virtual Int_t Fill ()
 
virtual Int_t Init ()
 
virtual void PrintEvent ()
 
virtual void makeBranch (TBranch *parent)
 
virtual void deactivate ()
 
virtual void activate ()
 
void Clear (Option_t *opt="") override
 
virtual void clearAll (Int_t)
 
virtual Bool_t isComposed ()
 
virtual Short_t getId ()
 
virtual void setDebug (Bool_t debug)
 
virtual TGo4EventElementoperator[] (Int_t)
 
void Print (Option_t *option="") const override
 
virtual void synchronizeWithTree (TTree *tree, TGo4EventElement **var_ptr=nullptr)
 
virtual Int_t activateBranch (TBranch *branch, Int_t index=0, TGo4EventElement **var_ptr=nullptr)
 
virtual TTree * CreateSampleTree (TGo4EventElement **sample=nullptr)
 
void ShowSampleTree ()
 

Protected Attributes

Short_t fIdentifier {-1}
 
Bool_t fDebug {kFALSE}
 
Bool_t fbKeepContents {kFALSE}
 Debug level. More...
 

Private Attributes

Bool_t fbIsValid {kTRUE}
 
TGo4EventElementfxParent {nullptr}
 
TGo4EventSourcefxEventSource {nullptr}
 

Detailed Description

Definition at line 36 of file TGo4EventElement.h.

Constructor & Destructor Documentation

◆ TGo4EventElement() [1/3]

TGo4EventElement::TGo4EventElement ( )

Definition at line 26 of file TGo4EventElement.cxx.

References GO4TRACE.

◆ TGo4EventElement() [2/3]

TGo4EventElement::TGo4EventElement ( const char *  name)

Definition at line 32 of file TGo4EventElement.cxx.

References GO4TRACE.

◆ TGo4EventElement() [3/3]

TGo4EventElement::TGo4EventElement ( const char *  aName,
const char *  aTitle,
Short_t  aBaseCat = 0 
)

Definition at line 38 of file TGo4EventElement.cxx.

◆ ~TGo4EventElement()

TGo4EventElement::~TGo4EventElement ( )
virtual

Definition at line 44 of file TGo4EventElement.cxx.

References GO4TRACE.

Member Function Documentation

◆ activate()

void TGo4EventElement::activate ( )
virtual

Reimplemented in TGo4CompositeEvent.

Definition at line 140 of file TGo4EventElement.cxx.

References TGo4Log::Warn().

Referenced by TGo4CompositeEvent::activate(), and makeBranch().

◆ activateBranch()

Int_t TGo4EventElement::activateBranch ( TBranch *  branch,
Int_t  index = 0,
TGo4EventElement **  var_ptr = nullptr 
)
virtual

Reimplemented in TGo4CompositeEvent.

Definition at line 107 of file TGo4EventElement.cxx.

Referenced by TGo4CompositeEvent::activateBranch(), operator[](), and synchronizeWithTree().

◆ CheckEventSource()

Bool_t TGo4EventElement::CheckEventSource ( const char *  classname)

Check if event source is valid. Tests the pointer for zero, and if not zero, compares classname of the event source with given string. To be used from the Fill method and from the analysis method init event classes.

Definition at line 49 of file TGo4EventElement.cxx.

References fxEventSource, and GO4TRACE.

Referenced by TGo4SimpleEvent::Fill(), GetEventSource(), TMeshB3OutputEvent::Init(), TMeshB1OutputEvent::Init(), TMeshB12OutputEvent::Init(), TMeshB2OutputEvent::Init(), TMeshB3InputEvent::Init(), TMeshB2InputEvent::Init(), TMeshFinalEvent::Init(), TMeshDummyEvent::Init(), TMeshB1InputEvent::Init(), TMeshRawEvent::Init(), and TMeshProviderProc::SetRealInput().

◆ Clear()

void TGo4EventElement::Clear ( Option_t *  opt = "")
override

◆ clearAll()

virtual void TGo4EventElement::clearAll ( Int_t  )
inlinevirtual

Definition at line 95 of file TGo4EventElement.h.

◆ CreateSampleTree()

TTree * TGo4EventElement::CreateSampleTree ( TGo4EventElement **  sample = nullptr)
virtual

Reimplemented in TGo4CompositeEvent.

Definition at line 186 of file TGo4EventElement.cxx.

References Fill().

Referenced by operator[](), and ShowSampleTree().

◆ deactivate()

void TGo4EventElement::deactivate ( )
virtual

Reimplemented in TGo4CompositeEvent.

Definition at line 135 of file TGo4EventElement.cxx.

References TGo4Log::Warn().

Referenced by TGo4CompositeEvent::deactivate(), and makeBranch().

◆ Fill()

Int_t TGo4EventElement::Fill ( )
virtual

Method called by the event owner (analysis step) to fill the event element from the set event source. Event source can be the source of the analysis step (if this is a raw event) or the event processor (if this is a reduced event). Fill method has to specify how the event source writes to the members of this event structure. Either by calling methods of the source (like myevent.a=fxEventSource->GetA(); etc ), or by direct copy to the member (like fxEventSource->FillMemoryAt(&myevent.a);)

Reimplemented in TGo4SimpleSubEvent, TGo4SimpleEvent, TGo4MbsSubEvent, TMeshRawEvent, TMeshB1InputEvent, TMeshFinalEvent, TMeshDummyEvent, TMeshB12OutputEvent, TMeshB1OutputEvent, TMeshB2InputEvent, TMeshB2OutputEvent, TMeshB3OutputEvent, and TMeshB3InputEvent.

Definition at line 167 of file TGo4EventElement.cxx.

References TGo4EventSource::BuildEvent(), Clear(), fbKeepContents, fxEventSource, TGo4EventSource::GetEventStatus(), and SetValid().

Referenced by CreateSampleTree(), GetEventSource(), and TGo4AnalysisStep::Process().

◆ GetChild()

TGo4EventElement * TGo4EventElement::GetChild ( const char *  name)
virtual

◆ GetEventSource()

TGo4EventSource* TGo4EventElement::GetEventSource ( ) const
inline

◆ getId()

virtual Short_t TGo4EventElement::getId ( )
inlinevirtual

◆ GetParent()

TGo4EventElement* TGo4EventElement::GetParent ( ) const
inline

Definition at line 60 of file TGo4EventElement.h.

References fxParent, and GetChild().

Referenced by GetChild().

◆ Init()

Int_t TGo4EventElement::Init ( )
virtual

◆ isComposed()

virtual Bool_t TGo4EventElement::isComposed ( )
inlinevirtual

Reimplemented in TGo4CompositeEvent.

Definition at line 96 of file TGo4EventElement.h.

Referenced by TGo4CompositeEvent::activateBranch().

◆ IsValid()

Bool_t TGo4EventElement::IsValid ( ) const
inline

Returns the valid state of this event.

Definition at line 50 of file TGo4EventElement.h.

References fbIsValid.

Referenced by TXXXAnlProc::BuildEvent(), and TGo4AnalysisStep::Process().

◆ makeBranch()

virtual void TGo4EventElement::makeBranch ( TBranch *  parent)
inlinevirtual

◆ operator[]()

virtual TGo4EventElement& TGo4EventElement::operator[] ( Int_t  )
inlinevirtual

◆ Print()

void TGo4EventElement::Print ( Option_t *  option = "") const
override

Definition at line 66 of file TGo4EventElement.cxx.

References PrintEvent().

Referenced by operator[]().

◆ PrintEvent()

void TGo4EventElement::PrintEvent ( )
virtual

◆ setDebug()

virtual void TGo4EventElement::setDebug ( Bool_t  debug)
inlinevirtual

Definition at line 98 of file TGo4EventElement.h.

References fDebug.

◆ SetEventSource()

void TGo4EventElement::SetEventSource ( TGo4EventSource src)
inline

Setter for the event source that is currently used by the Fill method.

Definition at line 53 of file TGo4EventElement.h.

References fxEventSource.

Referenced by main(), TGo4AnalysisStep::NewEventProcessor(), TGo4AnalysisStep::NewEventSource(), TGo4AnalysisStep::NewInputEvent(), TGo4AnalysisStep::NewOutputEvent(), and TGo4AnalysisStep::Process().

◆ SetKeepContents()

void TGo4EventElement::SetKeepContents ( Bool_t  on = kTRUE)
inline

Definition at line 58 of file TGo4EventElement.h.

References fbKeepContents.

Referenced by TGo4AnalysisStep::Process().

◆ SetParent()

void TGo4EventElement::SetParent ( TGo4EventElement par)
inline

Setter for the parent event structure reference.

Definition at line 56 of file TGo4EventElement.h.

References fxParent.

◆ SetValid()

void TGo4EventElement::SetValid ( Bool_t  on)
inline

◆ ShowSampleTree()

void TGo4EventElement::ShowSampleTree ( )

Definition at line 209 of file TGo4EventElement.cxx.

References CreateSampleTree().

Referenced by operator[]().

◆ synchronizeWithTree()

void TGo4EventElement::synchronizeWithTree ( TTree *  tree,
TGo4EventElement **  var_ptr = nullptr 
)
virtual

Use this method to map event structure with the Tree branch(es)

Definition at line 83 of file TGo4EventElement.cxx.

References activateBranch().

Referenced by TGo4FileSource::BuildEvent(), and operator[]().

Member Data Documentation

◆ fbIsValid

Bool_t TGo4EventElement::fbIsValid {kTRUE}
private

Indicates if this event is valid or not. If false, the event store will not write the event. We still stream this, since it may be used to flag validity of composite sub events

Definition at line 117 of file TGo4EventElement.h.

Referenced by IsValid(), PrintEvent(), and SetValid().

◆ fbKeepContents

Bool_t TGo4EventElement::fbKeepContents {kFALSE}
protected

Debug level.

helper flag to suppress Clear if event shall be kept

Definition at line 136 of file TGo4EventElement.h.

Referenced by Fill(), and SetKeepContents().

◆ fDebug

Bool_t TGo4EventElement::fDebug {kFALSE}
protected

◆ fIdentifier

Short_t TGo4EventElement::fIdentifier {-1}
protected

Definition at line 132 of file TGo4EventElement.h.

Referenced by getId().

◆ fxEventSource

TGo4EventSource* TGo4EventElement::fxEventSource {nullptr}
private

The external event source instance which is used to fill this event structure from the raw event. Lazy initialization as zero; the pointer is set by analysis only for top level Event Elements with subevents. Might be exchanged on the fly to switch the unpack of different subevents into the same event structure. 0..1

Definition at line 129 of file TGo4EventElement.h.

Referenced by CheckEventSource(), Fill(), GetEventSource(), Init(), PrintEvent(), and SetEventSource().

◆ fxParent

TGo4EventElement* TGo4EventElement::fxParent {nullptr}
private

The higher level event element that owns this instance 1

Definition at line 121 of file TGo4EventElement.h.

Referenced by GetParent(), and SetParent().


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