core/include/SCycleConfig.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
// $Id: SCycleConfig.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_SCycleConfig_H
#define SFRAME_CORE_SCycleConfig_H

// STL include(s):
#include <vector>
//#include <bits/stl_pair.h> // I have to include <map> here, because rootcint can't
#include <map>               // understand <bits/stl_pair.h> in Athena for some reason...

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

// Local include(s):
#include "SInputData.h"
#include "SError.h"
#include "SMsgType.h"

class SCycleConfig : public TNamed {

public:
   SCycleConfig( const char* name = "SCycleConfig" );

   const TString& GetCycleName() const;
   void SetCycleName( const TString& name );


   enum RunMode {
      LOCAL, 
      PROOF  
   };
   typedef std::vector< std::pair< std::string, std::string > > property_type;
   typedef std::vector< SInputData > id_type;

   RunMode GetRunMode() const;
   void SetRunMode( RunMode mode );

   const TString& GetProofServer() const;
   void SetProofServer( const TString& server );

   const Int_t& GetProofNodes() const;
   void SetProofNodes( const Int_t nodes );

   const TString& GetProofWorkDir() const;
   void SetProofWorkDir( const TString& workdir );

   const property_type& GetProperties() const;
   void SetProperty( const std::string& name, const std::string& value );

   const id_type& GetInputData() const;
   void AddInputData( const SInputData& id );


   void SetTargetLumi( Double_t targetlumi ) { m_targetLumi = targetlumi; }

   Double_t GetTargetLumi() const { return m_targetLumi; }

   void SetOutputDirectory( const TString& outDir );
   const TString& GetOutputDirectory() const;

   void SetPostFix( const TString& postFix );
   const TString& GetPostFix() const;

   void SetMsgLevel( SMsgType level );
   SMsgType GetMsgLevel() const;

   void SetUseTreeCache( Bool_t status = kTRUE );
   Bool_t GetUseTreeCache() const;

   void SetCacheSize( Long64_t size );
   Long64_t GetCacheSize() const;

   void SetCacheLearnEntries( Int_t entries );
   Int_t GetCacheLearnEntries() const;

   void SetProcessOnlyLocal( Bool_t flag );
   Bool_t GetProcessOnlyLocal() const;

   void PrintConfig() const;

   void ArrangeInputData() throw ( SError );

   void ValidateInput();

   TString GetStringConfig( const SInputData* id = 0 ) const;

   void ClearConfig();

private:
   TString       m_cycleName; 
   RunMode       m_mode; 
   TString       m_server; 
   TString       m_workdir; 
   Int_t         m_nodes; 
   property_type m_properties; 
   id_type       m_inputData; 
   Double_t      m_targetLumi; 
   TString       m_outputDirectory; 
   TString       m_postFix; 
   SMsgType      m_msgLevel; 
   Bool_t        m_useTreeCache; 
   Long64_t      m_cacheSize; 
   Int_t         m_cacheLearnEntries; 
   Bool_t        m_processOnlyLocal; 

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

}; // class SCycleConfig

#endif // SFRAME_CORE_SCycleConfig_H