HistoStrings.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 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.                                             *
\***********************************************************************************/
#pragma once
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <iosfwd>
#include <string>
// ============================================================================
// GaudiKernel
// ============================================================================
#include <GaudiKernel/StatusCode.h>
// ============================================================================
// forward declarations
// ============================================================================
// Forward declarations
// ============================================================================
// AIDA
// ============================================================================
namespace AIDA {
  class IHistogram1D;
  class IHistogram2D;
  class IHistogram3D;
  class IProfile1D;
  class IProfile2D;
} // namespace AIDA
// ============================================================================
// ROOT
// ============================================================================
class TH1D;       // ROOT
class TH2D;       // ROOT
class TH3D;       // ROOT
class TProfile;   // ROOT
class TProfile2D; // ROOT
// ============================================================================
namespace Gaudi {
  // ==========================================================================
  namespace Utils {
    // ========================================================================
    namespace Histos {
      // ======================================================================
      class GAUDI_API HistoStrings {
        // ====================================================================
      public:
        // ====================================================================
        static std::string toString( const TH1D& histo, const bool asXML = false );
        // ====================================================================
        static std::string toString( const TH2D& histo, const bool asXML = false );
        // ====================================================================
        static std::string toString( const AIDA::IHistogram1D& histo, const bool asXML = false );
        // ====================================================================
        static std::string toString( const AIDA::IHistogram2D& histo, const bool asXML = false );
        // ====================================================================
        static StatusCode fromString( TH1D& result, const std::string& input );
        // ====================================================================
        static StatusCode fromString( AIDA::IHistogram1D& result, const std::string& input );
        // ====================================================================
        static StatusCode fromString( TH2D& result, const std::string& input );
        // ====================================================================
        static StatusCode fromString( AIDA::IHistogram2D& result, const std::string& input );
        // ====================================================================
        static std::string toXml( const TH1D& histo );
        static std::string toXml( const TH2D& histo );
        static std::string toXml( const TH3D& histo );
        static std::string toXml( const TProfile& histo );
        static std::string toXml( const TProfile2D& histo );
        // ====================================================================
        static std::string toXml( const AIDA::IHistogram1D& histo );
        static std::string toXml( const AIDA::IHistogram2D& histo );
        static std::string toXml( const AIDA::IHistogram3D& histo );
        static std::string toXml( const AIDA::IProfile1D& histo );
        static std::string toXml( const AIDA::IProfile2D& histo );
        // ====================================================================
        static StatusCode fromXml( TH1D& result, const std::string& input );
        static StatusCode fromXml( TH2D& result, const std::string& input );
        static StatusCode fromXml( TH3D& result, const std::string& input );
        static StatusCode fromXml( TProfile& result, const std::string& input );
        static StatusCode fromXml( TProfile2D& result, const std::string& input );
        // ====================================================================
        static StatusCode fromXml( AIDA::IHistogram1D& result, const std::string& input );
        static StatusCode fromXml( AIDA::IHistogram2D& result, const std::string& input );
        static StatusCode fromXml( AIDA::IHistogram3D& result, const std::string& input );
        static StatusCode fromXml( AIDA::IProfile1D& result, const std::string& input );
        static StatusCode fromXml( AIDA::IProfile2D& result, const std::string& input );
        // ====================================================================
      };
      // ======================================================================
    } // namespace Histos
    // ========================================================================
  } // namespace Utils
  // ==========================================================================
} //                                                     end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================