The Gaudi Framework  master (37c0b60a)
Histo2String.h
Go to the documentation of this file.
1 /***********************************************************************************\
2 * (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
3 * *
4 * This software is distributed under the terms of the Apache version 2 licence, *
5 * copied verbatim in the file "LICENSE". *
6 * *
7 * In applying this licence, CERN does not waive the privileges and immunities *
8 * granted to it by virtue of its status as an Intergovernmental Organization *
9 * or submit itself to any jurisdiction. *
10 \***********************************************************************************/
11 #ifndef GAUDIUTILS_HISTO2STRING_H
12 #define GAUDIUTILS_HISTO2STRING_H 1
13 // ============================================================================
14 // Include files
15 // ============================================================================
16 // STD & STL
17 // ============================================================================
18 #include <iosfwd>
19 #include <string>
20 // ============================================================================
21 // GaudiKernel
22 // ============================================================================
23 #include <GaudiKernel/StatusCode.h>
24 // ============================================================================
25 // forward declarations
26 // ============================================================================
27 // Forward declarations
28 // ============================================================================
29 // AIDA
30 // ============================================================================
31 namespace AIDA {
32  class IHistogram1D;
33  class IHistogram2D;
34  class IHistogram3D;
35 } // namespace AIDA
36 // ============================================================================
37 // ROOT
38 // ============================================================================
39 class TH1D; // ROOT
40 class TH2D; // ROOT
41 class TH3D; // ROOT
42 class TH1F; // ROOT
43 class TH2F; // ROOT
44 class TH3F; // ROOT
45 // ============================================================================
46 namespace Gaudi {
47  // ===========================================================================
48  namespace Utils {
49  // =========================================================================
58  GAUDI_API std::ostream& toStream( const TH1D& histo, std::ostream& stream, const bool asXML = false );
59  // =========================================================================
68  GAUDI_API std::ostream& toStream( const TH2D& histo, std::ostream& stream, const bool asXML = false );
69  // =========================================================================
78  GAUDI_API std::ostream& toStream( const TH3D& histo, std::ostream& stream, const bool asXML = false );
79  // =========================================================================
88  GAUDI_API std::ostream& toStream( const TH1F& histo, std::ostream& stream, const bool asXML = false );
89  // =========================================================================
98  GAUDI_API std::ostream& toStream( const TH2F& histo, std::ostream& stream, const bool asXML = false );
99  // ========================================================================
108  GAUDI_API std::ostream& toStream( const TH3F& histo, std::ostream& stream, const bool asXML = false );
109  // ========================================================================
118  GAUDI_API std::ostream& toStream( const AIDA::IHistogram1D& histo, std::ostream& stream, const bool asXML = false );
119  // ========================================================================
128  GAUDI_API std::ostream& toStream( const AIDA::IHistogram2D& histo, std::ostream& stream, const bool asXML = false );
129  // ========================================================================
138  GAUDI_API std::ostream& toStream( const AIDA::IHistogram3D& histo, std::ostream& stream, const bool asXML = false );
139  // ========================================================================
147  GAUDI_API std::string toString( const TH1D& histo, const bool asXML = false );
148  // ========================================================================
156  GAUDI_API std::string toString( const TH2D& histo, const bool asXML = false );
157  // ========================================================================
165  GAUDI_API std::string toString( const TH3D& histo, const bool asXML = false );
166  // ========================================================================
174  GAUDI_API std::string toString( const TH1F& histo, const bool asXML = false );
175  // ========================================================================
183  GAUDI_API std::string toString( const TH2F& histo, const bool asXML = false );
184  // ========================================================================
192  GAUDI_API std::string toString( const TH3F& histo, const bool asXML = false );
193  // ========================================================================
201  GAUDI_API std::string toString( const AIDA::IHistogram1D& histo, const bool asXML = false );
202  // ========================================================================
210  GAUDI_API std::string toString( const AIDA::IHistogram2D& histo, const bool asXML = false );
211  // ========================================================================
219  GAUDI_API std::string toString( const AIDA::IHistogram3D& histo, const bool asXML = false );
220  // ========================================================================
228  GAUDI_API std::string toString( const AIDA::IHistogram1D* histo );
229  // ========================================================================
237  GAUDI_API std::string toString( AIDA::IHistogram1D* histo );
238  // ========================================================================
246  GAUDI_API std::string toString( const TH1D* histo );
247  // ========================================================================
255  GAUDI_API std::string toString( TH1D* histo );
256  // ========================================================================
264  GAUDI_API std::string toString( const TH2D* histo );
265  // ========================================================================
273  GAUDI_API std::string toString( TH2D* histo );
274  // ========================================================================
282  GAUDI_API std::string toString( const TH3D* histo );
283  // ========================================================================
291  GAUDI_API std::string toString( TH3D* histo );
292  // ========================================================================
293  } // namespace Utils
294  // ==========================================================================
295 } // end of namespace Gaudi
296 // ============================================================================
297 // The END
298 // ============================================================================
299 #endif // GAUDIUTILS_HISTO2STRING_H
AIDA
GaudiKernel.
Definition: Annotation.h:22
Write.stream
stream
Definition: Write.py:32
std::string
STL class.
StatusCode.h
std::ostream
STL class.
Gaudi
This file provides a Grammar for the type Gaudi::Accumulators::Axis It allows to use that type from p...
Definition: __init__.py:1
Gaudi::Utils::toString
std::string toString(const TYPE &obj)
the generic implementation of the type conversion to the string
Definition: ToStream.h:353
Gaudi::Utils::toStream
std::ostream & toStream(ITERATOR first, ITERATOR last, std::ostream &s, const std::string &open, const std::string &close, const std::string &delim)
the helper function to print the sequence
Definition: ToStream.h:299
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:81