Stat.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 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 __GAUDI_CHRONOSTATSVC_STAT_H__
#define __GAUDI_CHRONOSTATSVC_STAT_H__
// ============================================================================
// Iinclude files
// ============================================================================
// STD & STL
// ============================================================================
#include <iostream>
#include <string>
// ============================================================================
// GaudiKernel
// ============================================================================
#include <GaudiKernel/IStatSvc.h>
#include <GaudiKernel/SmartIF.h>
#include <GaudiKernel/StatEntity.h>
// ============================================================================
class GAUDI_API Stat {
public:
  Stat( StatEntity* entity = 0, const std::string& name = "", const std::string& group = "" )
      : m_entity( entity ), m_tag( name ), m_group( group ) {}
  Stat( StatEntity& entity, const std::string& name = "", const std::string& group = "" )
      : m_entity( &entity ), m_tag( name ), m_group( group ) {}
  Stat( IStatSvc* svc, const std::string& tag );
  Stat( IStatSvc* svc, const std::string& tag, const double flag );
  Stat( const Stat& ) = default;
  Stat& operator=( const Stat& ) = default;
  ~Stat() = default;
  // ==========================================================================
  const StatEntity* entity() const { return m_entity; }
  const StatEntity* operator->() const { return entity(); }
  operator const StatEntity&() const { return *entity(); }
  bool operator!() const { return 0 == m_entity; }
  // ==========================================================================
  Stat& operator+=( const double f ) {
    if ( m_entity ) { ( *m_entity ) += f; }
    return *this;
  }
  Stat& operator++() {
    if ( m_entity ) { ++( *m_entity ); }
    return *this;
  }
  Stat& operator++( int ) {
    if ( m_entity ) { ( *m_entity )++; }
    return *this;
  }
  Stat& operator-=( const double f ) {
    if ( m_entity ) { ( *m_entity ) -= f; }
    return *this;
  }
  Stat& operator--() {
    if ( m_entity ) { --( *m_entity ); }
    return *this;
  }
  Stat& operator--( int ) {
    if ( m_entity ) { ( *m_entity )--; }
    return *this;
  }
  Stat& operator+=( const StatEntity& right ) {
    if ( m_entity ) { ( *m_entity ) += right; }
    return *this;
  }
  Stat& operator+=( const Stat& right ) {
    if ( 0 != right.entity() ) { ( *this ) += *right.entity(); }
    return *this;
  }
  // ==========================================================================
  std::string toString() const;
  std::ostream& print( std::ostream& o = std::cout ) const;
  std::ostream& fillStream( std::ostream& o ) const { return print( o ); }
  // ==========================================================================
  StatEntity* counter() const { return m_entity; }
  const std::string& name() const { return m_tag; }
  const std::string& group() const { return m_group; }
  // ==========================================================================
private:
  // underlying counter
  StatEntity* m_entity = nullptr; 
  // unique stat tag(name)
  std::string m_tag; 
  // group
  std::string m_group;
  // Stat  service
  SmartIF<IStatSvc> m_stat; 
};
// ============================================================================
GAUDI_API Stat operator+( const Stat& stat, const double value );
// ============================================================================
GAUDI_API Stat operator-( const Stat& stat, const double value );
// ============================================================================
GAUDI_API Stat operator+( const double value, const Stat& stat );
// ============================================================================
GAUDI_API Stat operator+( const Stat& stat, const Stat& value );
// ============================================================================
GAUDI_API std::ostream& operator<<( std::ostream& stream, const Stat& stat );
// ============================================================================
 
// ============================================================================
// The END
// ============================================================================
#endif // __GAUDI_CHRONOSTATSVC_STAT_H__