The Gaudi Framework  v28r2p1 (f1a77ff4)
ConversionSvc Class Reference

Base class for all conversion services. More...

#include <GaudiKernel/ConversionSvc.h>

Inheritance diagram for ConversionSvc:
Collaboration diagram for ConversionSvc:

Classes

class  CnvTest
 
class  WorkerEntry
 

Public Member Functions

StatusCode initialize () override
 Initialize the service. More...
 
StatusCode finalize () override
 stop the service. More...
 
long repSvcType () const override
 Retrieve the class type of the data store the converter uses. More...
 
const CLIDobjType () const override
 Implementation of IConverter: dummy call. More...
 
StatusCode setDataProvider (IDataProviderSvc *pService) override
 Implementation of IConverter: Set Data provider service. More...
 
SmartIF< IDataProviderSvc > & dataProvider () const override
 Implementation of IConverter: Get Data provider service. More...
 
StatusCode setConversionSvc (IConversionSvc *svc) override
 Implementation of IConverter: Set conversion service the converter is connected to. More...
 
SmartIF< IConversionSvc > & conversionSvc () const override
 Implementation of IConverter: Get conversion service the converter is connected to. More...
 
StatusCode setAddressCreator (IAddressCreator *creator) override
 Set address creator facility. More...
 
SmartIF< IAddressCreator > & addressCreator () const override
 Retrieve address creator facility. More...
 
StatusCode createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
 Implementation of IConverter: Create the transient representation of an object. More...
 
StatusCode fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Implementation of IConverter: Resolve the references of the created transient object. More...
 
StatusCode updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
 Implementation of IConverter: Update the transient object from the other representation. More...
 
StatusCode updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Implementation of IConverter: Update the references of an updated transient object. More...
 
StatusCode createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
 Implementation of IConverter: Convert the transient object to the requested representation. More...
 
StatusCode fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Implementation of IConverter: Resolve the references of the converted object. More...
 
StatusCode updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
 Implementation of IConverter: Update the converted representation of a transient object. More...
 
StatusCode updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
 Implementation of IConverter: Update the references of an already converted object. More...
 
StatusCode addConverter (const CLID &clid) override
 Add converter object to conversion service. More...
 
StatusCode addConverter (IConverter *pConverter) override
 Add converter object to conversion service. More...
 
StatusCode removeConverter (const CLID &clid) override
 Remove converter object from conversion service (if present). More...
 
IConverterconverter (const CLID &wanted) override
 Retrieve converter from list. More...
 
StatusCode connectOutput (const std::string &outputFile, const std::string &openMode) override
 Connect the output file to the service with open mode. More...
 
StatusCode connectOutput (const std::string &output) override
 Connect the output file to the service. More...
 
StatusCode commitOutput (const std::string &output, bool do_commit) override
 Commit pending output. More...
 
StatusCode createAddress (long svc_type, const CLID &clid, const std::string *par, const unsigned long *ip, IOpaqueAddress *&refpAddress) override
 Create a Generic address using explicit arguments to identify a single object. More...
 
StatusCode convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress) override
 Convert an address to string form. More...
 
StatusCode createAddress (long svc_type, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress) override
 Convert an address in string form to object form. More...
 
virtual StatusCode updateServiceState (IOpaqueAddress *pAddress)
 Update state of the service. More...
 
 ConversionSvc (const std::string &name, ISvcLocator *svc, long type)
 Standard Constructor. More...
 
- Public Member Functions inherited from extends< Service, IConversionSvc, IAddressCreator >
void * i_cast (const InterfaceID &tid) const override
 Implementation of IInterface::i_cast. More...
 
StatusCode queryInterface (const InterfaceID &ti, void **pp) override
 Implementation of IInterface::queryInterface. More...
 
std::vector< std::stringgetInterfaceNames () const override
 Implementation of IInterface::getInterfaceNames. More...
 
 ~extends () override=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Service
const std::stringname () const override
 Retrieve name of the service. More...
 
StatusCode configure () override
 
StatusCode initialize () override
 
StatusCode start () override
 
StatusCode stop () override
 
StatusCode finalize () override
 
StatusCode terminate () override
 
Gaudi::StateMachine::State FSMState () const override
 
Gaudi::StateMachine::State targetFSMState () const override
 
StatusCode reinitialize () override
 
StatusCode restart () override
 
StatusCode sysInitialize () override
 Initialize Service. More...
 
