core/include/SCycleBaseConfig.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
// $Id: SCycleBaseConfig.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_SCycleBaseConfig_H
#define SFRAME_CORE_SCycleBaseConfig_H

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

// ROOT include(s):
#include "TList.h"

// Local include(s):
#include "ISCycleBaseConfig.h"
#include "SCycleBaseBase.h"
#include "SError.h"
#include "SCycleConfig.h"

// Forward declaration(s):
class TXMLNode;

class SCycleBaseConfig : public virtual ISCycleBaseConfig,
                         public virtual SCycleBaseBase {

public:
   SCycleBaseConfig();

   void Initialize( TXMLNode* ) throw( SError );

   const SCycleConfig& GetConfig() const;
   SCycleConfig& GetConfig();
   virtual void SetConfig( const SCycleConfig& config );

   virtual const TList& GetConfigurationObjects() const;

   virtual void SetConfInput( TList* input );
   virtual TList* GetConfInput() const;

   void DeclareProperty( const std::string& name, std::string& value );
   void DeclareProperty( const std::string& name, int& value );
   void DeclareProperty( const std::string& name, double& value );
   void DeclareProperty( const std::string& name, bool& value );
   void DeclareProperty( const std::string& name, std::vector< std::string >& value );
   void DeclareProperty( const std::string& name, std::vector< int >& value );
   void DeclareProperty( const std::string& name, std::vector< double >& value );
   void DeclareProperty( const std::string& name, std::vector< bool >& value );

   void AddConfigObject( TObject* object );
   TObject* GetConfigObject( const char* name ) const;

protected:
   virtual SInputData InitializeInputData( TXMLNode* ) throw( SError );
   virtual void InitializeUserConfig( TXMLNode* ) throw( SError );

   void SetProperty( const std::string& name,
                     const std::string& value ) throw( SError );

   std::string DecodeEnvVar( const std::string& value ) const; 

   SCycleConfig m_config;

private:
   bool ToBool( const std::string& value ) throw( SError );
   template< typename T >
   void AddUserOptions( const std::map< const std::string, T* >& prefs );

   //
   // These are the object used to handle the preferences of the
   // derived classes. Note that because of some "improvements" in
   // the ROOT code, now these have to be very strictly hidden from
   // the dictionary generation.
   //
#ifndef __MAKECINT__
   std::set< std::string >                                    m_configuredPrefs;
   std::map< const std::string, std::string* >                m_stringPrefs;
   std::map< const std::string, int* >                        m_intPrefs;
   std::map< const std::string, double* >                     m_doublePrefs;
   std::map< const std::string, bool* >                       m_boolPrefs;
   std::map< const std::string, std::vector< std::string >* > m_stringListPrefs;
   std::map< const std::string, std::vector< int >* >         m_intListPrefs;
   std::map< const std::string, std::vector< double >* >      m_doubleListPrefs;
   std::map< const std::string, std::vector< bool >* >        m_boolListPrefs;
#endif // __MAKECINT__

   //
   // The TList has to be hidden from the dictionary generator because one
   // of the internal components of TList doesn't have a dictionary. This
   // produces a WARNING message when the CINT dictionary knows about this
   // variable.
   //
#ifndef __MAKECINT__

   TList m_configList;
#endif // __MAKECINT__

   TList* m_input;

#ifndef DOXYGEN_IGNORE
   ClassDef( SCycleBaseConfig, 0 );
#endif // DOXYGEN_IGNORE

}; // class SCycleBaseConfig

#endif // SFRAME_CORE_SCycleBaseConfig_H