plug-ins/include/SToolBase.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
// $Id: SToolBase.h 275 2011-10-11 08:43:24Z krasznaa $
/***************************************************************************
 * @Project: SFrame - ROOT-based analysis framework for ATLAS
 * @Package: Plug-ins
 *
 * @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_PLUGINS_SToolBase_H
#define SFRAME_PLUGINS_SToolBase_H

// SFrame include(s):
#include "core/include/SLogger.h"
#include "core/include/SCycleBase.h"

// Forward declaration(s):
class TH1;
class TObject;
class TBranch;
template< class T > class SInputVariables;
template< class T > class SOutputVariables;

template< class Type >
class SToolBaseT {

   friend class SInputVariables< SToolBaseT< SCycleBase > >;
   friend class SOutputVariables< SToolBaseT< SCycleBase > >;
   friend class SToolBaseT< SToolBaseT< SCycleBase > >;

public:
   typedef Type ParentType;

   SToolBaseT();
   SToolBaseT( ParentType* parent );
   virtual ~SToolBaseT() {}

   ParentType* GetParent() const;
   void SetParent( ParentType* parent );

protected:
   //                                                         //
   //         Functions inherited from SCycleBaseHist         //
   //                                                         //

   template< class T > T* Book( const T& histo,
                                const char* directory = 0 ) throw( SError );
   template< class T > T* Retrieve( const char* name,
                                    const char* directory = 0,
                                    Bool_t outputOnly = kFALSE ) throw( SError );
   template< class T >
   std::vector< T* > RetrieveAll( const char* name,
                                  const char* directory = 0 ) throw( SError );
   void WriteObj( const TObject& obj,
                  const char* directory = 0 ) throw( SError );
   TH1* Hist( const char* name, const char* dir = 0 );

   //                                                         //
   //        Functions inherited from SCycleBaseNTuple        //
   //                                                         //

   template< typename T >
   bool ConnectVariable( const char* treeName, const char* branchName,
                         T& variable ) throw ( SError );
   template< typename T >
   TBranch* DeclareVariable( T& obj, const char* name,
                             const char* treeName = 0 ) throw( SError );
   virtual TTree* GetMetadataTree( const char* name ) const throw( SError );
   virtual TTree* GetInputMetadataTree( const char* name ) const throw( SError );
   virtual TTree* GetOutputMetadataTree( const char* name ) const throw( SError );
   virtual TTree* GetInputTree( const char* treeName ) const throw( SError );
   virtual TTree* GetOutputTree( const char* treeName ) const throw( SError );

   //                                                         //
   //        Functions inherited from SCycleBaseConfig        //
   //                                                         //

   template< typename T >
   void DeclareProperty( const std::string& name, T& value );
   void AddConfigObject( TObject* object );
   TObject* GetConfigObject( const char* name ) const;

   //                                                         //
   //               The class's own functions                 //
   //                                                         //

   void SetLogName( const char* name );

protected:
   mutable SLogger m_logger; 

private:
   ParentType* m_parent; 

}; // class SToolBaseT

// Include the template implementation:
#ifndef __CINT__
#include "SToolBase.icc"
#endif // __CINT__


typedef SToolBaseT< SCycleBase > SToolBase;

#endif // SFRAME_PLUGINS_SToolBase_H