BmnRoot
Loading...
Searching...
No Matches
BmnFileSource Class Reference

#include <BmnFileSource.h>

Inheritance diagram for BmnFileSource:
[legend]
Collaboration diagram for BmnFileSource:
[legend]

Public Member Functions

 BmnFileSource (TFile *f, const char *Title="InputRootFile", UInt_t identifier=0)
 
 BmnFileSource (const TString *RootFileName, const char *Title="InputRootFile", UInt_t identifier=0)
 
 BmnFileSource (const TString RootFileName, const char *Title="InputRootFile", UInt_t identifier=0)
 
 BmnFileSource (const TString RootFileName, int &period_number, int &run_number)
 
 ~BmnFileSource () override
 
Bool_t Init () override
 
Int_t ReadEvent (UInt_t i=0) override
 
void Close () override
 
Int_t CheckMaxEventNo (Int_t EvtEnd=0) override
 
void ReadBranchEvent (const char *BrName) override
 
void ReadBranchEvent (const char *BrName, Int_t Entry) override
 
void FillEventHeader (FairEventHeader *feh) override
 
const TFile * GetRootFile ()
 
void AddFriend (TString FileName)
 
void AddFile (TString FileName)
 
void AddFriendsToChain ()
 
void PrintFriendList ()
 
void CheckFriendChains ()
 
void CreateNewFriendChain (TString inputFile, TString inputLevel)
 
TTree * GetInTree ()
 
TChain * GetInChain ()
 
TFile * GetInFile ()
 
void CloseInFile ()
 
void SetInTree (TTree *tempTree)
 
TObjArray * GetListOfFoldersBmn ()
 
TFolder * GetBranchDescriptionFolder ()
 
UInt_t GetEntries ()
 
void SetInputFile (TString name)
 
void SetBeamTime (Double_t beamTime, Double_t gapTime)
 
void SetEventTimeInterval (Double_t min, Double_t max)
 
void SetEventMeanTime (Double_t mean)
 
void SetEventTime ()
 
Double_t GetDeltaEventTime ()
 
void SetFileHeader (FairFileHeader *f)
 
Double_t GetEventTime ()
 
Bool_t ActivateObject (TObject **obj, const char *BrName) override
 
Bool_t ActivateObjectAny (void **, const std::type_info &, const char *) override
 
void SetEvtHeaderNew (Bool_t Status)
 
Bool_t IsEvtHeaderNew ()
 
void SetCheckFileLayout (Bool_t enable)
 
Bool_t SpecifyRunId () override
 
void GetRunNumber (int &period_number, int &run_number)
 
Int_t GetFileType ()
 
 BmnFileSource (TFile *f, const char *Title="InputRootFile", UInt_t identifier=0)
 
 BmnFileSource (const TString *RootFileName, const char *Title="InputRootFile", UInt_t identifier=0)
 
 BmnFileSource (const TString RootFileName, const char *Title="InputRootFile", UInt_t identifier=0)
 
 BmnFileSource (const TString RootFileName, int &period_number, int &run_number)
 
 ~BmnFileSource () override
 
Bool_t Init () override
 
Int_t ReadEvent (UInt_t i=0) override
 
void Close () override
 
Int_t CheckMaxEventNo (Int_t EvtEnd=0) override
 
void ReadBranchEvent (const char *BrName) override
 
void ReadBranchEvent (const char *BrName, Int_t Entry) override
 
void FillEventHeader (FairEventHeader *feh) override
 
const TFile * GetRootFile ()
 
void AddFriend (TString FileName)
 
void AddFile (TString FileName)
 
void AddFriendsToChain ()
 
void PrintFriendList ()
 
void CheckFriendChains ()
 
void CreateNewFriendChain (TString inputFile, TString inputLevel)
 
TTree * GetInTree ()
 
TChain * GetInChain ()
 
TFile * GetInFile ()
 
void CloseInFile ()
 
void SetInTree (TTree *tempTree)
 
TObjArray * GetListOfFoldersBmn ()
 
TFolder * GetBranchDescriptionFolder ()
 
UInt_t GetEntries ()
 
void SetInputFile (TString name)
 
void SetBeamTime (Double_t beamTime, Double_t gapTime)
 
void SetEventTimeInterval (Double_t min, Double_t max)
 
void SetEventMeanTime (Double_t mean)
 