StatusCode sysStart () override
 Initialize Service. More...
 
StatusCode sysStop () override
 Initialize Service. More...
 
StatusCode sysFinalize () override
 Finalize Service. More...
 
StatusCode sysReinitialize () override
 Re-initialize the Service. More...
 
StatusCode sysRestart () override
 Re-initialize the Service. More...
 
 Service (std::string name, ISvcLocator *svcloc)
 Standard Constructor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const override
 Retrieve pointer to service locator. More...
 
StatusCode setProperties ()
 Method for setting declared properties to the values specified for the job. More...
 
template<class T >
StatusCode service (const std::string &name, const T *&psvc, bool createIf=true) const
 Access a service by name, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode service (const std::string &name, T *&psvc, bool createIf=true) const
 
template<typename IFace = IService>
SmartIF< IFace > service (const std::string &name, bool createIf=true) const
 
template<class T >
StatusCode service (const std::string &svcType, const std::string &svcName, T *&psvc) const
 Access a service by name and type, creating it if it doesn't already exist. More...
 
template<class T >
StatusCode declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
 Declare used Private tool. More...
 
template<class T >
StatusCode declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
 Declare used Public tool. More...
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
- Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 PropertyHolder ()=default
 
 ~PropertyHolder () override=default
 
Gaudi::Details::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
 Helper to wrap a regular data member and use it as a regular property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, TYPE &value, const std::string &doc="none") const
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
 Declare a PropertyBase instance setting name and documentation. More...
 
Gaudi::Details::PropertyBasedeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
 Declare a remote property. More...
 
StatusCode setProperty (const Gaudi::Details::PropertyBase &p) override
 set the property form another property More...
 
StatusCode setProperty (const std::string &s) override
 set the property from the formatted string More...
 
StatusCode setProperty (const std::string &n, const std::string &v) override
 set the property from name and the value More...
 
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
StatusCode getProperty (Gaudi::Details::PropertyBase *p) const override
 get the property More...
 
const Gaudi::Details::PropertyBasegetProperty (const std::string &name) const override
 get the property by name More...
 
StatusCode getProperty (const std::string &n, std::string &v) const override
 convert the property to the string More...
 
const std::vector< Gaudi::Details::PropertyBase * > & getProperties () const override
 get all properties More...
 
bool hasProperty (const std::string &name) const override
 Return true if we have a property with the given name. More...
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (const PropertyHolder &)=delete
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
 Specializations for various GaudiHandles. More...
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
 
Gaudi::Details::PropertyBasedeclareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
 
- Public Member Functions inherited from CommonMessagingBase
virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MSG::Level msgLevel () const
 get the output level from the embedded MsgStream More...
 
MSG::Level outputLevel () const __attribute__((deprecated))
 Backward compatibility function for getting the output level. More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
- Public Member Functions inherited from extend_interfaces< Interfaces... >
 ~extend_interfaces () override=default
 Virtual destructor. More...
 

Protected Member Functions

virtual ~ConversionSvc ()
 Standard Destructor. More...
 
virtual IConvertercreateConverter (long typ, const CLID &clid, const ICnvFactory *fac)
 Create new Converter using factory. More...
 
virtual StatusCode configureConverter (long typ, const CLID &clid, IConverter *cnv)
 Configure the new converter before initialize is called. More...
 
virtual StatusCode initializeConverter (long typ, const CLID &clid, IConverter *cnv)
 Initialize the new converter. More...
 
virtual StatusCode activateConverter (long typ, const CLID &clid, IConverter *cnv)
 Activate the new converter after initialization. More...
 
virtual void loadConverter (DataObject *pObject)
 Load converter or dictionary needed by the converter. More...
 
virtual SmartIF< IAddressCreator > & addressCreator ()
 Retrieve address creation interface. More...
 
StatusCode makeCall (int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
 
- Protected Member Functions inherited from Service
 ~Service () override
 Standard Destructor. More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 

Protected Attributes

SmartIF< IDataProviderSvcm_dataSvc
 Pointer to data provider service. More...
 
SmartIF< IAddressCreatorm_addressCreator
 Pointer to the address creation service interface. More...
 
SmartIF< IConversionSvcm_cnvSvc
 Pointer to the IConversionSvc interface of this. More...
 
long m_type
 Conversion service type. More...
 
std::vector< WorkerEntrym_workers
 List of conversion workers. More...
 
- Protected Attributes inherited from Service
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::Property< int > m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
 
Gaudi::Property< bool > m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}
 
