ICounterSvc.h

Go to the documentation of this file.

// ============================================================================
#ifndef GAUDIKERNEL_ICOUNTERSVC_H
#define GAUDIKERNEL_ICOUNTERSVC_H
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <string>
#include <vector>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/IInterface.h"
#include "GaudiKernel/SmartIF.h"
#include "GaudiKernel/StatEntity.h"
// ============================================================================
// Forward declarations
// ============================================================================
class MsgStream;
class StatEntity;
class Stat;
// ============================================================================
class GAUDI_API ICounterSvc : virtual public IInterface
{
public:
  DeclareInterfaceID( ICounterSvc, 4, 0 );
  typedef StatEntity Counter;
  typedef Stat CountObject;
  typedef std::vector<CountObject> Counters;
  class Printout final
  {
  public:
    Printout( ICounterSvc* svc );
    StatusCode operator()( MsgStream& log, const Counter* cnt ) const;

    // no default,copy constructor, assignment
    Printout()                  = delete;            
    Printout( const Printout& ) = delete;            //< no copy constructor
    Printout& operator=( const Printout& ) = delete; 
  private:
    SmartIF<ICounterSvc> m_svc;
  };
  virtual Counter* get( const std::string& group, const std::string& name ) const = 0;
  virtual Counters get( const std::string& group ) const = 0;
  virtual StatusCode create( const std::string& group, const std::string& name, longlong initial_value,
                             Counter*& refpCounter ) = 0;
  virtual CountObject create( const std::string& group, const std::string& name, longlong initial_value = 0 ) = 0;
  virtual StatusCode remove( const std::string& group, const std::string& name ) = 0;
  virtual StatusCode remove( const std::string& group ) = 0;
  virtual StatusCode print( const std::string& group, const std::string& name, Printout& printer ) const = 0;
  virtual StatusCode print( const std::string& group, Printout& printer ) const = 0;
  virtual StatusCode print( const Counter* pCounter, Printout& printer ) const = 0;
  virtual StatusCode print( const CountObject& pCounter, Printout& printer ) const = 0;
  virtual StatusCode print( Printout& printer ) const = 0;
  virtual StatusCode defaultPrintout( MsgStream& log, const Counter* pCounter ) const = 0;
  // Return codes:
  enum {
    COUNTER_NOT_PRESENT = 2, // Error
    COUNTER_EXISTS      = 4, // Error ?
    COUNTER_REMOVED     = 3  // Type of success. Low bit set
  };
};
// ============================================================================
// ============================================================================
std::ostream& operator<<( std::ostream&, const ICounterSvc::CountObject& );
// ============================================================================
// ============================================================================
#endif // GAUDIKERNEL_ICOUNTERSVC_H
// ============================================================================