void SetEventTime ()
 
Double_t GetDeltaEventTime ()
 
void SetFileHeader (FairFileHeader *f)
 
Double_t GetEventTime ()
 
Bool_t ActivateObject (TObject **obj, const char *BrName) override
 
Bool_t ActivateObjectAny (void **, const std::type_info &, const char *) override
 
void SetEvtHeaderNew (Bool_t Status)
 
Bool_t IsEvtHeaderNew ()
 
void SetCheckFileLayout (Bool_t enable)
 
Bool_t SpecifyRunId () override
 
void GetRunNumber (int &period_number, int &run_number)
 
Int_t GetFileType ()
 

Detailed Description

BmnFileSource.h

Author
Created by Mohammad Al-Turany. Modified by Konstantin Gertsenberger gerts.nosp@m.en@j.nosp@m.inr.r.nosp@m.u

Class presents a source inherited from FairFileSourceBase to work with BmnRoot data in ROOT files

Definition at line 29 of file BmnFileSource.h.

Constructor & Destructor Documentation

◆ BmnFileSource() [1/8]

BmnFileSource::BmnFileSource ( TFile *  f,
const char *  Title = "InputRootFile",
UInt_t  identifier = 0 
)

Definition at line 35 of file BmnFileSource.cxx.

◆ BmnFileSource() [2/8]

BmnFileSource::BmnFileSource ( const TString *  RootFileName,
const char *  Title = "InputRootFile",
UInt_t  identifier = 0 
)

Definition at line 74 of file BmnFileSource.cxx.

◆ BmnFileSource() [3/8]

BmnFileSource::BmnFileSource ( const TString  RootFileName,
const char *  Title = "InputRootFile",
UInt_t  identifier = 0 
)

Definition at line 114 of file BmnFileSource.cxx.

◆ BmnFileSource() [4/8]

BmnFileSource::BmnFileSource ( const TString  RootFileName,
int &  period_number,
int &  run_number 
)

Definition at line 155 of file BmnFileSource.cxx.

◆ ~BmnFileSource() [1/2]

BmnFileSource::~BmnFileSource ( )
overridedefault

◆ BmnFileSource() [5/8]

BmnFileSource::BmnFileSource ( TFile *  f,
const char *  Title = "InputRootFile",
UInt_t  identifier = 0 
)

◆ BmnFileSource() [6/8]

BmnFileSource::BmnFileSource ( const TString *  RootFileName,
const char *  Title = "InputRootFile",
UInt_t  identifier = 0 
)

◆ BmnFileSource() [7/8]

BmnFileSource::BmnFileSource ( const TString  RootFileName,
const char *  Title = "InputRootFile",
UInt_t  identifier = 0 
)

◆ BmnFileSource() [8/8]

BmnFileSource::BmnFileSource ( const TString  RootFileName,
int &  period_number,
int &  run_number 
)

◆ ~BmnFileSource() [2/2]

BmnFileSource::~BmnFileSource ( )
override

Member Function Documentation

◆ ActivateObject() [1/2]

Bool_t BmnFileSource::ActivateObject ( TObject **  obj,
const char *  BrName 
)
override

Definition at line 698 of file BmnFileSource.cxx.

Referenced by Init().

◆ ActivateObject() [2/2]

Bool_t BmnFileSource::ActivateObject ( TObject **  obj,
const char *  BrName 
)
override

◆ ActivateObjectAny() [1/2]

Bool_t BmnFileSource::ActivateObjectAny ( void **  ,
const std::type_info &  ,
const char *   
)
override

◆ ActivateObjectAny() [2/2]

Bool_t BmnFileSource::ActivateObjectAny ( void **  ,
const std::type_info &  ,
const char *   
)
override

◆ AddFile() [1/2]

void BmnFileSource::AddFile ( TString  FileName)

Add ROOT file to input, the file will be chained to already added files

Definition at line 462 of file BmnFileSource.cxx.

◆ AddFile() [2/2]

void BmnFileSource::AddFile ( TString  FileName)

Add ROOT file to input, the file will be chained to already added files

◆ AddFriend() [1/2]

void BmnFileSource::AddFriend ( TString  FileName)

Add a friend file (input) by name)

Definition at line 457 of file BmnFileSource.cxx.

◆ AddFriend() [2/2]

