AlgDecorators.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 GAUDIPYTHON_ALGDECORATORS_H
#define GAUDIPYTHON_ALGDECORATORS_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <string>
// ============================================================================
// GaudiAlg
// ============================================================================
#include "GaudiAlg/GaudiAlgorithm.h"
// ============================================================================
// GaudiPython
// ============================================================================
#include "GaudiPython/GaudiPython.h"
// ============================================================================
// forward declarations
// ============================================================================
class IInterface;
class IProperty;
class IAlgTool;
class IAlgorithm;
class GaudiAlgorithm;
class GaudiTool;
class DataObject;
// ============================================================================
// ============================================================================
namespace GaudiPython {
  // ==========================================================================
  class GAUDI_API AlgDecorator {
  public:
    // ========================================================================
    typedef std::vector<Gaudi::Accumulators::PrintableCounter*> Counters;
    typedef std::vector<IAlgTool*>                              Tools;
    typedef std::vector<IService*>                              Services;
    // ========================================================================
    // the general functional methods
    // ========================================================================
  public:
    static IAlgTool* tool_( const GaudiAlgorithm* alg, const std::string& type, const std::string& name,
                            const IInterface* parent = 0, const bool create = true );
    static IAlgTool* tool_( const GaudiAlgorithm* alg, const std::string& typeAndName, const IInterface* parent = 0,
                            const bool create = true );
    static IInterface* svc_( const GaudiAlgorithm* alg, const std::string& name, const bool create = false );
    // ========================================================================
    // get the data from TES
    // ========================================================================
  public:
    static DataObject* get_( const GaudiAlgorithm* alg, const std::string& location, const bool useRootInTes );
    // ========================================================================
  public:
    // ========================================================================
    static bool exist( const GaudiAlgorithm* alg, const std::string& location, const bool useRootInTes );
    // ========================================================================
  public: // inspection: get all counters:
    // ========================================================================
    static size_t _counters_a_( const GaudiAlgorithm* alg, std::vector<std::string>& names, Counters& out );
    static size_t _counters_t_( const GaudiTool* alg, std::vector<std::string>& names, Counters& out );
    static size_t _counters_a_( const IAlgorithm* alg, std::vector<std::string>& names, Counters& out );
    static size_t _counters_t_( const IAlgTool* alg, std::vector<std::string>& names, Counters& out );
    // ========================================================================
  public: // inspection: get the counter
    // ========================================================================
    static StatEntity* _counter_a_( const GaudiAlgorithm* alg, const std::string& name );
    static StatEntity* _counter_t_( const GaudiTool* alg, const std::string& name );
    static StatEntity* _counter_a_( const IAlgorithm* alg, const std::string& name );
    static StatEntity* _counter_t_( const IAlgTool* alg, const std::string& name );
    // ========================================================================
  public: // inspection: get all tools
    // ========================================================================
    static size_t _tools_a_( const GaudiAlgorithm*, Tools& tools );
    static size_t _tools_t_( const GaudiTool*, Tools& tools );
    static size_t _tools_a_( const IAlgorithm*, Tools& tools );
    static size_t _tools_t_( const IAlgTool*, Tools& tools );
    // ========================================================================
  };
  // ==========================================================================
} //                                               end of namespace GaudiPython
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIPYTHON_ALGDECORATORS_H