The Gaudi Framework  v33r1 (b1225454)
IHistogramSvc.h
Go to the documentation of this file.
1 /***********************************************************************************\
2 * (c) Copyright 1998-2019 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 GAUDIKERNEL_IHISTOGRAMSVC_H
12 #define GAUDIKERNEL_IHISTOGRAMSVC_H
13 
14 // Include files
15 #include "GaudiKernel/IDataProviderSvc.h"
16 #include "GaudiKernel/IService.h"
17 #include <iostream>
18 #include <string>
19 #include <vector>
20 
21 // Forward declarations
22 class DataObject;
23 
24 // added to allow use of AIDA in applications
25 // without prefix AIDA:: (as before)
26 namespace AIDA {
27  class IBaseHistogram;
28  class IHistogram;
29  class IHistogram1D;
30  class IProfile1D;
31  class IHistogram2D;
32  class IProfile2D;
33  class IHistogram3D;
34  class IHistogramFactory;
35  class IAnnotation;
36  class IAxis;
37 } // namespace AIDA
38 
39 using AIDA::IAnnotation;
40 using AIDA::IAxis;
41 using AIDA::IBaseHistogram;
42 using AIDA::IHistogram;
43 using AIDA::IHistogram1D;
44 using AIDA::IHistogram2D;
45 using AIDA::IHistogram3D;
46 using AIDA::IHistogramFactory;
47 using AIDA::IProfile1D;
48 using AIDA::IProfile2D;
49 
56 class GAUDI_API IHistogramSvc : virtual public IDataProviderSvc {
57 public:
59  DeclareInterfaceID( IHistogramSvc, 5, 0 );
60 
62  virtual AIDA::IHistogramFactory* histogramFactory() = 0;
63 
80  // ==========================================================================
81  // Book 1D histogram with fixed binning
82  // ==========================================================================
83 
84  virtual AIDA::IHistogram1D* book( const std::string& fullPath, const std::string& title, int binsX, double lowX,
85  double highX ) = 0;
86  virtual AIDA::IHistogram1D* book( const std::string& dirPath, const std::string& relPath, const std::string& title,
87  int binsX, double lowX, double highX ) = 0;
88  virtual AIDA::IHistogram1D* book( const std::string& dirPath, int hID, const std::string& title, int binsX,
89  double lowX, double highX ) = 0;
90  virtual AIDA::IHistogram1D* book( DataObject* pParent, const std::string& relPath, const std::string& title,
91  int binsX, double lowX, double highX ) = 0;
92  virtual AIDA::IHistogram1D* book( DataObject* pParent, int hID, const std::string& title, int binsX, double lowX,
93  double highX ) = 0;
94 
95  // ==========================================================================
96  // Book 1D profile histogram with fixed binning
97  // ==========================================================================
98 
99  virtual AIDA::IProfile1D* bookProf( const std::string& fullPath, const std::string& title, int binsX, double lowX,
100  double highX, const std::string& opt = "" ) = 0;
101  virtual AIDA::IProfile1D* bookProf( const std::string& dirPath, const std::string& relPath, const std::string& title,
102  int binsX, double lowX, double highX, const std::string& opt = "" ) = 0;
103  virtual AIDA::IProfile1D* bookProf( const std::string& dirPath, int hID, const std::string& title, int binsX,
104  double lowX, double highX, const std::string& opt = "" ) = 0;
105  virtual AIDA::IProfile1D* bookProf( DataObject* pParent, const std::string& relPath, const std::string& title,
106  int binsX, double lowX, double highX, const std::string& opt = "" ) = 0;
107  virtual AIDA::IProfile1D* bookProf( DataObject* pParent, int hID, const std::string& title, int binsX, double lowX,
108  double highX, const std::string& opt = "" ) = 0;
109 
110  // ==========================================================================
111  // Book 1D profile histogram with fixed binning & Y-limits
112  // ==========================================================================
113 
114  virtual AIDA::IProfile1D* bookProf( const std::string& fullPath, const std::string& title, int binsX, double lowX,
115  double highX, double lowY, double highY, const std::string& opt = "s" ) = 0;
116  virtual AIDA::IProfile1D* bookProf( const std::string& dirPath, const std::string& relPath, const std::string& title,
117  int binsX, double lowX, double highX, double lowY, double highY,
118  const std::string& opt = "s" ) = 0;
119  virtual AIDA::IProfile1D* bookProf( const std::string& dirPath, int hID, const std::string& title, int binsX,
120  double lowX, double highX, double lowY, double highY,
121  const std::string& opt = "s" ) = 0;
122  virtual AIDA::IProfile1D* bookProf( DataObject* pParent, const std::string& relPath, const std::string& title,
123  int binsX, double lowX, double highX, double lowY, double highY,
124  const std::string& opt = "s" ) = 0;
125  virtual AIDA::IProfile1D* bookProf( DataObject* pParent, int hID, const std::string& title, int binsX, double lowX,
126  double highX, double lowY, double highY, const std::string& opt = "s" ) = 0;
127 
128  // ==========================================================================
129  // Book 1D histogram with variable binning
130  // ==========================================================================
131 
132  virtual AIDA::IHistogram1D* book( const std::string& fullPath, const std::string& title,
133  std::vector<double> edges ) = 0;
134  virtual AIDA::IHistogram1D* book( const std::string& dirPath, const std::string& relPath, const std::string& title,
135  std::vector<double> edges ) = 0;
136  virtual AIDA::IHistogram1D* book( const std::string& dirPath, int hID, const std::string& title,
137  std::vector<double> edges ) = 0;
138  virtual AIDA::IHistogram1D* book( DataObject* pParent, const std::string& relPath, const std::string& title,
139  std::vector<double> edges ) = 0;
140  virtual AIDA::IHistogram1D* book( DataObject* pParent, int hID, const std::string& title,
141  std::vector<double> edges ) = 0;
142 
143  // ==========================================================================
144  // Book 1D profile histogram with variable binning
145  // ==========================================================================
146 
147  virtual AIDA::IProfile1D* bookProf( const std::string& fullPath, const std::string& title,
148  std::vector<double> edges ) = 0;
149  virtual AIDA::IProfile1D* bookProf( const std::string& dirPath, const std::string& relPath, const std::string& title,
150  std::vector<double> edges ) = 0;
151  virtual AIDA::IProfile1D* bookProf( const std::string& dirPath, int hID, const std::string& title,
152  std::vector<double> edges ) = 0;
153  virtual AIDA::IProfile1D* bookProf( DataObject* pParent, const std::string& relPath, const std::string& title,
154  std::vector<double> edges ) = 0;
155  virtual AIDA::IProfile1D* bookProf( DataObject* pParent, int hID, const std::string& title,
156  std::vector<double> edges ) = 0;
157 
158  // ==========================================================================
159  // Book 2D histogram with fixed binning
160  // ==========================================================================
161 
162  virtual AIDA::IHistogram2D* book( const std::string& fullPath, const std::string& title, int binsX, double lowX,
163  double highX, int binsY, double lowY, double highY ) = 0;
164  virtual AIDA::IHistogram2D* book( const std::string& dirPath, const std::string& relPath, const std::string& title,
165  int binsX, double lowX, double highX, int binsY, double lowY, double highY ) = 0;
166  virtual AIDA::IHistogram2D* book( const std::string& dirPath, int hID, const std::string& title, int binsX,
167  double lowX, double highX, int binsY, double lowY, double highY ) = 0;
168  virtual AIDA::IHistogram2D* book( DataObject* pParent, const std::string& relPath, const std::string& title,
169  int binsX, double lowX, double highX, int binsY, double lowY, double highY ) = 0;
170  virtual AIDA::IHistogram2D* book( DataObject* pParent, int hID, const std::string& title, int binsX, double lowX,
171  double highX, int binsY, double lowY, double highY ) = 0;
172 
173  // ==========================================================================
174  // Book 2D profile histogram with fixed binning
175  // ==========================================================================
176 
177  virtual AIDA::IProfile2D* bookProf( const std::string& fullPath, const std::string& title, int binsX, double lowX,
178  double highX, int binsY, double lowY, double highY ) = 0;
179  virtual AIDA::IProfile2D* bookProf( const std::string& dirPath, const std::string& relPath, const std::string& title,
180  int binsX, double lowX, double highX, int binsY, double lowY, double highY ) = 0;
181  virtual AIDA::IProfile2D* bookProf( const std::string& dirPath, int hID, const std::string& title, int binsX,
182  double lowX, double highX, int binsY, double lowY, double highY ) = 0;
183  virtual AIDA::IProfile2D* bookProf( DataObject* pParent, const std::string& relPath, const std::string& title,
184  int binsX, double lowX, double highX, int binsY, double lowY, double highY ) = 0;
185  virtual AIDA::IProfile2D* bookProf( DataObject* pParent, int hID, const std::string& title, int binsX, double lowX,
186  double highX, int binsY, double lowY, double highY ) = 0;
187 
188  // ==========================================================================
189  // Book 2D histogram with variable binning
190  // ==========================================================================
191 
192  virtual AIDA::IHistogram2D* book( const std::string& fullPath, const std::string& title, std::vector<double> edgesX,
193  std::vector<double> edgesY ) = 0;
194  virtual AIDA::IHistogram2D* book( const std::string& dirPath, const std::string& relPath, const std::string& title,
195  std::vector<double> edgesX, std::vector<double> edgesY ) = 0;
196  virtual AIDA::IHistogram2D* book( const std::string& dirPath, int hID, const std::string& title,
197  std::vector<double> edgesX, std::vector<double> edgesY ) = 0;
198  virtual AIDA::IHistogram2D* book( DataObject* pParent, const std::string& relPath, const std::string& title,
199  std::vector<double> edgesX, std::vector<double> edgesY ) = 0;
200  virtual AIDA::IHistogram2D* book( DataObject* pParent, int hID, const std::string& title, std::vector<double> edgesX,
201  std::vector<double> edgesY ) = 0;
202 
203  // ==========================================================================
204  // Book 2D profile histogram with variable binning
205  // ==========================================================================
206 
207  virtual AIDA::IProfile2D* bookProf( const std::string& fullPath, const std::string& title, std::vector<double> edgesX,
208  std::vector<double> edgesY ) = 0;
209  virtual AIDA::IProfile2D* bookProf( const std::string& dirPath, const std::string& relPath, const std::string& title,
210  std::vector<double> edgesX, std::vector<double> edgesY ) = 0;
211  virtual AIDA::IProfile2D* bookProf( const std::string& dirPath, int hID, const std::string& title,
212  std::vector<double> edgesX, std::vector<double> edgesY ) = 0;
213  virtual AIDA::IProfile2D* bookProf( DataObject* pParent, const std::string& relPath, const std::string& title,
214  std::vector<double> edgesX, std::vector<double> edgesY ) = 0;
215  virtual AIDA::IProfile2D* bookProf( DataObject* pParent, int hID, const std::string& title,
216  std::vector<double> edgesX, std::vector<double> edgesY ) = 0;
217 
218  // ==========================================================================
219  // Book 3D histogram with fixed binning
220  // ==========================================================================
221 
222  virtual AIDA::IHistogram3D* book( const std::string& fullPath, const std::string& title, int binsX, double lowX,
223  double highX, int binsY, double lowY, double highY, int binsZ, double lowZ,
224  double highZ ) = 0;
225  virtual AIDA::IHistogram3D* book( const std::string& dirPath, const std::string& relPath, const std::string& title,
226  int binsX, double lowX, double highX, int binsY, double lowY, double highY,
227  int binsZ, double lowZ, double highZ ) = 0;
228  virtual AIDA::IHistogram3D* book( const std::string& dirPath, int hID, const std::string& title, int binsX,
229  double lowX, double highX, int binsY, double lowY, double highY, int binsZ,
230  double lowZ, double highZ ) = 0;
231  virtual AIDA::IHistogram3D* book( DataObject* pParent, const std::string& relPath, const std::string& title,
232  int binsX, double lowX, double highX, int binsY, double lowY, double highY,
233  int binsZ, double lowZ, double highZ ) = 0;
234  virtual AIDA::IHistogram3D* book( DataObject* pParent, int hID, const std::string& title, int binsX, double lowX,
235  double highX, int binsY, double lowY, double highY, int binsZ, double lowZ,
236  double highZ ) = 0;
237 
238  // ==========================================================================
239  // Book 3D histogram with variable binning
240  // ==========================================================================
241 
242  virtual AIDA::IHistogram3D* book( const std::string& fullPath, const std::string& title, std::vector<double> edgesX,
243  std::vector<double> edgesY, std::vector<double> edgesZ ) = 0;
244  virtual AIDA::IHistogram3D* book( const std::string& dirPath, const std::string& relPath, const std::string& title,
245  std::vector<double> edgesX, std::vector<double> edgesY,
246  std::vector<double> edgesZ ) = 0;
247  virtual AIDA::IHistogram3D* book( const std::string& dirPath, int hID, const std::string& title,
248  std::vector<double> edgesX, std::vector<double> edgesY,
249  std::vector<double> edgesZ ) = 0;
250  virtual AIDA::IHistogram3D* book( DataObject* pParent, const std::string& relPath, const std::string& title,
251  std::vector<double> edgesX, std::vector<double> edgesY,
252  std::vector<double> edgesZ ) = 0;
253  virtual AIDA::IHistogram3D* book( DataObject* pParent, int hID, const std::string& title, std::vector<double> edgesX,
254  std::vector<double> edgesY, std::vector<double> edgesZ ) = 0;
255 
256  // ==========================================================================
257  // Register histogram with the data store
258  // ==========================================================================
259 
260  using IDataProviderSvc::registerObject;
261  virtual StatusCode registerObject( const std::string& fullPath, AIDA::IBaseHistogram* hObj ) = 0;
262  // ---------------------------
263  virtual StatusCode registerObject( const std::string& parentPath, const std::string& objPath,
264  AIDA::IBaseHistogram* hObj ) = 0;
265  // ---------------------------
266  StatusCode registerObject( const std::string& parentPath, int item, AIDA::IBaseHistogram* hObj ) {
267  return registerObject( parentPath, std::to_string( item ), hObj );
268  }
269  // ---------------------------
270  virtual StatusCode registerObject( DataObject* parentObj, const std::string& objPath,
271  AIDA::IBaseHistogram* hObj ) = 0;
272  virtual StatusCode registerObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
273  AIDA::IBaseHistogram* hObj ) = 0;
274  // ---------------------------
275  StatusCode registerObject( DataObject* parentObj, int item, AIDA::IBaseHistogram* hObj ) {
276  return registerObject( parentObj, std::to_string( item ), hObj );
277  }
278 
279  StatusCode registerObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IBaseHistogram* hObj ) {
280  return registerObject( parentObj, std::to_string( item ), hObj );
281  }
282 
283  // ==========================================================================
284  // Unregister histogram from the data store
285  // ==========================================================================
286 
287  using IDataProviderSvc::unregisterObject;
288  virtual StatusCode unregisterObject( AIDA::IBaseHistogram* hObj ) = 0;
289  // ---------------------------
290  virtual StatusCode unregisterObject( AIDA::IBaseHistogram* hObj, const std::string& objectPath ) = 0;
291  // ---------------------------
292  virtual StatusCode unregisterObject( AIDA::IBaseHistogram* hObj, int item ) = 0;
293 
294  // ==========================================================================
295  // Retrieve histogram from data store
296  // ==========================================================================
297 
298  using IDataProviderSvc::retrieveObject;
299  virtual StatusCode retrieveObject( IRegistry* pDirectory, const std::string& path, AIDA::IHistogram1D*& h1dObj ) = 0;
300  virtual StatusCode retrieveObject( IRegistry* pDirectory, const std::string& path, AIDA::IProfile1D*& h1dObj ) = 0;
301  virtual StatusCode retrieveObject( IRegistry* pDirectory, const std::string& path, AIDA::IHistogram2D*& h2dObj ) = 0;
302  virtual StatusCode retrieveObject( IRegistry* pDirectory, const std::string& path, AIDA::IProfile2D*& h2dObj ) = 0;
303  virtual StatusCode retrieveObject( IRegistry* pDirectory, const std::string& path, AIDA::IHistogram3D*& h3dObj ) = 0;
304  // ---------------------------
305  virtual StatusCode retrieveObject( const std::string& fullPath, AIDA::IHistogram1D*& h1dObj ) = 0;
306  virtual StatusCode retrieveObject( const std::string& fullPath, AIDA::IProfile1D*& h1dObj ) = 0;
307  virtual StatusCode retrieveObject( const std::string& fullPath, AIDA::IHistogram2D*& h2dObj ) = 0;
308  virtual StatusCode retrieveObject( const std::string& fullPath, AIDA::IProfile2D*& h2dObj ) = 0;
309  virtual StatusCode retrieveObject( const std::string& fullPath, AIDA::IHistogram3D*& h3dObj ) = 0;
310  // ---------------------------
311  virtual StatusCode retrieveObject( const std::string& parentPath, const std::string& objPath,
312  AIDA::IHistogram1D*& h1dObj ) = 0;
313  virtual StatusCode retrieveObject( const std::string& parentPath, const std::string& objPath,
314  AIDA::IProfile1D*& h1dObj ) = 0;
315  virtual StatusCode retrieveObject( const std::string& parentPath, const std::string& objPath,
316  AIDA::IHistogram2D*& h2dObj ) = 0;
317  virtual StatusCode retrieveObject( const std::string& parentPath, const std::string& objPath,
318  AIDA::IProfile2D*& h2dObj ) = 0;
319  virtual StatusCode retrieveObject( const std::string& parentPath, const std::string& objPath,
320  AIDA::IHistogram3D*& h3dObj ) = 0;
321  // ---------------------------
322  virtual StatusCode retrieveObject( const std::string& parentPath, int item, AIDA::IHistogram1D*& h1dObj ) = 0;
323  virtual StatusCode retrieveObject( const std::string& parentPath, int item, AIDA::IProfile1D*& h1dObj ) = 0;
324  virtual StatusCode retrieveObject( const std::string& parentPath, int item, AIDA::IHistogram2D*& h2dObj ) = 0;
325  virtual StatusCode retrieveObject( const std::string& parentPath, int item, AIDA::IProfile2D*& h2dObj ) = 0;
326  virtual StatusCode retrieveObject( const std::string& parentPath, int item, AIDA::IHistogram3D*& h3dObj ) = 0;
327  // ---------------------------
328  virtual StatusCode retrieveObject( DataObject* parentObj, const std::string& objPath,
329  AIDA::IHistogram1D*& h1dObj ) = 0;
330  virtual StatusCode retrieveObject( DataObject* parentObj, const std::string& objPath, AIDA::IProfile1D*& h1dObj ) = 0;
331  virtual StatusCode retrieveObject( DataObject* parentObj, const std::string& objPath,
332  AIDA::IHistogram2D*& h2dObj ) = 0;
333  virtual StatusCode retrieveObject( DataObject* parentObj, const std::string& objPath, AIDA::IProfile2D*& h2dObj ) = 0;
334  virtual StatusCode retrieveObject( DataObject* parentObj, const std::string& objPath,
335  AIDA::IHistogram3D*& h3dObj ) = 0;
336  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
337  AIDA::IHistogram1D*& h1dObj ) = 0;
338  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
339  AIDA::IProfile1D*& h1dObj ) = 0;
340  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
341  AIDA::IHistogram2D*& h2dObj ) = 0;
342  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
343  AIDA::IProfile2D*& h2dObj ) = 0;
344  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
345  AIDA::IHistogram3D*& h3dObj ) = 0;
346  // ---------------------------
347  virtual StatusCode retrieveObject( DataObject* parentObj, int item, AIDA::IHistogram1D*& h1dObj ) = 0;
348  virtual StatusCode retrieveObject( DataObject* parentObj, int item, AIDA::IProfile1D*& h1dObj ) = 0;
349  virtual StatusCode retrieveObject( DataObject* parentObj, int item, AIDA::IHistogram2D*& h2dObj ) = 0;
350  virtual StatusCode retrieveObject( DataObject* parentObj, int item, AIDA::IProfile2D*& h2dObj ) = 0;
351  virtual StatusCode retrieveObject( DataObject* parentObj, int item, AIDA::IHistogram3D*& h3dObj ) = 0;
352  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IHistogram1D*& h1dObj ) = 0;
353  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IProfile1D*& h1dObj ) = 0;
354  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IHistogram2D*& h2dObj ) = 0;
355  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IProfile2D*& h2dObj ) = 0;
356  virtual StatusCode retrieveObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IHistogram3D*& h3dObj ) = 0;
357 
358  // ==========================================================================
359  // Find histogram identified by its full path in the data store
360  // ==========================================================================
361 
362  using IDataProviderSvc::findObject;
363  virtual StatusCode findObject( const std::string& fullPath, AIDA::IHistogram1D*& h1dObj ) = 0;
364  virtual StatusCode findObject( const std::string& fullPath, AIDA::IProfile1D*& h1dObj ) = 0;
365  virtual StatusCode findObject( const std::string& fullPath, AIDA::IHistogram2D*& h2dObj ) = 0;
366  virtual StatusCode findObject( const std::string& fullPath, AIDA::IProfile2D*& h2dObj ) = 0;
367  virtual StatusCode findObject( const std::string& fullPath, AIDA::IHistogram3D*& h3dObj ) = 0;
368  // ---------------------------
369  virtual StatusCode findObject( IRegistry* pDirectory, const std::string& path, AIDA::IHistogram1D*& h1dObj ) = 0;
370  virtual StatusCode findObject( IRegistry* pDirectory, const std::string& path, AIDA::IProfile1D*& h1dObj ) = 0;
371  virtual StatusCode findObject( IRegistry* pDirectory, const std::string& path, AIDA::IHistogram2D*& h2dObj ) = 0;
372  virtual StatusCode findObject( IRegistry* pDirectory, const std::string& path, AIDA::IProfile2D*& h2dObj ) = 0;
373  virtual StatusCode findObject( IRegistry* pDirectory, const std::string& path, AIDA::IHistogram3D*& h2dObj ) = 0;
374  // ---------------------------
375  virtual StatusCode findObject( const std::string& parentPath, const std::string& objPath,
376  AIDA::IHistogram1D*& h1dObj ) = 0;
377  virtual StatusCode findObject( const std::string& parentPath, const std::string& objPath,
378  AIDA::IProfile1D*& h1dObj ) = 0;
379  virtual StatusCode findObject( const std::string& parentPath, const std::string& objPath,
380  AIDA::IHistogram2D*& h2dObj ) = 0;
381  virtual StatusCode findObject( const std::string& parentPath, const std::string& objPath,
382  AIDA::IProfile2D*& h2dObj ) = 0;
383  virtual StatusCode findObject( const std::string& parentPath, const std::string& objPath,
384  AIDA::IHistogram3D*& h3dObj ) = 0;
385  // ---------------------------
386  virtual StatusCode findObject( const std::string& parentPath, int item, AIDA::IHistogram1D*& h1dObj ) = 0;
387  virtual StatusCode findObject( const std::string& parentPath, int item, AIDA::IProfile1D*& h1dObj ) = 0;
388  virtual StatusCode findObject( const std::string& parentPath, int item, AIDA::IHistogram2D*& h2dObj ) = 0;
389  virtual StatusCode findObject( const std::string& parentPath, int item, AIDA::IProfile2D*& h2dObj ) = 0;
390  virtual StatusCode findObject( const std::string& parentPath, int item, AIDA::IHistogram3D*& h3dObj ) = 0;
391  // ---------------------------
392  virtual StatusCode findObject( DataObject* parentObj, const std::string& objPath, AIDA::IHistogram1D*& h1dObj ) = 0;
393  virtual StatusCode findObject( DataObject* parentObj, const std::string& objPath, AIDA::IProfile1D*& h1dObj ) = 0;
394  virtual StatusCode findObject( DataObject* parentObj, const std::string& objPath, AIDA::IHistogram2D*& h2dObj ) = 0;
395  virtual StatusCode findObject( DataObject* parentObj, const std::string& objPath, AIDA::IProfile2D*& h2dObj ) = 0;
396  virtual StatusCode findObject( DataObject* parentObj, const std::string& objPath, AIDA::IHistogram3D*& h3dObj ) = 0;
397  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
398  AIDA::IHistogram1D*& h1dObj ) = 0;
399  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
400  AIDA::IProfile1D*& h1dObj ) = 0;
401  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
402  AIDA::IHistogram2D*& h2dObj ) = 0;
403  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
404  AIDA::IProfile2D*& h2dObj ) = 0;
405  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, const std::string& objPath,
406  AIDA::IHistogram3D*& h3dObj ) = 0;
407  // ---------------------------
408  virtual StatusCode findObject( DataObject* parentObj, int item, AIDA::IHistogram1D*& h1dObj ) = 0;
409  virtual StatusCode findObject( DataObject* parentObj, int item, AIDA::IProfile1D*& h1dObj ) = 0;
410  virtual StatusCode findObject( DataObject* parentObj, int item, AIDA::IHistogram2D*& h2dObj ) = 0;
411  virtual StatusCode findObject( DataObject* parentObj, int item, AIDA::IProfile2D*& h2dObj ) = 0;
412  virtual StatusCode findObject( DataObject* parentObj, int item, AIDA::IHistogram3D*& h3dObj ) = 0;
413  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IHistogram1D*& h1dObj ) = 0;
414  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IProfile1D*& h1dObj ) = 0;
415  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IHistogram2D*& h2dObj ) = 0;
416  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IProfile2D*& h2dObj ) = 0;
417  virtual StatusCode findObject( AIDA::IBaseHistogram* parentObj, int item, AIDA::IHistogram3D*& h3dObj ) = 0;
418 
419  // ==========================================================================
420  // ASCII output
421  // ==========================================================================
422  // --------------------------------------------------------------------------
423  // Print functions (ASCII graphical representation)
424 
425  // Print (ASCII) the histogram into the output stream
426  virtual std::ostream& print( AIDA::IBaseHistogram* h, std::ostream& s = std::cout ) const = 0;
427 
428  // --------------------------------------------------------------------------
429  // Write functions (ASCII table containing numbers e.g. bin height)
430 
432  virtual std::ostream& write( AIDA::IBaseHistogram* h, std::ostream& s = std::cout ) const = 0;
433 
435  virtual int write( AIDA::IBaseHistogram* h, const char* file_name ) const = 0;
436 
437  // ==========================================================================
438  // Create all directories in a given full path
439  // ==========================================================================
440 
441  virtual DataObject* createPath( const std::string& newPath ) = 0;
442 
448  virtual DataObject* createDirectory( const std::string& parentDir, const std::string& subDir ) = 0;
449 };
450 
451 #endif // INTERFACES_IHISTOGRAMSVC_H
Gaudi::Histos::book
GAUDI_API AIDA::IHistogram1D * book(IHistogramSvc *svc, const std::string &path, const Gaudi::Histo1DDef &hist)
helper function to book 1D-histogram
Definition: HistoDef.cpp:97
std::to_string
T to_string(T... args)
IDataProviderSvc
Data provider interface definition.
Definition: IDataProviderSvc.h:53
AIDA
GaudiKernel.
Definition: Fill.h:20
IDataProviderSvc::findObject
virtual StatusCode findObject(IRegistry *pDirectory, std::string_view path, DataObject *&pObject)=0
Find object identified by its directory entry.
std::string
STL class.
IDataProviderSvc::unregisterObject
virtual StatusCode unregisterObject(std::string_view fullPath)=0
Unregister object from the data store.
IHistogramSvc::registerObject
StatusCode registerObject(DataObject *parentObj, int item, AIDA::IBaseHistogram *hObj)
Definition: IHistogramSvc.h:275
IDataProviderSvc.h
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:61
IHistogramSvc::registerObject
StatusCode registerObject(const std::string &parentPath, int item, AIDA::IBaseHistogram *hObj)
Definition: IHistogramSvc.h:266
IHistogramSvc::registerObject
StatusCode registerObject(AIDA::IBaseHistogram *parentObj, int item, AIDA::IBaseHistogram *hObj)
Definition: IHistogramSvc.h:279
IRegistry
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:32
IHistogramSvc
Definition of the IHistogramSvc interface class.
Definition: IHistogramSvc.h:56
IDataProviderSvc::DeclareInterfaceID
DeclareInterfaceID(IDataProviderSvc, 4, 0)
InterfaceID.
IService.h
IDataProviderSvc::retrieveObject
virtual StatusCode retrieveObject(IRegistry *pDirectory, std::string_view path, DataObject *&pObject)=0
Retrieve object identified by its directory entry.
IDataProviderSvc::registerObject
StatusCode registerObject(std::string_view fullPath, DataObject *pObject)
Register object with the data store.
Definition: IDataProviderSvc.h:72
gaudirun.s
string s
Definition: gaudirun.py:328
GaudiPython.HistoUtils.bookProf
def bookProf(*args, **kwargs)
Definition: HistoUtils.py:267
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:81
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:40
std::ostream
STL class.