void BmnFileSource::AddFriend ( TString  FileName)

Add a friend file (input) by name)

◆ AddFriendsToChain() [1/2]

void BmnFileSource::AddFriendsToChain ( )

Definition at line 467 of file BmnFileSource.cxx.

References CreateNewFriendChain(), and PrintFriendList().

Referenced by Init().

◆ AddFriendsToChain() [2/2]

void BmnFileSource::AddFriendsToChain ( )

◆ CheckFriendChains() [1/2]

void BmnFileSource::CheckFriendChains ( )

Definition at line 575 of file BmnFileSource.cxx.

References i.

◆ CheckFriendChains() [2/2]

void BmnFileSource::CheckFriendChains ( )

◆ CheckMaxEventNo() [1/2]

Int_t BmnFileSource::CheckMaxEventNo ( Int_t  EvtEnd = 0)
override

Check the maximum event number we can run to

Definition at line 732 of file BmnFileSource.cxx.

◆ CheckMaxEventNo() [2/2]

Int_t BmnFileSource::CheckMaxEventNo ( Int_t  EvtEnd = 0)
override

Check the maximum event number we can run to

◆ Close() [1/2]

void BmnFileSource::Close ( )
override

Definition at line 452 of file BmnFileSource.cxx.

References CloseInFile().

◆ Close() [2/2]

void BmnFileSource::Close ( )
override

◆ CloseInFile() [1/2]

void BmnFileSource::CloseInFile ( )
inline

Definition at line 63 of file BmnFileSource.h.

Referenced by Close().

◆ CloseInFile() [2/2]

void BmnFileSource::CloseInFile ( )
inline

Definition at line 63 of file BmnFileSource.h.

◆ CreateNewFriendChain() [1/2]

void BmnFileSource::CreateNewFriendChain ( TString  inputFile,
TString  inputLevel 
)

Get The list of branches from the friend file and add it to the actual list

Definition at line 652 of file BmnFileSource.cxx.

References f, and i.

Referenced by AddFriendsToChain().

◆ CreateNewFriendChain() [2/2]

void BmnFileSource::CreateNewFriendChain ( TString  inputFile,
TString  inputLevel 
)

◆ FillEventHeader() [1/2]

void BmnFileSource::FillEventHeader ( FairEventHeader *  feh)
override

Definition at line 860 of file BmnFileSource.cxx.

References GetEventTime().

◆ FillEventHeader() [2/2]

void BmnFileSource::FillEventHeader ( FairEventHeader *  feh)
override

◆ GetBranchDescriptionFolder() [1/2]

TFolder * BmnFileSource::GetBranchDescriptionFolder ( )
inline

Definition at line 71 of file BmnFileSource.h.

◆ GetBranchDescriptionFolder() [2/2]

TFolder * BmnFileSource::GetBranchDescriptionFolder ( )
inline

Definition at line 71 of file BmnFileSource.h.

◆ GetDeltaEventTime() [1/2]

Double_t BmnFileSource::GetDeltaEventTime ( )

Definition at line 787 of file BmnFileSource.cxx.

Referenced by SetEventTime().

◆ GetDeltaEventTime() [2/2]

Double_t BmnFileSource::GetDeltaEventTime ( )

◆ GetEntries() [1/2]

UInt_t BmnFileSource::GetEntries ( )
inline

Definition at line 72 of file BmnFileSource.h.

◆ GetEntries() [2/2]

UInt_t BmnFileSource::GetEntries ( )
inline

Definition at line 72 of file BmnFileSource.h.

◆ GetEventTime() [1/2]

Double_t BmnFileSource::GetEventTime ( )

Definition at line 800 of file BmnFileSource.cxx.

References SetEventTime().

Referenced by FillEventHeader(), ReadBranchEvent(), ReadBranchEvent(), and ReadEvent().

◆ GetEventTime() [2/2]

Double_t BmnFileSource::GetEventTime ( )

◆ GetFileType() [1/2]

Int_t BmnFileSource::GetFileType ( )
inline

Get input file type (data level): 0 - EXP DIGI, 1 - EXP DST, 10 - SIM DIGI, 11 - SIM DST, <0 - errors

Definition at line 110 of file BmnFileSource.h.

◆ GetFileType() [2/2]

Int_t BmnFileSource::GetFileType ( )
inline

