Histo2String.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;
} // namespace AIDA
// ============================================================================
// ROOT
// ============================================================================
class TH1D; // ROOT
class TH2D; // ROOT
class TH3D; // ROOT
class TH1F; // ROOT
class TH2F; // ROOT
class TH3F; // ROOT
// ============================================================================
namespace Gaudi {
  // ===========================================================================
  namespace Utils {
    // =========================================================================
    GAUDI_API std::ostream& toStream( const TH1D& histo, std::ostream& stream, const bool asXML = false );
    // =========================================================================
    GAUDI_API std::ostream& toStream( const TH2D& histo, std::ostream& stream, const bool asXML = false );
    // =========================================================================
    GAUDI_API std::ostream& toStream( const TH3D& histo, std::ostream& stream, const bool asXML = false );
    // =========================================================================
    GAUDI_API std::ostream& toStream( const TH1F& histo, std::ostream& stream, const bool asXML = false );
    // =========================================================================
    GAUDI_API std::ostream& toStream( const TH2F& histo, std::ostream& stream, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::ostream& toStream( const TH3F& histo, std::ostream& stream, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::ostream& toStream( const AIDA::IHistogram1D& histo, std::ostream& stream, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::ostream& toStream( const AIDA::IHistogram2D& histo, std::ostream& stream, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::ostream& toStream( const AIDA::IHistogram3D& histo, std::ostream& stream, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const TH1D& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const TH2D& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const TH3D& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const TH1F& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const TH2F& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const TH3F& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const AIDA::IHistogram1D& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const AIDA::IHistogram2D& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const AIDA::IHistogram3D& histo, const bool asXML = false );
    // ========================================================================
    GAUDI_API std::string toString( const AIDA::IHistogram1D* histo );
    // ========================================================================
    GAUDI_API std::string toString( AIDA::IHistogram1D* histo );
    // ========================================================================
    GAUDI_API std::string toString( const TH1D* histo );
    // ========================================================================
    GAUDI_API std::string toString( TH1D* histo );
    // ========================================================================
    GAUDI_API std::string toString( const TH2D* histo );
    // ========================================================================
    GAUDI_API std::string toString( TH2D* histo );
    // ========================================================================
    GAUDI_API std::string toString( const TH3D* histo );
    // ========================================================================
    GAUDI_API std::string toString( TH3D* histo );
    // ========================================================================
  } // namespace Utils
  // ==========================================================================
} //                                                     end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================