GaudiTuples.h

Go to the documentation of this file.

#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
// ============================================================================
#include "boost/algorithm/string/replace.hpp"
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/ClassID.h"
// ============================================================================
// GaudiAlg
// ============================================================================
#include "GaudiAlg/GaudiHistoAlg.h"
#include "GaudiAlg/GaudiHistoTool.h"
#include "GaudiAlg/Maps.h"
#include "GaudiAlg/Tuple.h"
#include "GaudiAlg/TupleObj.h"
// ============================================================================
// ============================================================================
template <class PBASE>
class GAUDI_API GaudiTuples : public PBASE
{
public:
  // ==========================================================================
  typedef GaudiAlg::HistoID HistoID;
  typedef Tuples::Tuple Tuple;
  typedef GaudiAlg::TupleID TupleID;
  typedef GaudiAlg::TupleMapTitle TupleMapTitle;
  typedef GaudiAlg::TupleMapID TupleMapID;
  // ==========================================================================
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; }
  TupleID::NumericID nTupleOffSet() const { return m_nTupleOffSet; }
  std::string nTuplePath() const;
  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; }
  TupleID::NumericID evtColOffSet() const { return m_evtColOffSet; }
  std::string evtColPath() const;
  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 TupleMapID& nTupleMapID() const { return m_nTupleMapID; }
  const TupleMapID& evtColMapID() const { return m_evtColMapID; }
  // ==========================================================================
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:
  // ==========================================================================
  template <typename U = PBASE, class = typename std::enable_if<std::is_base_of<GaudiHistoAlg, PBASE>::value, U>::type>
  GaudiTuples( const std::string& name, ISvcLocator* pSvcLocator ) : PBASE( name, pSvcLocator )
  {
    initGaudiTuplesConstructor();
  }
  template <typename U = PBASE, class = typename std::enable_if<std::is_base_of<GaudiHistoTool, PBASE>::value, U>::type>
  GaudiTuples( const std::string& type, const std::string& name, const IInterface* parent )
      : PBASE( type, name, parent )
  {
    initGaudiTuplesConstructor();
  }
  ~GaudiTuples() override = default;
  // ==========================================================================
protected:
  // ==========================================================================
  StatusCode initialize() override
#ifdef __ICC
  {
    return i_gtInitialize();
  }
  StatusCode i_gtInitialize()
#endif
      ;
  StatusCode finalize() override
#ifdef __ICC
  {
    return i_gtFinalize();
  }
  StatusCode i_gtFinalize()
#endif
      ;
  // ==========================================================================
private:
  // ==========================================================================
  inline void initGaudiTuplesConstructor()
  {
    m_tuplesPrint.declareUpdateHandler( &GaudiTuples<PBASE>::printNTupleHandler, this );
    m_evtColsPrint.declareUpdateHandler( &GaudiTuples<PBASE>::printEvtColHandler, this );
  }
  // ==========================================================================
private:
  // ==========================================================================
  void printNTupleHandler( Gaudi::Details::PropertyBase& /* theProp */ ); //       "NTuplePrint"
  void printEvtColHandler( Gaudi::Details::PropertyBase& /* theProp */ ); //      "EvtcolsPrint"
  // ==========================================================================
private:
  // ==========================================================================
  Gaudi::Property<bool> m_produceNTuples{this, "NTupleProduce", true, "general switch to enable/disable N-tuples"};
  Gaudi::Property<bool> m_tuplesPrint{this, "NTuplePrint", true, "print N-tuple statistics"};
  Gaudi::Property<bool> m_splitNTupleDir{this, "NTupleSplitDir", false,
                                         "split long directory names into short pieces (suitable for HBOOK)"};
  Gaudi::Property<TupleID::NumericID> m_nTupleOffSet{this, "NTupleOffSet", 0, "offset for numerical N-tuple ID"};
  Gaudi::Property<std::string> m_nTupleLUN{this, "NTupleLUN", "FILE1", "Logical File Unit for N-tuples"};
  Gaudi::Property<std::string> m_nTupleTopDir{this, "NTupleTopDir", "", "top-level directory for N-Tuples"};
  Gaudi::Property<std::string> m_nTupleDir{
      this, "NTupleDir", boost::algorithm::replace_all_copy( this->name(), ":", "_" ), "subdirectory for N-Tuples"};

  Gaudi::Property<bool> m_produceEvtCols{this, "EvtColsProduce", false,
                                         "general switch to enable/disable Event Tag Collections"};
  Gaudi::Property<bool> m_evtColsPrint{this, "EvtColsPrint", false, "print statistics for Event Tag Collections "};
  Gaudi::Property<bool> m_splitEvtColDir{this, "EvtColSplitDir", false, "split long directory names into short pieces"};
  Gaudi::Property<TupleID::NumericID> m_evtColOffSet{this, "EvtColOffSet", 0, "offset for numerical N-tuple ID"};
  Gaudi::Property<std::string> m_evtColLUN{this, "EvtColLUN", "EVTCOL", "Logical File Unit for Event Tag Collections"};
  Gaudi::Property<std::string> m_evtColTopDir{this, "EvtColTopDir", "",
                                              "Top-level directory for Event Tag Collections"};
  Gaudi::Property<std::string> m_evtColDir{this, "EvtColDir",
                                           boost::algorithm::replace_all_copy( this->name(), ":", "_" ),
                                           "Subdirectory for Event Tag Collections"};
  // ==========================================================================
  mutable TupleMapTitle m_nTupleMapTitle;
  mutable TupleMapID m_nTupleMapID;
  // ==========================================================================
  mutable TupleMapTitle m_evtColMapTitle;
  mutable TupleMapID m_evtColMapID;
  // ==========================================================================
};
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIALG_GAUDITUPLES_H
// ============================================================================