Gaudi::Property< bool > m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
 
Gaudi::Property< bool > m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
 
Gaudi::Property< bool > m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
 
Gaudi::Property< bool > m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
 
Gaudi::Property< bool > m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
 
Gaudi::Property< bool > m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
 
SmartIF< IAuditorSvcm_pAuditorSvc
 Auditor Service. More...
 

Private Member Functions

 ConversionSvc (const ConversionSvc &)
 Fake copy constructor (never implemented). More...
 
ConversionSvcoperator= (const ConversionSvc &)
 Fake assignment operator (never implemented). More...
 

Additional Inherited Members

- Public Types inherited from extends< Service, IConversionSvc, IAddressCreator >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from Service
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * > Factory
 
- Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using base_class = CommonMessaging
 
- Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
 take union of the ext_iids of all Interfaces... More...
 

Detailed Description

Base class for all conversion services.

It manages a set of Converters that are specialized for conversions of specific objects.

This supports self learning converters: User hooks include the following (overridable) entries:

  • findCnvFactory: returns a suitable converter factory
  • createConverter: the actual convetrer creation
  • configureConverter: configure converter before initialize
  • initializeConverter: initializes the converter
  • activateConverter: any additional configuration to be done after initialize.

configureConverter and activateConverter are user hooks, where the convetrer can be manipulated by the hosting service and knowledge can be supplied, which a "generic" converter cannot aquire itself.

These hooks allow any sub-classed conversion service to override the calls and create converters, which aquire the knowledge about their persistency type and the object type they convert during the initialization.

Only AFTER these three steps the converter must satisfy the storage type of the hosting service and the class type of the required object type.

Author
Markus Frank
Version
1.0

Definition at line 46 of file ConversionSvc.h.

Constructor & Destructor Documentation

ConversionSvc::ConversionSvc ( const std::string name,
ISvcLocator svc,
long  type 
)

Standard Constructor.

Definition at line 379 of file ConversionSvc.cpp.

380  : base_class(name, svc),
381  m_cnvSvc(static_cast<IConversionSvc*>(this))
382 {
383  m_type = type;
384  m_dataSvc = nullptr;
385  setAddressCreator(this).ignore();
386 }
extends base_class
Typedef to this class.
Definition: extends.h:14
StatusCode setAddressCreator(IAddressCreator *creator) override
Set address creator facility.
SmartIF< IDataProviderSvc > m_dataSvc
Pointer to data provider service.
SmartIF< IConversionSvc > m_cnvSvc
Pointer to the IConversionSvc interface of this.
long m_type
Conversion service type.
void ignore() const
Definition: StatusCode.h:106
ConversionSvc::~ConversionSvc ( )
protectedvirtual

Standard Destructor.

Definition at line 389 of file ConversionSvc.cpp.

389  {
390  // Release all workers.
391  for ( auto & i : m_workers ) i.converter()->release();
392 }
std::vector< WorkerEntry > m_workers
List of conversion workers.
ConversionSvc::ConversionSvc ( const ConversionSvc )
private

Fake copy constructor (never implemented).

Member Function Documentation

StatusCode ConversionSvc::activateConverter ( long  typ,
const CLID clid,
IConverter cnv 
)
protectedvirtual

Activate the new converter after initialization.

Activate the freshly created converter.

Definition at line 317 of file ConversionSvc.cpp.

319  {
320  return pConverter ? StatusCode{StatusCode::SUCCESS}
321  : NO_CONVERTER;
322 }
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
StatusCode ConversionSvc::addConverter ( const CLID clid)
override

Add converter object to conversion service.

Definition at line 209 of file ConversionSvc.cpp.

