| The Gaudi Framework v32r1 (f65d50dc)

IAIDATupleSvc.h
Go to the documentation of this file.
1 #ifndef GAUDIKERNEL_IAIDATUPLESVC_H
2 #define GAUDIKERNEL_IAIDATUPLESVC_H 1
3
4 // Include files:
5 #include "GaudiKernel/IDataProviderSvc.h"
6
7 // Forward declarations:
8 class DataObject;
9
10 // Added to allow use of AIDA in applications
11 // without prefix AIDA:: (as before):
12 namespace AIDA {
13 class ITuple;
14 class IAnnotation;
15 } // namespace AIDA
16
17 using AIDA::IAnnotation;
18 using AIDA::ITuple;
19
28 class GAUDI_API IAIDATupleSvc : virtual public IDataProviderSvc {
29
30 public:
32 DeclareInterfaceID( IAIDATupleSvc, 3, 0 );
33
34 // ===================================
35 // Book a tuple in the transient store
36 // ===================================
37 virtual AIDA::ITuple* book( const std::string& fullPath, const std::string& title, const std::string& columns ) = 0;
38
39 // =======================================
40 // Register a tuple in the transient store
41 // =======================================
42 using IDataProviderSvc::registerObject;
43
44 virtual StatusCode registerObject( const std::string& dirPath, const std::string& objPath, AIDA::ITuple* tObj ) = 0;
45
46 virtual StatusCode registerObject( DataObject* pParent, const std::string& objPath, AIDA::ITuple* tObj ) = 0;
47
48 // =========================================
49 // Unregister a tuple in the transient store
50 // =========================================
51 using IDataProviderSvc::unregisterObject;
52
53 virtual StatusCode unregisterObject( AIDA::ITuple* tObj ) = 0;
54
55 virtual StatusCode unregisterObject( AIDA::ITuple* tObj, const std::string& objectPath ) = 0;
56
57 // ====================================
58 // Retrieve a tuple from the data store
59 // ====================================
60 using IDataProviderSvc::retrieveObject;
61
62 virtual StatusCode retrieveObject( const std::string& fullPath, AIDA::ITuple*& tObj ) = 0;
63
64 virtual StatusCode retrieveObject( const std::string& parentPath, const std::string& objPath,
65 AIDA::ITuple*& tObj ) = 0;
66
67 virtual StatusCode retrieveObject( DataObject* parentObj, const std::string& objPath, AIDA::ITuple*& tObj ) = 0;
68
69 // ==============================
70 // Find a tuple in the data store
71 // ==============================
72 using IDataProviderSvc::findObject;
73
74 virtual StatusCode findObject( const std::string& fullPath, AIDA::ITuple*& tObj ) = 0;
75
76 virtual StatusCode findObject( IRegistry* pDirectory, const std::string& path, AIDA::ITuple*& tObj ) = 0;
77
78 virtual StatusCode findObject( const std::string& parentPath, const std::string& objPath, AIDA::ITuple*& tObj ) = 0;
79
80 virtual StatusCode findObject( DataObject* parentObj, const std::string& objPath, AIDA::ITuple*& tObj ) = 0;
81
83 virtual void setCriteria( AIDA::ITuple*& tObj, const std::string& criteria ) = 0;
84
85 // ==============
86 // Helper methods
87 // ==============
88
89 // Create all directories in a given full path
90 virtual DataObject* createPath( const std::string& newPath ) = 0;
91
92 // Create a sub-directory in a directory.
93 virtual DataObject* createDirectory( const std::string& parentDir, const std::string& subDir ) = 0;
94
95 virtual StatusCode myTest() = 0;
96 };
97
98 #endif // GAUDIKERNEL_IAIDATUPLESVC_H
GaudiPython.HistoUtils.path
path
Definition: HistoUtils.py:932
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:87
IDataProviderSvc
Data provider interface definition.
Definition: IDataProviderSvc.h:43
AIDA
GaudiKernel.
Definition: Fill.h:10
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.
IDataProviderSvc.h
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
IRegistry
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
IDataProviderSvc::DeclareInterfaceID
DeclareInterfaceID(IDataProviderSvc, 4, 0)
InterfaceID.
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:62
IAIDATupleSvc
Definition of the IAIDATupleSvc interface class.
Definition: IAIDATupleSvc.h:28
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:71
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30