Get input file type (data level): 0 - EXP DIGI, 1 - EXP DST, 10 - SIM DIGI, 11 - SIM DST, <0 - errors

Definition at line 110 of file BmnFileSource.h.

◆ GetInChain() [1/2]

TChain * BmnFileSource::GetInChain ( )
inline

Definition at line 61 of file BmnFileSource.h.

◆ GetInChain() [2/2]

TChain * BmnFileSource::GetInChain ( )
inline

Definition at line 61 of file BmnFileSource.h.

◆ GetInFile() [1/2]

TFile * BmnFileSource::GetInFile ( )
inline

Definition at line 62 of file BmnFileSource.h.

◆ GetInFile() [2/2]

TFile * BmnFileSource::GetInFile ( )
inline

Definition at line 62 of file BmnFileSource.h.

◆ GetInTree() [1/2]

TTree * BmnFileSource::GetInTree ( )
inline

Definition at line 60 of file BmnFileSource.h.

◆ GetInTree() [2/2]

TTree * BmnFileSource::GetInTree ( )
inline

Definition at line 60 of file BmnFileSource.h.

◆ GetListOfFoldersBmn() [1/2]

TObjArray * BmnFileSource::GetListOfFoldersBmn ( )
inline

Definition at line 70 of file BmnFileSource.h.

◆ GetListOfFoldersBmn() [2/2]

TObjArray * BmnFileSource::GetListOfFoldersBmn ( )
inline

Definition at line 70 of file BmnFileSource.h.

◆ GetRootFile() [1/2]

const TFile * BmnFileSource::GetRootFile ( )
inline

Definition at line 51 of file BmnFileSource.h.

◆ GetRootFile() [2/2]

const TFile * BmnFileSource::GetRootFile ( )
inline

Definition at line 51 of file BmnFileSource.h.

◆ GetRunNumber() [1/2]

void BmnFileSource::GetRunNumber ( int &  period_number,
int &  run_number 
)

Get period and run numbers extracted while the class construction if exist

◆ GetRunNumber() [2/2]

void BmnFileSource::GetRunNumber ( int &  period_number,
int &  run_number 
)

Get period and run numbers extracted while the class construction if exist

◆ Init() [1/2]

Bool_t BmnFileSource::Init ( )
override

Definition at line 261 of file BmnFileSource.cxx.

References ActivateObject(), AddFriendsToChain(), and i.

Referenced by SetInTree().

◆ Init() [2/2]

Bool_t BmnFileSource::Init ( )
override

◆ IsEvtHeaderNew() [1/2]

Bool_t BmnFileSource::IsEvtHeaderNew ( )
inline

Definition at line 98 of file BmnFileSource.h.

◆ IsEvtHeaderNew() [2/2]

Bool_t BmnFileSource::IsEvtHeaderNew ( )
inline

Definition at line 98 of file BmnFileSource.h.

◆ PrintFriendList() [1/2]

void BmnFileSource::PrintFriendList ( )

Definition at line 548 of file BmnFileSource.cxx.

Referenced by AddFriendsToChain().

◆ PrintFriendList() [2/2]

void BmnFileSource::PrintFriendList ( )

◆ ReadBranchEvent() [1/4]

void BmnFileSource::ReadBranchEvent ( const char *  BrName)
override

Read the tree entry on one branch

fill the object with content if the other branches in this tree entry were already read

Definition at line 827 of file BmnFileSource.cxx.

References GetEventTime().

◆ ReadBranchEvent() [2/4]

void BmnFileSource::ReadBranchEvent ( const char *  BrName)
override

Read the tree entry on one branch

◆ ReadBranchEvent() [3/4]

void BmnFileSource::ReadBranchEvent ( const char *  BrName,
Int_t  Entry 
)
override

Read specific tree entry on one branch

Definition at line 845 of file BmnFileSource.cxx.

References GetEventTime().

◆ ReadBranchEvent() [4/4]

void BmnFileSource::ReadBranchEvent ( const char *  BrName,
Int_t  Entry 
)
override

Read specific tree entry on one branch

◆ ReadEvent() [1/2]

Int_t BmnFileSource::ReadEvent ( UInt_t  i = 0)
override

Definition at line 436 of file BmnFileSource.cxx.

References GetEventTime(), and i.

◆ ReadEvent() [2/2]