209  {
210  // First look for the more specific converter
211  long typ = repSvcType();
212  IConverter* pConverter = createConverter(typ, clid, nullptr);
213  if ( pConverter ) {
214  StatusCode status = configureConverter( typ, clid, pConverter );
215  if ( status.isSuccess() ) {
216  status = initializeConverter( typ, clid, pConverter );
217  if ( status.isSuccess() ) {
218  status = activateConverter( typ, clid, pConverter );
219  if ( status.isSuccess() ) {
220  long conv_typ = pConverter->repSvcType();
221  const CLID& conv_clid = pConverter->objType();
222  typ = (typ<0xFF) ? typ : typ&0xFFFFFF00;
223  conv_typ = (conv_typ<0xFF) ? conv_typ : conv_typ&0xFFFFFF00;
224  if ( conv_typ == typ && conv_clid == clid ) {
225  return addConverter(pConverter);
226  }
227  }
228  }
229  }
230  pConverter->release();
231  }
232  return NO_CONVERTER;
233 }
virtual StatusCode configureConverter(long typ, const CLID &clid, IConverter *cnv)
Configure the new converter before initialize is called.
The data converters are responsible to translate data from one representation into another...
Definition: IConverter.h:57
virtual const CLID & objType() const =0
Retrieve the class type of objects the converter produces.
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
virtual StatusCode initializeConverter(long typ, const CLID &clid, IConverter *cnv)
Initialize the new converter.
virtual unsigned long release()=0
Release Interface instance.
virtual long repSvcType() const =0
Retrieve the class type of the data store the converter uses.
long repSvcType() const override
Retrieve the class type of the data store the converter uses.
virtual IConverter * createConverter(long typ, const CLID &clid, const ICnvFactory *fac)
Create new Converter using factory.
StatusCode addConverter(const CLID &clid) override
Add converter object to conversion service.
virtual StatusCode activateConverter(long typ, const CLID &clid, IConverter *cnv)
Activate the new converter after initialization.
StatusCode ConversionSvc::addConverter ( IConverter pConverter)
override

Add converter object to conversion service.

Definition at line 236 of file ConversionSvc.cpp.

236  {
237  if ( pConverter ) {
238  const CLID& clid = pConverter->objType();
239  removeConverter(clid).ignore();
240  m_workers.emplace_back(clid, pConverter);
241  pConverter->addRef();
242  return StatusCode::SUCCESS;
243  }
244  return NO_CONVERTER;
245 }
virtual const CLID & objType() const =0
Retrieve the class type of objects the converter produces.
StatusCode removeConverter(const CLID &clid) override
Remove converter object from conversion service (if present).
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
void ignore() const
Definition: StatusCode.h:106
std::vector< WorkerEntry > m_workers
List of conversion workers.
SmartIF< IAddressCreator > & ConversionSvc::addressCreator ( ) const
override

Retrieve address creator facility.

Access the transient store.

Definition at line 194 of file ConversionSvc.cpp.

194  {
195  return m_addressCreator;
196 }
SmartIF< IAddressCreator > m_addressCreator
Pointer to the address creation service interface.
virtual SmartIF<IAddressCreator>& ConversionSvc::addressCreator ( )
inlineprotectedvirtual

Retrieve address creation interface.

Definition at line 210 of file ConversionSvc.h.

210  {
211  return m_addressCreator;
212  }
SmartIF< IAddressCreator > m_addressCreator
Pointer to the address creation service interface.
StatusCode ConversionSvc::commitOutput ( const std::string output,
bool  do_commit 
)
override

Commit pending output.

Definition at line 346 of file ConversionSvc.cpp.

346  {
347  return StatusCode::SUCCESS;
348 }
StatusCode ConversionSvc::configureConverter ( long  typ,
const CLID clid,
IConverter cnv 
)
protectedvirtual

Configure the new converter before initialize is called.

Configure the freshly created converter.

Definition at line 298 of file ConversionSvc.cpp.

300  {
301  if ( !pConverter ) return NO_CONVERTER;
302  pConverter->setConversionSvc(this).ignore();
303  pConverter->setAddressCreator(m_addressCreator).ignore();
304  pConverter->setDataProvider(m_dataSvc).ignore();
305  return StatusCode::SUCCESS;
306 }
SmartIF< IAddressCreator > m_addressCreator
Pointer to the address creation service interface.
SmartIF< IDataProviderSvc > m_dataSvc
Pointer to data provider service.
StatusCode ConversionSvc::connectOutput ( const std::string outputFile,
const std::string openMode 
)
override

Connect the output file to the service with open mode.

Definition at line 335 of file ConversionSvc.cpp.

336  {
337  return connectOutput(outputFile);
338 }
StatusCode connectOutput(const std::string &outputFile, const std::string &openMode) override
Connect the output file to the service with open mode.
StatusCode ConversionSvc::connectOutput ( const std::string output)
override

Connect the output file to the service.

Definition at line 341 of file ConversionSvc.cpp.

