core/include/SInputData.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
// $Id: SInputData.h 331 2012-11-20 17:12:44Z krasznaa $
/***************************************************************************
 * @Project: SFrame - ROOT-based analysis framework for ATLAS
 * @Package: Core
 *
 * @author Stefan Ask       <Stefan.Ask@cern.ch>           - Manchester
 * @author David Berge      <David.Berge@cern.ch>          - CERN
 * @author Johannes Haller  <Johannes.Haller@cern.ch>      - Hamburg
 * @author A. Krasznahorkay <Attila.Krasznahorkay@cern.ch> - CERN/Debrecen
 *
 ***************************************************************************/

#ifndef SFRAME_CORE_SInputData_H
#define SFRAME_CORE_SInputData_H

// STL include(s):
#include <vector>
#include <map>

// ROOT include(s):
#include <TObject.h>
#include <TNamed.h>

// Local include(s):
#include "SGeneratorCut.h"
#include "SLogger.h"
#include "SError.h"

// Forward declaration(s):
class TFileCollection;
class TFileInfo;
class TDirectory;
class TDSet;

class SDataSet : public TObject {

public:
   SDataSet( const TString& n = "", Double_t l = 1.0 )
      : name( n ), lumi( l ), events( 0 ) {}

   SDataSet& operator= ( const SDataSet& parent );
   Bool_t operator== ( const SDataSet& rh ) const;
   Bool_t operator!= ( const SDataSet& rh ) const;


   TString name;

   Double_t lumi;

   Long64_t events;

#ifndef DOXYGEN_IGNORE
   ClassDef( SDataSet, 1 );
#endif // DOXYGEN_IGNORE

}; // class SDataSet

class SFile : public TObject {

public:
   SFile()
      : file( "" ), lumi( -1 ), events( 0 ){}
   SFile( const TString& f )
      : file( f ), lumi( -1 ), events( 0 ){}
   SFile( const TString& f, Double_t l )
      : file( f ), lumi( l ), events( 0 ){}

   SFile& operator=  ( const SFile& parent );
   Bool_t operator== ( const SFile& rh ) const;
   Bool_t operator!= ( const SFile& rh ) const;


   TString  file;

   Double_t lumi;

   Long64_t events;

#ifndef DOXYGEN_IGNORE
   ClassDef( SFile, 1 );
#endif // DOXYGEN_IGNORE

}; // class SFile

class STree : public TObject {

public:
   STree( const TString& name = "", Int_t typ = 0 )
      : treeName( name ), type( typ ) {}

   STree& operator=  ( const STree& parent );
   Bool_t operator== ( const STree& rh ) const;
   Bool_t operator!= ( const STree& rh ) const;


   TString treeName;

   static const Int_t INPUT_TREE; 
   static const Int_t OUTPUT_TREE; 
   static const Int_t EVENT_TREE; 


   Int_t type;

#ifndef DOXYGEN_IGNORE
   ClassDef( STree, 1 );
#endif // DOXYGEN_IGNORE

}; // class STree

class SInputData : public TNamed {

public:
   SInputData( const char* name = "SInputData" );
   virtual ~SInputData();

   void SetType         ( const TString& type )          { m_type = type; }
   void SetVersion      ( const TString& version )       { m_version = version; }
   void SetTotalLumi    ( Double_t lumi )                { m_totalLumiGiven = lumi; }
   void SetNEventsMax   ( Long64_t nevents )             { m_neventsmax = nevents; }
   void SetNEventsSkip  ( Long64_t nevents )             { m_neventsskip = nevents; }

   void SetCacheable( Bool_t flag = kTRUE )              { m_cacheable = flag; }
   Bool_t GetCacheable() const                           { return m_cacheable; }

   void SetSkipValid( Bool_t flag = kTRUE )              { m_skipValid = flag; }
   Bool_t GetSkipValid() const                           { return m_skipValid; }

   void SetEventTreeEntry( Long64_t entry )              { m_entry = entry; }
   Long64_t GetEventTreeEntry() const                    { return m_entry; }

   void AddGenCut ( const SGeneratorCut& gencuts ) { m_gencuts.push_back( gencuts ); }
   void AddSFileIn( const SFile& sfile );
   void AddTree   ( Int_t type, const STree& stree );
   void AddDataSet( const SDataSet& dset );

   void AddEvents       ( Long64_t events )              { m_eventsTotal += events; }

   void ValidateInput( const char* pserver = 0 ) throw( SError );

   const TString&                       GetType() const           { return m_type; }
   const TString&                       GetVersion() const        { return m_version; }
   const std::vector< SGeneratorCut >&  GetSGeneratorCuts() const { return m_gencuts; }
   const std::vector< SFile >&          GetSFileIn() const        { return m_sfileIn; }
   std::vector< SFile >&                GetSFileIn()              { return m_sfileIn; }
   const std::vector< STree >*          GetTrees( Int_t type ) const;
   const std::map< Int_t, std::vector< STree > >& GetTrees() const { return m_trees; }
   const std::vector< SDataSet >&       GetDataSets() const       { return m_dataSets; }

   Bool_t HasInputTrees() const;

   TDSet* GetDSet() const;

   Double_t                             GetTotalLumi() const;
   Double_t                             GetScaledLumi() const;
   Long64_t                             GetEventsTotal() const    { return m_eventsTotal; }
   Long64_t                             GetNEventsMax() const     { return m_neventsmax; }
   Long64_t                             GetNEventsSkip() const    { return m_neventsskip; }

   SInputData& operator=  ( const SInputData& parent );
   Bool_t      operator== ( const SInputData& rh ) const;
   Bool_t      operator!= ( const SInputData& rh ) const;

   void Print( const Option_t* opt = 0 ) const;

   TString GetStringConfig() const;

private:
   void ValidateInputFiles() throw( SError );
   void ValidateInputDataSets( const char* pserver ) throw( SError );
   Bool_t LoadInfoOnFile( std::vector< SFile >::iterator& file_itr,
                          TFileCollection* filecoll );
   TFileInfo* AccessFileInfo( std::vector< SFile >::iterator& file_itr,
                              TFileCollection* filecoll );
   TDSet* MakeDataSet() throw( SError );
   TDSet* AccessDataSet( TDirectory* dir );

   TString                      m_type; 
   TString                      m_version; 
   Double_t                     m_totalLumiGiven; 
   std::vector< SGeneratorCut > m_gencuts; 
   std::vector< SFile >         m_sfileIn; 
   std::map< Int_t, std::vector< STree > > m_trees; 
   std::vector< SDataSet >      m_dataSets; 
   Double_t                     m_totalLumiSum; 
   Long64_t                     m_eventsTotal; 
   Long64_t                     m_neventsmax; 
   Long64_t                     m_neventsskip; 
   Bool_t                       m_cacheable; 
   Bool_t                       m_skipValid; 
   Long64_t                     m_entry; 

   TDSet*                       m_dset; 

   mutable SLogger              m_logger; 

#ifndef DOXYGEN_IGNORE
   ClassDef( SInputData, 1 );
#endif // DOXYGEN_IGNORE

}; // class SInputData

#endif // SFRAME_CORE_SInputData_H