Int_t BmnFileSource::ReadEvent ( UInt_t  i = 0)
override

◆ SetBeamTime() [1/2]

void BmnFileSource::SetBeamTime ( Double_t  beamTime,
Double_t  gapTime 
)

Set the repetition time of the beam when it can interact (beamTime) and when no interaction happen (gapTime). The total repetition time is beamTime + gapTime

Definition at line 763 of file BmnFileSource.cxx.

◆ SetBeamTime() [2/2]

void BmnFileSource::SetBeamTime ( Double_t  beamTime,
Double_t  gapTime 
)

Set the repetition time of the beam when it can interact (beamTime) and when no interaction happen (gapTime). The total repetition time is beamTime + gapTime

◆ SetCheckFileLayout() [1/2]

void BmnFileSource::SetCheckFileLayout ( Bool_t  enable)
inline

Allow to disable the testing the file layout when adding files to a chain.

Definition at line 102 of file BmnFileSource.h.

◆ SetCheckFileLayout() [2/2]

void BmnFileSource::SetCheckFileLayout ( Bool_t  enable)
inline

Allow to disable the testing the file layout when adding files to a chain.

Definition at line 102 of file BmnFileSource.h.

◆ SetEventMeanTime() [1/2]

void BmnFileSource::SetEventMeanTime ( Double_t  mean)

Set the mean time for the event in ns

Definition at line 744 of file BmnFileSource.cxx.

◆ SetEventMeanTime() [2/2]

void BmnFileSource::SetEventMeanTime ( Double_t  mean)

Set the mean time for the event in ns

◆ SetEventTime() [1/2]

void BmnFileSource::SetEventTime ( )

Definition at line 769 of file BmnFileSource.cxx.

References GetDeltaEventTime().

Referenced by GetEventTime().

◆ SetEventTime() [2/2]

void BmnFileSource::SetEventTime ( )

◆ SetEventTimeInterval() [1/2]

void BmnFileSource::SetEventTimeInterval ( Double_t  min,
Double_t  max 
)

Set the min and max limit for event time in ns

Definition at line 753 of file BmnFileSource.cxx.

References max(), and min().

◆ SetEventTimeInterval() [2/2]

void BmnFileSource::SetEventTimeInterval ( Double_t  min,
Double_t  max 
)

Set the min and max limit for event time in ns

◆ SetEvtHeaderNew() [1/2]

void BmnFileSource::SetEvtHeaderNew ( Bool_t  Status)
inline

Set the status of the EvtHeader

Parameters
StatusTrue: The header was creatged in this session and has to be filled FALSE: We use an existing header from previous data level

Definition at line 97 of file BmnFileSource.h.

◆ SetEvtHeaderNew() [2/2]

void BmnFileSource::SetEvtHeaderNew ( Bool_t  Status)
inline

Set the status of the EvtHeader

Parameters
StatusTrue: The header was creatged in this session and has to be filled FALSE: We use an existing header from previous data level

Definition at line 97 of file BmnFileSource.h.

◆ SetFileHeader() [1/2]

void BmnFileSource::SetFileHeader ( FairFileHeader *  f)
inline

Definition at line 87 of file BmnFileSource.h.

References f.

◆ SetFileHeader() [2/2]

void BmnFileSource::SetFileHeader ( FairFileHeader *  f)
inline

Definition at line 87 of file BmnFileSource.h.

References f.

◆ SetInputFile() [1/2]

void BmnFileSource::SetInputFile ( TString  name)

Definition at line 723 of file BmnFileSource.cxx.

◆ SetInputFile() [2/2]

void BmnFileSource::SetInputFile ( TString  name)

◆ SetInTree() [1/2]

void BmnFileSource::SetInTree ( TTree *  tempTree)

Definition at line 426 of file BmnFileSource.cxx.

References Init().

◆ SetInTree() [2/2]

void BmnFileSource::SetInTree ( TTree *  tempTree)

◆ SpecifyRunId() [1/2]

Bool_t BmnFileSource::SpecifyRunId ( )
override

Read one event from source to find out which RunId to use

Read the first entry in Chain to fill the event header and get the RunID

Definition at line 446 of file BmnFileSource.cxx.

◆ SpecifyRunId() [2/2]

Bool_t BmnFileSource::SpecifyRunId ( )
override

Read one event from source to find out which RunId to use


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