| The Gaudi Framework v30r0 (c919700c)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

PersistencySvc.h
Go to the documentation of this file.
1 // ============================================================
2 //
3 // PersistencySvc.h
4 // ------------------------------------------------------------
5 //
6 // Package : PersistencySvc
7 //
8 // Author : Markus Frank
9 //
10 // ===========================================================
11 #ifndef PERSISTENCYSVC_PERSISTENCYSVC_H
12 #define PERSISTENCYSVC_PERSISTENCYSVC_H 1
13
14 // Framework include files
15 #include "GaudiKernel/IAddressCreator.h"
16 #include "GaudiKernel/IConversionSvc.h"
17 #include "GaudiKernel/IDataProviderSvc.h"
18 #include "GaudiKernel/IPersistencySvc.h"
19 #include "GaudiKernel/Service.h"
20
21 // STL include files
22 #include <algorithm>
23 #include <functional>
24 #include <map>
25
50 class PersistencySvc : public extends<Service, IConversionSvc, IPersistencySvc, IAddressCreator>
51 {
52 protected:
53 class ServiceEntry final
54 {
55 long m_serviceType;
56 mutable SmartIF<IService> m_service;
57 mutable SmartIF<IConversionSvc> m_cnvService;
58 mutable SmartIF<IAddressCreator> m_addrCreator;
59
60 public:
61 ServiceEntry( long type, SmartIF<IService> svc, SmartIF<IConversionSvc> cnv, SmartIF<IAddressCreator> cr )
62 : m_serviceType( type )
63 , m_service( std::move( svc ) )
64 , m_cnvService( std::move( cnv ) )
65 , m_addrCreator( std::move( cr ) )
66 {
67 }
68 ServiceEntry( long type, IService* svc, IConversionSvc* cnv, IAddressCreator* cr )
69 {
70 m_serviceType = type;
71 m_addrCreator = cr;
72 m_cnvService = cnv;
73 m_service = svc;
74 }
75 ServiceEntry( const ServiceEntry& ) = default;
76
77 SmartIF<IService>& service() const { return m_service; }
78 SmartIF<IConversionSvc>& conversionSvc() const { return m_cnvService; }
79 SmartIF<IAddressCreator>& addrCreator() const { return m_addrCreator; }
80 long svcType() const { return m_serviceType; }
81 };
82 typedef std::map<long, ServiceEntry> Services;
83 /*
84 class SvcTest final {
85 public:
86 SvcTest(long test) : m_test(test) {
87 }
88 bool operator()( const ServiceEntry& testee ) const {
89 return m_test == testee.svcType();
90 }
91 private:
92 long m_test;
93 };
94 */
95 public:
98 long repSvcType() const override;
100
102 const CLID& objType() const override;
103
105 StatusCode createObj( IOpaqueAddress* pAddress, DataObject*& refpObject ) override;
106
108 StatusCode fillObjRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;
109
111 StatusCode updateObj( IOpaqueAddress* pAddress, DataObject* refpObject ) override;
112
114 StatusCode updateObjRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;
115
117 StatusCode createRep( DataObject* pObject, IOpaqueAddress*& refpAddress ) override;
118
120 StatusCode fillRepRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;
121
123 StatusCode updateRep( IOpaqueAddress* pAddress, DataObject* pObject ) override;
124
126 StatusCode updateRepRefs( IOpaqueAddress* pAddress, DataObject* pObject ) override;
127
129 StatusCode setDataProvider( IDataProviderSvc* pStore ) override;
130
132 SmartIF<IDataProviderSvc>& dataProvider() const override;
133
135 StatusCode setConversionSvc( IConversionSvc* svc ) override;
136
138 SmartIF<IConversionSvc>& conversionSvc() const override;
139
141 StatusCode setAddressCreator( IAddressCreator* creator ) override;
142
144 SmartIF<IAddressCreator>& addressCreator() const override;
145
147 StatusCode addConverter( IConverter* pConverter ) override;
148
150 StatusCode addConverter( const CLID& clid ) override;
151
153 IConverter* converter( const CLID& clid ) override;
154
156 StatusCode removeConverter( const CLID& clid ) override;
157
159 StatusCode connectOutput( const std::string& outputFile, const std::string& openMode ) override;
161 StatusCode connectOutput( const std::string& outputFile ) override;
162
164 StatusCode commitOutput( const std::string& output, bool do_commit ) override;
165
167 StatusCode createAddress( long svc_type, const CLID& clid, const std::string* pars, const unsigned long* ipars,
168 IOpaqueAddress*& refpAddress ) override;
169
171 StatusCode convertAddress( const IOpaqueAddress* pAddress, std::string& refAddress ) override;
172
174 StatusCode createAddress( long svc_type, const CLID& clid, const std::string& refAddress,
175 IOpaqueAddress*& refpAddress ) override;
177
180 StatusCode addCnvService( IConversionSvc* service ) override;
182
184 StatusCode removeCnvService( long type ) override;
185
187 StatusCode setDefaultCnvService( long type ) override;
188
190 StatusCode getService( long service_type, IConversionSvc*& refpSvc ) override;
191
193 StatusCode getService( const std::string& service_type, IConversionSvc*& refpSvc ) override;
195
198 StatusCode initialize() override;
200
202 StatusCode finalize() override;
204
207 PersistencySvc( const std::string& name, ISvcLocator* svc );
209
211 ~PersistencySvc() override = default;
212
213 protected:
215 SmartIF<IConversionSvc>& service( const std::string& nam );
216
218 SmartIF<IConversionSvc>& service( long service_type );
219
221 SmartIF<IAddressCreator>& addressCreator( long service_type );
222
224 void encodeAddrHdr( long service_type, const CLID& clid, std::string& address ) const;
225
227 void decodeAddrHdr( const std::string& address, long& service_type, CLID& clid, std::string& address_trailer ) const;
228
230 StatusCode makeCall( int typ, IOpaqueAddress*& pAddress, DataObject*& pObject );
231
233 bool enable( bool value );
235
237 void svcNamesHandler( Gaudi::Details::PropertyBase& theProp );
238
240 long m_cnvDefType = TEST_StorageType;
242 mutable SmartIF<IDataProviderSvc> m_dataSvc;
244 Services m_cnvServices;
246 mutable SmartIF<IConversionSvc> m_cnvDefault;
247
248 Gaudi::Property<std::vector<std::string>> m_svcNames{
249 this, "CnvServices", {}, "Names of services to be requested from the service locator and added by default"};
250
252 bool m_enable = true;
253
255 mutable SmartIF<IAddressCreator> m_addrCreator;
256 };
257 #endif // PERSISTENCYSVC_PERSISTENCYSVC_H
PersistencySvc::m_addrCreator
SmartIF< IAddressCreator > m_addrCreator
Pointer to the IAddressCreator interface of this, for addressCreator().
Definition: PersistencySvc.h:255
PersistencySvc::ServiceEntry::svcType
long svcType() const
Definition: PersistencySvc.h:80
TEST_StorageType
const long TEST_StorageType
Definition: ClassID.h:49
PersistencySvc::ServiceEntry::conversionSvc
SmartIF< IConversionSvc > & conversionSvc() const
Definition: PersistencySvc.h:78
PersistencySvc::addressCreator
SmartIF< IAddressCreator > & addressCreator() const override
Retrieve address creator facility.
Definition: PersistencySvc.cpp:438
SmartIF< IService >
PersistencySvc::ServiceEntry::addrCreator
SmartIF< IAddressCreator > & addrCreator() const
Definition: PersistencySvc.h:79
ISvcLocator
The ISvcLocator is the interface implemented by the Service Factory in the Application Manager to loc...
Definition: ISvcLocator.h:25
IConverter
The data converters are responsible to translate data from one representation into another...
Definition: IConverter.h:58
Service::name
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:289
PersistencySvc::m_cnvDefType
long m_cnvDefType
Default service type.
Definition: PersistencySvc.h:240
PersistencySvc::initialize
StatusCode initialize() override
Initialize the service.
Definition: PersistencySvc.cpp:525
IConversionSvc
Definition: IConversionSvc.h:37
Gaudi::Property
Implementation of property with value of concrete type.
Definition: Property.h:319
PersistencySvc::connectOutput
StatusCode connectOutput(const std::string &outputFile, const std::string &openMode) override
Connect the output file to the service with open mode.
Definition: PersistencySvc.cpp:312
PersistencySvc::ServiceEntry
Definition: PersistencySvc.h:53
gaudirun.output
output
Definition: gaudirun.py:404
PersistencySvc::m_svcNames
Gaudi::Property< std::vector< std::string > > m_svcNames
Definition: PersistencySvc.h:248
PersistencySvc::ServiceEntry::service
SmartIF< IService > & service() const
Definition: PersistencySvc.h:77
IAddressCreator
IAddressCreator interface definition.
Definition: IAddressCreator.h:28
PersistencySvc::m_enable
bool m_enable
Flag to indicate that the service is enabled.
Definition: PersistencySvc.h:252
PersistencySvc::setConversionSvc
StatusCode setConversionSvc(IConversionSvc *svc) override
Set conversion service the converter is connected to.
Definition: PersistencySvc.cpp:190
std
STL namespace.
PersistencySvc::makeCall
StatusCode makeCall(int typ, IOpaqueAddress *&pAddress, DataObject *&pObject)
Implementation helper.
Definition: PersistencySvc.cpp:56
PersistencySvc::ServiceEntry::m_service
SmartIF< IService > m_service
Definition: PersistencySvc.h:56
IDataProviderSvc
Data provider interface definition.
Definition: IDataProviderSvc.h:46
PersistencySvc::removeConverter
StatusCode removeConverter(const CLID &clid) override
Remove converter object from conversion service (if present).
Definition: PersistencySvc.cpp:211
PersistencySvc::PersistencySvc
PersistencySvc(const std::string &name, ISvcLocator *svc)
Standard Constructor.
Definition: PersistencySvc.cpp:556
std::map< long, ServiceEntry >
PersistencySvc::updateRep
StatusCode updateRep(IOpaqueAddress *pAddress, DataObject *pObject) override
Implementation of IConverter: Update the converted representation of a transient object.
Definition: PersistencySvc.cpp:148
PersistencySvc::updateObjRefs
StatusCode updateObjRefs(IOpaqueAddress *pAddress, DataObject *pObject) override
Implementation of IConverter: Update the references of an updated transient object.
Definition: PersistencySvc.cpp:130
PersistencySvc::addConverter
StatusCode addConverter(IConverter *pConverter) override
Add converter object to conversion service.
Definition: PersistencySvc.cpp:203
PersistencySvc::convertAddress
StatusCode convertAddress(const IOpaqueAddress *pAddress, std::string &refAddress) override
Convert an address to string form.
Definition: PersistencySvc.cpp:333
std::string
STL class.
PersistencySvc::fillObjRefs
StatusCode fillObjRefs(IOpaqueAddress *pAddress, DataObject *pObject) override
Implementation of IConverter: Resolve the references of the created transient object.
Definition: PersistencySvc.cpp:118
IPersistencySvc.h
Service.h
PersistencySvc::enable
bool enable(bool value)
Set enabled flag.
Definition: PersistencySvc.cpp:549
PersistencySvc::setDataProvider
StatusCode setDataProvider(IDataProviderSvc *pStore) override
Define transient datastore.
Definition: PersistencySvc.cpp:177
IDataProviderSvc.h
PersistencySvc::encodeAddrHdr
void encodeAddrHdr(long service_type, const CLID &clid, std::string &address) const
Retrieve string from storage type and clid.
Definition: PersistencySvc.cpp:375
IService
General service interface definition.
Definition: IService.h:18
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
gaudirun.type
type
Definition: gaudirun.py:133
PersistencySvc::createRep
StatusCode createRep(DataObject *pObject, IOpaqueAddress *&refpAddress) override
Implementation of IConverter: Convert the transient object to the requested representation.
Definition: PersistencySvc.cpp:136
PersistencySvc::finalize
StatusCode finalize() override
stop the service.
Definition: PersistencySvc.cpp:537
PersistencySvc::getService
StatusCode getService(long service_type, IConversionSvc *&refpSvc) override
Retrieve conversion service identified by technology.
Definition: PersistencySvc.cpp:441
PersistencySvc::ServiceEntry::ServiceEntry
ServiceEntry(long type, IService *svc, IConversionSvc *cnv, IAddressCreator *cr)
Definition: PersistencySvc.h:68
PersistencySvc::ServiceEntry::ServiceEntry
ServiceEntry(long type, SmartIF< IService > svc, SmartIF< IConversionSvc > cnv, SmartIF< IAddressCreator > cr)
Definition: PersistencySvc.h:61
PersistencySvc::m_cnvDefault
SmartIF< IConversionSvc > m_cnvDefault
Default output service.
Definition: PersistencySvc.h:246
PersistencySvc::commitOutput
StatusCode commitOutput(const std::string &output, bool do_commit) override
Commit pending output.
Definition: PersistencySvc.cpp:321
PersistencySvc
PersistencySvc class implementation definition.
Definition: PersistencySvc.h:50
PersistencySvc::fillRepRefs
StatusCode fillRepRefs(IOpaqueAddress *pAddress, DataObject *pObject) override
Implementation of IConverter: Resolve the references of the converted object.
Definition: PersistencySvc.cpp:142
Gaudi::Details::PropertyBase
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
PersistencySvc::dataProvider
SmartIF< IDataProviderSvc > & dataProvider() const override
Access reference to transient datastore.
Definition: PersistencySvc.cpp:187
PersistencySvc::ServiceEntry::m_cnvService
SmartIF< IConversionSvc > m_cnvService
Definition: PersistencySvc.h:57
CLID
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
PersistencySvc::addCnvService
StatusCode addCnvService(IConversionSvc *service) override
Add a new Service.
Definition: PersistencySvc.cpp:259
PersistencySvc::removeCnvService
StatusCode removeCnvService(long type) override
Remove a Service.
Definition: PersistencySvc.cpp:291
PersistencySvc::updateObj
StatusCode updateObj(IOpaqueAddress *pAddress, DataObject *refpObject) override
Implementation of IConverter: Update the transient object from the other representation.
Definition: PersistencySvc.cpp:124
PersistencySvc::~PersistencySvc
~PersistencySvc() override=default
Standard Destructor.
PersistencySvc::createAddress
StatusCode createAddress(long svc_type, const CLID &clid, const std::string *pars, const unsigned long *ipars, IOpaqueAddress *&refpAddress) override
Create a Generic address using explicit arguments to identify a single object.
Definition: PersistencySvc.cpp:324
PersistencySvc::Services
std::map< long, ServiceEntry > Services
Definition: PersistencySvc.h:82
PersistencySvc::svcNamesHandler
void svcNamesHandler(Gaudi::Details::PropertyBase &theProp)
Handlers for Service Names Property.
Definition: PersistencySvc.cpp:546
PersistencySvc::ServiceEntry::m_serviceType
long m_serviceType
Definition: PersistencySvc.h:55
IAddressCreator.h
IConversionSvc.h
extends
Base class used to extend a class implementing other interfaces.
Definition: extends.h:10
PersistencySvc::createObj
StatusCode createObj(IOpaqueAddress *pAddress, DataObject *&refpObject) override
Implementation of IConverter: Create the transient representation of an object.
Definition: PersistencySvc.cpp:112
PersistencySvc::m_cnvServices
Services m_cnvServices
List of convermsion workers.
Definition: PersistencySvc.h:244
PersistencySvc::setAddressCreator
StatusCode setAddressCreator(IAddressCreator *creator) override
Set address creator facility.
Definition: PersistencySvc.cpp:428
PersistencySvc::decodeAddrHdr
void decodeAddrHdr(const std::string &address, long &service_type, CLID &clid, std::string &address_trailer) const
Retrieve storage type and clid from address header of string.
Definition: PersistencySvc.cpp:386
PersistencySvc::ServiceEntry::m_addrCreator
SmartIF< IAddressCreator > m_addrCreator
Definition: PersistencySvc.h:58
IOpaqueAddress
Opaque address interface definition.
Definition: IOpaqueAddress.h:23
PersistencySvc::setDefaultCnvService
StatusCode setDefaultCnvService(long type) override
Set default service type.
Definition: PersistencySvc.cpp:305
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
PersistencySvc::objType
const CLID & objType() const override
Retrieve the class type of objects the converter produces. (DUMMY)
Definition: PersistencySvc.cpp:522
PersistencySvc::updateRepRefs
StatusCode updateRepRefs(IOpaqueAddress *pAddress, DataObject *pObject) override
Implementation of IConverter: Update the references of an already converted object.
Definition: PersistencySvc.cpp:154
PersistencySvc::repSvcType
long repSvcType() const override
Return default service type.
Definition: PersistencySvc.cpp:302
PersistencySvc::m_dataSvc
SmartIF< IDataProviderSvc > m_dataSvc
Pointer to datma provider service.
Definition: PersistencySvc.h:242
PersistencySvc::converter
IConverter * converter(const CLID &clid) override
Retrieve converter from list.
Definition: PersistencySvc.cpp:223