ITHistSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_ITHISTSVC_H
#define GAUDIKERNEL_ITHISTSVC_H

#include <memory>
#include <string>
#include <vector>

#ifndef GAUDIKERNEL_ISERVICE_H
#  include "GaudiKernel/IService.h"
#endif

#include "GaudiKernel/LockedHandle.h"

class TObject;
class TH1;
class TH2;
class TH3;
class TTree;
class TList;
class TDirectory;
class TGraph;
class TEfficiency;

class GAUDI_API ITHistSvc : virtual public IService {
public:
  DeclareInterfaceID( ITHistSvc, 3, 0 );


  virtual StatusCode regHist( const std::string& name ) = 0;
  virtual StatusCode regHist( const std::string& name, std::unique_ptr<TH1> hist ) = 0;
  virtual StatusCode regHist( const std::string& name, std::unique_ptr<TH1> hist, TH1* hist_ptr ) = 0;
  virtual StatusCode regHist( const std::string& name, TH1* ) = 0;
  virtual StatusCode getHist( const std::string& name, TH1*&, size_t index = 0 ) const = 0;
  virtual StatusCode getHist( const std::string& name, TH2*&, size_t index = 0 ) const = 0;
  virtual StatusCode getHist( const std::string& name, TH3*&, size_t index = 0 ) const = 0;



  virtual StatusCode regTree( const std::string& name ) = 0;
  virtual StatusCode regTree( const std::string& name, std::unique_ptr<TTree> ) = 0;
  virtual StatusCode regTree( const std::string& name, TTree* ) = 0;
  virtual StatusCode getTree( const std::string& name, TTree*& ) const = 0;



  virtual StatusCode regGraph( const std::string& name ) = 0;
  virtual StatusCode regGraph( const std::string& name, std::unique_ptr<TGraph> ) = 0;
  virtual StatusCode regGraph( const std::string& name, TGraph* ) = 0;
  virtual StatusCode getGraph( const std::string& name, TGraph*& ) const = 0;



  virtual StatusCode regEfficiency( const std::string& name ) = 0;
  virtual StatusCode regEfficiency( const std::string& name, std::unique_ptr<TEfficiency> ) = 0;
  virtual StatusCode regEfficiency( const std::string& name, TEfficiency* ) = 0;
  virtual StatusCode getEfficiency( const std::string& name, TEfficiency*& ) const = 0;



  virtual StatusCode regShared( const std::string& name, std::unique_ptr<TH1>, LockedHandle<TH1>& ) = 0;
  virtual StatusCode regShared( const std::string& name, std::unique_ptr<TH2>, LockedHandle<TH2>& ) = 0;
  virtual StatusCode regShared( const std::string& name, std::unique_ptr<TH3>, LockedHandle<TH3>& ) = 0;
  virtual StatusCode regShared( const std::string& name, std::unique_ptr<TGraph>, LockedHandle<TGraph>& ) = 0;
  virtual StatusCode regShared( const std::string& name, std::unique_ptr<TEfficiency>, LockedHandle<TEfficiency>& ) = 0;
  virtual StatusCode getShared( const std::string& name, LockedHandle<TH1>& ) const = 0;
  virtual StatusCode getShared( const std::string& name, LockedHandle<TH2>& ) const = 0;
  virtual StatusCode getShared( const std::string& name, LockedHandle<TH3>& ) const = 0;
  virtual StatusCode getShared( const std::string& name, LockedHandle<TGraph>& ) const = 0;
  virtual StatusCode getShared( const std::string& name, LockedHandle<TEfficiency>& ) const = 0;



  virtual StatusCode deReg( const std::string& name ) = 0;
  virtual StatusCode deReg( TObject* obj ) = 0;

  virtual StatusCode merge( const std::string& id ) = 0;
  virtual StatusCode merge( TObject* ) = 0;

  virtual bool exists( const std::string& name ) const = 0;
  virtual bool existsHist( const std::string& name ) const = 0;
  virtual bool existsTree( const std::string& name ) const = 0;
  virtual bool existsGraph( const std::string& name ) const = 0;
  virtual bool existsEfficiency( const std::string& name ) const = 0;



  virtual std::vector<std::string> getHists() const        = 0;
  virtual std::vector<std::string> getTrees() const        = 0;
  virtual std::vector<std::string> getGraphs() const       = 0;
  virtual std::vector<std::string> getEfficiencies() const = 0;

  virtual StatusCode getTHists( TDirectory* td, TList&, bool recurse = false ) const                      = 0;
  virtual StatusCode getTHists( const std::string& name, TList&, bool recurse = false ) const             = 0;
  virtual StatusCode getTHists( TDirectory* td, TList&, bool recurse = false, bool reg = false )          = 0;
  virtual StatusCode getTHists( const std::string& name, TList&, bool recurse = false, bool reg = false ) = 0;

  virtual StatusCode getTTrees( TDirectory* td, TList&, bool recurse = false ) const                      = 0;
  virtual StatusCode getTTrees( const std::string& name, TList&, bool recurse = false ) const             = 0;
  virtual StatusCode getTTrees( TDirectory* td, TList&, bool recurse = false, bool reg = false )          = 0;
  virtual StatusCode getTTrees( const std::string& name, TList&, bool recurse = false, bool reg = false ) = 0;

  virtual StatusCode getTEfficiencies( TDirectory* td, TList&, bool recurse = false ) const                      = 0;
  virtual StatusCode getTEfficiencies( const std::string& name, TList&, bool recurse = false ) const             = 0;
  virtual StatusCode getTEfficiencies( TDirectory* td, TList&, bool recurse = false, bool reg = false )          = 0;
  virtual StatusCode getTEfficiencies( const std::string& name, TList&, bool recurse = false, bool reg = false ) = 0;

  virtual ~ITHistSvc() = default;
};

#endif // GAUDIKERNEL_ITHISTSVC_H