341  {
342  return StatusCode::SUCCESS;
343 }
SmartIF< IConversionSvc > & ConversionSvc::conversionSvc ( ) const
override

Implementation of IConverter: Get conversion service the converter is connected to.

Get conversion service the converter is connected to.

Definition at line 204 of file ConversionSvc.cpp.

204  {
205  return m_cnvSvc;
206 }
SmartIF< IConversionSvc > m_cnvSvc
Pointer to the IConversionSvc interface of this.
StatusCode ConversionSvc::convertAddress ( const IOpaqueAddress pAddress,
std::string refAddress 
)
override

Convert an address to string form.

Definition at line 361 of file ConversionSvc.cpp.

363 {
364  refAddress.clear();
365  return StatusCode::FAILURE;
366 }
T clear(T...args)
IConverter * ConversionSvc::converter ( const CLID wanted)
override

Retrieve converter from list.

Definition at line 143 of file ConversionSvc.cpp.

143  {
144  IConverter* cnv = nullptr;
145  auto i = std::find_if(m_workers.begin(),m_workers.end(),CnvTest(clid));
146  if ( i != m_workers.end() ) {
147  cnv = i->converter();
148  }
149  if ( !cnv ) {
150  StatusCode status = addConverter(clid);
151  if ( status.isSuccess() ) {
152  i = std::find_if(m_workers.begin(),m_workers.end(),CnvTest(clid));
153  if ( i != m_workers.end() ) {
154  cnv = i->converter();
155  }
156  }
157  }
158  return cnv;
159 }
The data converters are responsible to translate data from one representation into another...
Definition: IConverter.h:57
bool isSuccess() const
Test for a status code of SUCCESS.
Definition: StatusCode.h:74
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
T find_if(T...args)
StatusCode addConverter(const CLID &clid) override
Add converter object to conversion service.
std::vector< WorkerEntry > m_workers
List of conversion workers.
StatusCode ConversionSvc::createAddress ( long  svc_type,
const CLID clid,
const std::string par,
const unsigned long *  ip,
IOpaqueAddress *&  refpAddress 
)
override

Create a Generic address using explicit arguments to identify a single object.

Definition at line 351 of file ConversionSvc.cpp.

355  {
356  refpAddress = nullptr;
357  return StatusCode::FAILURE;
358 }
StatusCode ConversionSvc::createAddress ( long  svc_type,
const CLID clid,
const std::string refAddress,
IOpaqueAddress *&  refpAddress 
)
override

Convert an address in string form to object form.

Definition at line 369 of file ConversionSvc.cpp.

373 {
374  refpAddress = nullptr;
375  return StatusCode::FAILURE;
376 }
IConverter * ConversionSvc::createConverter ( long  typ,
const CLID clid,
const ICnvFactory *  fac 
)
protectedvirtual

Create new Converter using factory.

Reimplemented in Gaudi::RootCnvSvc.

Definition at line 286 of file ConversionSvc.cpp.

288  {
289  IConverter* pConverter = Converter::Factory::create(ConverterID(typ,clid), serviceLocator().get());
290  if ( !pConverter ) {
291  typ = (typ<0xFF) ? typ : typ&0xFFFFFF00;
292  pConverter = Converter::Factory::create(ConverterID(typ,clid), serviceLocator().get());
293  }
294  return pConverter;
295 }
The data converters are responsible to translate data from one representation into another...
Definition: IConverter.h:57
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:292
StatusCode ConversionSvc::createObj ( IOpaqueAddress pAddress,
DataObject *&  refpObject 
)
override

Implementation of IConverter: Create the transient representation of an object.

Create the transient representation of an object.

Definition at line 103 of file ConversionSvc.cpp.

