Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

GaudiTuples.h

Go to the documentation of this file.

// $Id: GaudiTuples.h,v 1.6 2008/01/17 15:06:06 marcocle Exp $
#ifndef GAUDIALG_GAUDITUPLES_H
#define GAUDIALG_GAUDITUPLES_H 1

// ============================================================================
/* @file GaudiTuples.h
 *
 *  Header file for class : GaudiTuples
 *
 *  @author Chris Jones   Christopher.Rob.Jones@cern.ch
 *  @author Vanya BELYAEV Ivan.Belyaev@itep.ru
 *  @date   2005-08-08
 */
// ============================================================================

// Include files
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/ClassID.h"
// ============================================================================
// GaudiAlg
// ============================================================================
#include "GaudiAlg/Maps.h"
#include "GaudiAlg/Tuple.h"
#include "GaudiAlg/TupleObj.h"

// ============================================================================
// ============================================================================

template <class PBASE>
class GaudiTuples : public PBASE
{

public:

  typedef GaudiAlg::HistoID         HistoID;

  typedef Tuples::Tuple             Tuple         ;
  typedef GaudiAlg::TupleID         TupleID       ;

  typedef GaudiAlg::TupleMapTitle      TupleMapTitle ;
  typedef GaudiAlg::TupleMapNumericID  TupleMapNumID ;
  typedef GaudiAlg::TupleMapLiteralID  TupleMapLitID ;

public:

  Tuple  nTuple ( const std::string& title                        ,
                  const CLID&        clid  = CLID_ColumnWiseTuple ) const ;

  Tuple  nTuple ( const TupleID&     ID                           ,
                  const std::string& title                        ,
                  const CLID&        clid  = CLID_ColumnWiseTuple ) const ;

  Tuple  evtCol ( const std::string& title                        ,
                  const CLID&        clid  = CLID_ColumnWiseTuple ) const ;

  Tuple  evtCol ( const TupleID&     ID                           ,
                  const std::string& title                        ,
                  const CLID&        clid  = CLID_ColumnWiseTuple ) const ;

public:  // trivial accessors

  bool               produceNTuples () const { return m_produceNTuples ; }
  bool               splitNTupleDir () const { return m_splitNTupleDir ; }
  const std::string& nTupleLUN      () const { return m_nTupleLUN      ; }
  const std::string& nTupleTopDir   () const { return m_nTupleTopDir   ; }
  const std::string& nTupleDir      () const { return m_nTupleDir      ; }
  const TupleID::NumericID nTupleOffSet   () const { return m_nTupleOffSet   ; }
  std::string        nTuplePath     () const
  {
    const std::string path = nTupleLUN() + "/" + nTupleTopDir() + nTupleDir();
    return ( splitNTupleDir() ? dirHbookName( path ) : path ) ;
  }

  bool               produceEvtCols () const { return m_produceEvtCols ; }
  bool               splitEvtColDir () const { return m_splitEvtColDir ; }
  const std::string& evtColLUN      () const { return m_evtColLUN      ; }
  const std::string& evtColTopDir   () const { return m_evtColTopDir   ; }
  const std::string& evtColDir      () const { return m_evtColDir      ; }
  const TupleID::NumericID     evtColOffSet   () const { return m_evtColOffSet   ; }
  std::string        evtColPath     () const
  {
    std::string path = evtColLUN() + "/" + evtColTopDir() + evtColDir();
    return ( splitEvtColDir() ? dirHbookName( path ) : path );
  }

  bool tuplesPrint  () const { return m_tuplesPrint  ; }
  bool evtColsPrint () const { return m_evtColsPrint ; }

public :

  long printTuples  () const ;

  long printEvtCols () const ;

public :

  bool nTupleExists ( const TupleID& ID ) const;

  bool evtColExists ( const TupleID& ID ) const;

protected:

  const TupleMapTitle& nTupleMapTitle () const { return m_nTupleMapTitle ; }
  const TupleMapTitle& evtColMapTitle () const { return m_evtColMapTitle ; }
  const TupleMapNumID& nTupleMapNumID () const { return m_nTupleMapNumID ; }
  const TupleMapNumID& evtColMapNumID () const { return m_evtColMapNumID ; }
  const TupleMapLitID& nTupleMapLitID () const { return m_nTupleMapLitID ; }
  const TupleMapLitID& evtColMapLitID () const { return m_evtColMapLitID ; }

protected:

  virtual Tuples::TupleObj*
  createNTuple ( const std::string& name  ,
                 NTuple::Tuple*     tuple ,
                 const CLID&        clid  ) const ;

  virtual Tuples::TupleObj*
  createEvtCol ( const std::string& name  ,
                 NTuple::Tuple*     tuple ,
                 const CLID&        clid  ) const ;

public:

  GaudiTuples ( const std::string & name,
                ISvcLocator * pSvcLocator );

  GaudiTuples ( const std::string& type   ,
                const std::string& name   ,
                const IInterface*  parent );

  virtual ~GaudiTuples();

protected:

  virtual StatusCode initialize ();

  virtual StatusCode finalize   ();

private:

  inline void initGaudiTuplesConstructor()
  {
    m_produceNTuples = true ;     // Switch ON/OFF ntuple production
    m_splitNTupleDir = false ;    // for HBOOK it is better to use 'true'
    m_nTupleLUN      = "FILE1" ;  // logical unit for ntuples
    m_nTupleTopDir   = "" ;       // top level ntuple directory
    m_nTupleDir      = this->name() ;   // ntuple directory
    m_nTupleOffSet   = 0  ;       // offset for ntuples
    //
    m_produceEvtCols = false ;    // Switch ON/OFF ntupel production
    m_splitEvtColDir = false ;    // for HBOOK it is better to use 'true'
    m_evtColLUN      = "EVTCOL" ; // logical unit for ntuples
    m_evtColTopDir   = ""    ;    // top level ntuple directory
    m_evtColDir      = this->name() ;   // ntuple directory
    m_evtColOffSet   = 0   ;      // offset for ntuples
    //
    m_tuplesPrint    = true  ;    // print tuples at end of job
    m_evtColsPrint   = false  ;   // print event collections at end of job
    //
    this->declareProperty ( "NTupleProduce"  , m_produceNTuples ) ;
    this->declareProperty ( "NTuplePrint"    , m_tuplesPrint    ) ;
    this->declareProperty ( "NTupleSplitDir" , m_splitNTupleDir ) ;
    this->declareProperty ( "NTupleOffSet"   , m_nTupleOffSet   ) ;
    this->declareProperty ( "NTupleLUN"      , m_nTupleLUN      ) ;
    this->declareProperty ( "NTupleTopDir"   , m_nTupleTopDir   ) ;
    this->declareProperty ( "NTupleDir"      , m_nTupleDir      ) ;
    //
    this->declareProperty ( "EvtColsProduce" , m_produceEvtCols ) ;
    this->declareProperty ( "EvtColsPrint"   , m_evtColsPrint   ) ;
    this->declareProperty ( "EvtColSplitDir" , m_splitEvtColDir ) ;
    this->declareProperty ( "EvtColOffSet"   , m_evtColOffSet   ) ;
    this->declareProperty ( "EvtColLUN"      , m_evtColLUN      ) ;
    this->declareProperty ( "EvtColTopDir"   , m_evtColTopDir   ) ;
    this->declareProperty ( "EvtColDir"      , m_evtColDir      ) ;
  }

private:

  bool        m_produceNTuples ;
  bool        m_splitNTupleDir ;
  std::string m_nTupleLUN      ;
  std::string m_nTupleTopDir   ;
  std::string m_nTupleDir      ;
  TupleID::NumericID     m_nTupleOffSet   ;

  bool        m_produceEvtCols ;
  bool        m_splitEvtColDir ;
  std::string m_evtColLUN      ;
  std::string m_evtColTopDir   ;
  std::string m_evtColDir      ;
  TupleID::NumericID     m_evtColOffSet   ;

  bool m_tuplesPrint    ; 

  bool m_evtColsPrint   ; 

  mutable TupleMapTitle  m_nTupleMapTitle ;
  mutable TupleMapNumID  m_nTupleMapNumID    ;
  mutable TupleMapLitID  m_nTupleMapLitID    ;

  mutable TupleMapTitle  m_evtColMapTitle ;
  mutable TupleMapNumID  m_evtColMapNumID    ;
  mutable TupleMapLitID  m_evtColMapLitID    ;

};

#endif // GAUDIALG_GAUDITUPLES_H

---