103  {
104  return makeCall(CREATE_OBJ, false, true, false, pAddress, refpObj);
105 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
StatusCode ConversionSvc::createRep ( DataObject pObject,
IOpaqueAddress *&  refpAddress 
)
override

Implementation of IConverter: Convert the transient object to the requested representation.

Convert the transient object to the requested representation.

Definition at line 123 of file ConversionSvc.cpp.

123  {
124  return makeCall(CREATE_REP, true, false, false, refpAddress, pObj);
125 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
SmartIF< IDataProviderSvc > & ConversionSvc::dataProvider ( ) const
override

Implementation of IConverter: Get Data provider service.

Access the transient store.

Returns
Pointer to data provider service

Definition at line 175 of file ConversionSvc.cpp.

175  {
176  return m_dataSvc;
177 }
SmartIF< IDataProviderSvc > m_dataSvc
Pointer to data provider service.
StatusCode ConversionSvc::fillObjRefs ( IOpaqueAddress pAddress,
DataObject pObject 
)
override

Implementation of IConverter: Resolve the references of the created transient object.

Resolve the references of the created transient object.

Definition at line 108 of file ConversionSvc.cpp.

108  {
109  return makeCall(FILL_OBJ_REFS, false, true, true, pAddress, pObj);
110 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
StatusCode ConversionSvc::fillRepRefs ( IOpaqueAddress pAddress,
DataObject pObject 
)
override

Implementation of IConverter: Resolve the references of the converted object.

Resolve the references of the converted object.

Definition at line 128 of file ConversionSvc.cpp.

128  {
129  return makeCall(FILL_REP_REFS, true, false, false, pAddress, pObj);
130 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
StatusCode ConversionSvc::finalize ( )
override

stop the service.

Definition at line 268 of file ConversionSvc.cpp.

268  {
269  // Release all workers.
270  for ( auto& i : m_workers ) {
271  if ( i.converter()->finalize().isFailure() ) {
272  error() << "finalizing worker" << endmsg;
273  }
274  i.converter()->release();
275  }
276  m_workers.clear();
277  // release interfaces
278  m_addressCreator = nullptr;
279  m_dataSvc = nullptr;
280  m_cnvSvc = nullptr;
281  return Service::finalize();
282 }
StatusCode finalize() override
Definition: Service.cpp:174
SmartIF< IAddressCreator > m_addressCreator
Pointer to the address creation service interface.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
void clear(STATE_TYPE _i=std::ios_base::failbit)
Definition: MsgStream.h:222
SmartIF< IDataProviderSvc > m_dataSvc
Pointer to data provider service.
SmartIF< IConversionSvc > m_cnvSvc
Pointer to the IConversionSvc interface of this.
std::vector< WorkerEntry > m_workers
List of conversion workers.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode ConversionSvc::initialize ( )
override

Initialize the service.

Definition at line 262 of file ConversionSvc.cpp.

262  {
263  StatusCode status = Service::initialize();
264  return status;
265 }
StatusCode initialize() override
Definition: Service.cpp:64
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
StatusCode ConversionSvc::initializeConverter ( long  typ,
const CLID clid,
IConverter cnv 
)
protectedvirtual

Initialize the new converter.

Initialize new converter.

Definition at line 309 of file ConversionSvc.cpp.

311  {
312  return pConverter ? pConverter->initialize()
313  : NO_CONVERTER;
314 }
void ConversionSvc::loadConverter ( DataObject pObject)
protectedvirtual

Load converter or dictionary needed by the converter.

Reimplemented in Gaudi::RootCnvSvc.

Definition at line 94 of file ConversionSvc.cpp.

94  {
95 
96 }
StatusCode ConversionSvc::makeCall ( int  typ,
bool  ignore_add,
bool  ignore_obj,
bool  update,
IOpaqueAddress *&  pAddress,
DataObject *&  pObject 
)
protected

Definition at line 23 of file ConversionSvc.cpp.

28  {
29  if ( pAddress || ignore_add ) {
30  if ( pObject || ignore_obj ) {
31  const CLID& obj_class =
32  ( pObject && !ignore_obj) ? pObject->clID()
33  : ( pAddress && !ignore_add)
34  ? pAddress->clID()
35  : CLID_NULL;
36  IConverter* cnv = converter(obj_class);
37  if ( !cnv && pObject ) {
38  //Give it a try to autoload the class (dictionary) for which the converter is needed
39  loadConverter( pObject);
40  cnv = converter(obj_class);
41  }
42 
43  StatusCode status(StatusCode::FAILURE,true);
44  if ( cnv ) {
45  switch(typ) {
46  case CREATE_OBJ:
47  pObject = nullptr;
48  status = cnv->createObj(pAddress, pObject);
49  break;
50  case FILL_OBJ_REFS:
51  status = cnv->fillObjRefs(pAddress, pObject);
52  break;
53  case UPDATE_OBJ:
54  status = cnv->updateObj(pAddress, pObject);
55  break;
56  case UPDATE_OBJ_REFS:
57  status = cnv->updateObjRefs(pAddress, pObject);
58  break;
59  case CREATE_REP:
60  pAddress = nullptr;
61  status = cnv->createRep(pObject, pAddress);
62  break;
63  case FILL_REP_REFS:
64  status = cnv->fillRepRefs(pAddress, pObject);
65  break;
66  case UPDATE_REP:
67  status = cnv->updateRep(pAddress, pObject);
68  break;
69  case UPDATE_REP_REFS:
70  status = cnv->updateRepRefs(pAddress, pObject);
71  break;
72  default:
73  status = StatusCode::FAILURE;
74  break;
75  }
76  if ( status.isSuccess() && update ) {
77  status = updateServiceState(pAddress);
78  }
79  return status;
80  }
81  status.ignore();
82  info() << "No converter for object ";
83  if ( pObject ) {
84  msgStream() << System::typeinfoName(typeid(*pObject));
85  }
86  msgStream() << " CLID= " << obj_class << endmsg;
87  return NO_CONVERTER;
88  }
89  return INVALID_OBJECT;
90  }
91  return INVALID_ADDRESS;
92 }
The data converters are responsible to translate data from one representation into another...
Definition: IConverter.h:57
virtual const CLID & clID() const =0
Retrieve class information from link.
virtual StatusCode createObj(IOpaqueAddress *pAddress, DataObject *&refpObject)=0
Create the transient representation of an object.
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
Definition: System.cpp:299
virtual StatusCode createRep(DataObject *pObject, IOpaqueAddress *&refpAddress)=0
Convert the transient object to the requested representation.
virtual StatusCode updateRepRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the references of an already converted object.
virtual void loadConverter(DataObject *pObject)
Load converter or dictionary needed by the converter.
virtual StatusCode updateObj(IOpaqueAddress *pAddress, DataObject *refpObject)=0
Update the transient object from the other representation.
IConverter * converter(const CLID &wanted) override
Retrieve converter from list.
virtual const CLID & clID() const
Retrieve reference to class definition structure.
Definition: DataObject.cpp:68
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
virtual StatusCode updateObjRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the references of an updated transient object.
virtual StatusCode updateRep(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the converted representation of a transient object.
unsigned int CLID
Class ID definition.
Definition: ClassID.h:8
virtual StatusCode updateServiceState(IOpaqueAddress *pAddress)
Update state of the service.
virtual StatusCode fillObjRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Resolve the references of the created transient object.
MsgStream & msgStream() const
Return an uninitialized MsgStream.
virtual StatusCode fillRepRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Resolve the references of the converted object.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
const CLID & ConversionSvc::objType ( ) const
override

Implementation of IConverter: dummy call.

Retrieve the class type of objects the converter produces.

Definition at line 325 of file ConversionSvc.cpp.

325  {
326  return CLID_NULL;
327 }
ConversionSvc& ConversionSvc::operator= ( const ConversionSvc )
private

Fake assignment operator (never implemented).

StatusCode ConversionSvc::removeConverter ( const CLID clid)
override

Remove converter object from conversion service (if present).

Definition at line 248 of file ConversionSvc.cpp.

248  {
249 
251  std::not1( CnvTest{clid} ) );
252  if ( i == std::end(m_workers) ) return NO_CONVERTER;
253  std::for_each( i, std::end(m_workers), []( WorkerEntry& w ) {
254  w.converter()->finalize().ignore();
255  w.converter()->release();
256  });
257  m_workers.erase( i, std::end(m_workers) );
258  return StatusCode::SUCCESS;
259 }
T end(T...args)
T partition(T...args)
T begin(T...args)
T not1(T...args)
T for_each(T...args)
std::vector< WorkerEntry > m_workers
List of conversion workers.
long ConversionSvc::repSvcType ( ) const
override

Retrieve the class type of the data store the converter uses.

Definition at line 330 of file ConversionSvc.cpp.

330  {
331  return m_type;
332 }
long m_type
Conversion service type.
StatusCode ConversionSvc::setAddressCreator ( IAddressCreator creator)
override

Set address creator facility.

Definition at line 180 of file ConversionSvc.cpp.

180  {
181  m_addressCreator = creator;
182  for(auto& i : m_workers ) {
183  auto* cnv = i.converter();
184  if ( cnv ) {
185  if (cnv->setAddressCreator(m_addressCreator).isFailure()) {
186  error() << "setting Address Creator" << endmsg;
187  }
188  }
189  }
190  return StatusCode::SUCCESS;
191 }
SmartIF< IAddressCreator > m_addressCreator
Pointer to the address creation service interface.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
std::vector< WorkerEntry > m_workers
List of conversion workers.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode ConversionSvc::setConversionSvc ( IConversionSvc svc)
override

Implementation of IConverter: Set conversion service the converter is connected to.

Set conversion service the converter is connected to.

Definition at line 199 of file ConversionSvc.cpp.

199  {
200  return StatusCode::FAILURE;
201 }
StatusCode ConversionSvc::setDataProvider ( IDataProviderSvc pService)
override

Implementation of IConverter: Set Data provider service.

Define transient data store.

Returns
Status code indicating success or failure
Parameters
pServicePointer to data provider service

Definition at line 162 of file ConversionSvc.cpp.

162  {
163  if ( !pDataSvc ) return StatusCode::SUCCESS; //Atlas does not use DataSvc
164  m_dataSvc = pDataSvc;
165  for(auto& i : m_workers ) {
166  IConverter* cnv = i.converter();
167  if ( cnv && cnv->setDataProvider(m_dataSvc).isFailure()) {
168  error() << "setting Data Provider" << endmsg;
169  }
170  }
171  return StatusCode::SUCCESS;
172 }
The data converters are responsible to translate data from one representation into another...
Definition: IConverter.h:57
virtual StatusCode setDataProvider(IDataProviderSvc *pService)=0
Set Data provider service.
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:84
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
SmartIF< IDataProviderSvc > m_dataSvc
Pointer to data provider service.
std::vector< WorkerEntry > m_workers
List of conversion workers.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode ConversionSvc::updateObj ( IOpaqueAddress pAddress,
DataObject refpObject 
)
override

Implementation of IConverter: Update the transient object from the other representation.

Update the transient object from the other representation.

Definition at line 113 of file ConversionSvc.cpp.

113  {
114  return makeCall(UPDATE_OBJ, false, true, false, pAddress, pObj);
115 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
StatusCode ConversionSvc::updateObjRefs ( IOpaqueAddress pAddress,
DataObject pObject 
)
override

Implementation of IConverter: Update the references of an updated transient object.

Update the references of an updated transient object.

Definition at line 118 of file ConversionSvc.cpp.

118  {
119  return makeCall(UPDATE_OBJ_REFS, false, true, true, pAddress, pObj);
120 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
StatusCode ConversionSvc::updateRep ( IOpaqueAddress pAddress,
DataObject pObject 
)
override

Implementation of IConverter: Update the converted representation of a transient object.

Update the converted representation of a transient object.

Definition at line 133 of file ConversionSvc.cpp.

133  {
134  return makeCall(UPDATE_REP, true, false, false, pAddress, pObj);
135 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
StatusCode ConversionSvc::updateRepRefs ( IOpaqueAddress pAddress,
DataObject pObject 
)
override

Implementation of IConverter: Update the references of an already converted object.

Update the references of an already converted object.

Definition at line 138 of file ConversionSvc.cpp.

138  {
139  return makeCall(UPDATE_REP_REFS, true, false, false, pAddress, pObj);
140 }
StatusCode makeCall(int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress *&pAddress, DataObject *&pObject)
StatusCode ConversionSvc::updateServiceState ( IOpaqueAddress pAddress)
virtual

Update state of the service.

Reimplemented in Gaudi::RootCnvSvc.

Definition at line 98 of file ConversionSvc.cpp.

98  {
99  return StatusCode::SUCCESS;
100 }

Member Data Documentation

SmartIF<IAddressCreator> ConversionSvc::m_addressCreator
mutableprotected

Pointer to the address creation service interface.

Definition at line 225 of file ConversionSvc.h.

SmartIF<IConversionSvc> ConversionSvc::m_cnvSvc
mutableprotected

Pointer to the IConversionSvc interface of this.

Definition at line 227 of file ConversionSvc.h.

SmartIF<IDataProviderSvc> ConversionSvc::m_dataSvc
mutableprotected

Pointer to data provider service.

Definition at line 223 of file ConversionSvc.h.

long ConversionSvc::m_type
protected

Conversion service type.

Definition at line 229 of file ConversionSvc.h.

std::vector<WorkerEntry> ConversionSvc::m_workers
protected

List of conversion workers.

Definition at line 231 of file ConversionSvc.h.


The documentation for this class was generated from the following files: