Converter Class Reference

Converter base class. More...

#include <GaudiKernel/Converter.h>

Inheritance diagram for Converter:

Collaboration diagram for Converter:

Public Types
using	Factory = Gaudi::PluginService::Factory< IConverter *(ISvcLocator *)>
Public Types inherited from implements< IConverter >
using	base_class = implements< Interfaces... >
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
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...

Public Member Functions
StatusCode	initialize () override
	Initialize the converter. More...
StatusCode	finalize () override
	Initialize the converter. More...
StatusCode	setDataProvider (IDataProviderSvc *svc) override
	Set Data provider service. More...
SmartIF< IDataProviderSvc > &	dataProvider () const override
	Get Data provider service. More...
StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to. More...
SmartIF< IConversionSvc > &	conversionSvc () const override
	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...
const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. More...
virtual long	i_repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
	Create the transient representation of an object. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the created transient object. More...
StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
	Update the transient object from the other representation. More...
StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an updated transient object. More...
StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
	Convert the transient object to the requested representation. More...
StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the converted object. More...
StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the converted representation of a transient object. More...
StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an already converted object. More...
	Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
	Standard Constructor. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&psvc) const
	Access a service by name, type creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true) const
	Return a pointer to the service identified by name (or "type/name") More...
Public Member Functions inherited from implements< IConverter >
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::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...

Protected Member Functions
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...
SmartIF< IMessageSvc > &	msgSvc () const
	Retrieve pointer to message service. More...
SmartIF< IDataManagerSvc > &	dataManager () const
	Get Data Manager service. More...

Private Member Functions
StatusCode	service_i (const std::string &svcName, bool createIf, const InterfaceID &iid, void **ppSvc) const
	implementation of service method More...
StatusCode	service_i (const std::string &svcType, const std::string &svcName, const InterfaceID &iid, void **ppSvc) const

Private Attributes
long	m_storageType
	Storage type. More...
const CLID	m_classType
	Class type the converter can handle. More...
SmartIF< IAddressCreator >	m_addressCreator
	Pointer to the address creation service interface. More...
SmartIF< IDataProviderSvc >	m_dataProvider
	Pointer to data provider service. More...
SmartIF< IDataManagerSvc >	m_dataManager
	Pointer to data manager service. More...
SmartIF< IConversionSvc >	m_conversionSvc
	Pointer to the connected conversion service. More...
SmartIF< ISvcLocator >	m_svcLocator
	Service Locator reference. More...
SmartIF< IMessageSvc >	m_messageSvc
	MessageSvc reference. More...

Additional Inherited Members
Protected Attributes inherited from implements< IConverter >
std::atomic_ulong	m_refCount
	Reference counter. More...

Detailed Description

Converter base class.

See interface for detailed description, arguments and return values

Author

Markus Frank

Version

1.0

Definition at line 24 of file Converter.h.

Member Typedef Documentation

using Converter::Factory = Gaudi::PluginService::Factory<IConverter*( ISvcLocator* )>

Definition at line 26 of file Converter.h.

Constructor & Destructor Documentation

Converter::Converter	(	long	storage_type,
		const CLID &	class_type,
		ISvcLocator *	svc = 0
	)

Standard Constructor.

Definition at line 104 of file Converter.cpp.

    : m_storageType( storage_type ), m_classType( class_type ), m_svcLocator( svc ) {}

Member Function Documentation

SmartIF< IAddressCreator > & Converter::addressCreator ( ) const

override

Retrieve address creator facility.

Access the transient store.

Definition at line 89 of file Converter.cpp.

{ return m_addressCreator; }

SmartIF< IConversionSvc > & Converter::conversionSvc ( ) const

override

Get conversion service the converter is connected to.

Get data conversion service the converter is connected to.

Definition at line 80 of file Converter.cpp.

{ return m_conversionSvc; }

StatusCode Converter::createObj ( IOpaqueAddress *  pAddress, DataObject *&  refpObject  )

override

Create the transient representation of an object.

Definition at line 19 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

StatusCode Converter::createRep ( DataObject *  pObject, IOpaqueAddress *&  refpAddress  )

override

Convert the transient object to the requested representation.

Definition at line 31 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

SmartIF< IDataManagerSvc > & Converter::dataManager ( ) const

protected

Get Data Manager service.

Get data manager service.

Definition at line 71 of file Converter.cpp.

{ return m_dataManager; }

SmartIF< IDataProviderSvc > & Converter::dataProvider ( ) const

override

Get Data provider service.

Get data provider service.

Definition at line 68 of file Converter.cpp.

{ return m_dataProvider; }

StatusCode Converter::fillObjRefs ( IOpaqueAddress *  pAddress, DataObject *  pObject  )

override

Resolve the references of the created transient object.

Definition at line 22 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

StatusCode Converter::fillRepRefs ( IOpaqueAddress *  pAddress, DataObject *  pObject  )

override

Resolve the references of the converted object.

Definition at line 34 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

StatusCode Converter::finalize ( )

override

Initialize the converter.

Finalize the converter.

Definition at line 50 of file Converter.cpp.

                               {
  // release services
  m_messageSvc     = nullptr;
  m_dataManager    = nullptr;
  m_dataProvider   = nullptr;
  m_conversionSvc  = nullptr;
  m_addressCreator = nullptr;
  return StatusCode::SUCCESS;
}

long Converter::i_repSvcType ( ) const

virtual

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

Definition at line 16 of file Converter.cpp.

{ return m_storageType; }

StatusCode Converter::initialize ( )

override

Initialize the converter.

Definition at line 43 of file Converter.cpp.

                                 {
  // Get a reference to the Message Service
  if ( !msgSvc() ) { return StatusCode::FAILURE; }
  return StatusCode::SUCCESS;
}

SmartIF< IMessageSvc > & Converter::msgSvc ( ) const

protected

Retrieve pointer to message service.

— Retrieve pointer to message service

Definition at line 95 of file Converter.cpp.

                                              {
  if ( !m_messageSvc ) {
    m_messageSvc = serviceLocator();
    if ( !m_messageSvc ) { throw GaudiException( "Service [MessageSvc] not found", "Converter", StatusCode::FAILURE ); }
  }
  return m_messageSvc;
}

const CLID & Converter::objType ( ) const

override

Retrieve the class type of objects the converter produces.

Definition at line 13 of file Converter.cpp.

{ return m_classType; }

template<class T >

StatusCode Converter::service ( const std::string &  name, T *&  psvc, bool  createIf = false  ) const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 88 of file Converter.h.

                                                                                     {
    return service_i( name, createIf, T::interfaceID(), (void**)&psvc );
  }

template<class T >

StatusCode Converter::service ( const std::string &  type, const std::string &  name, T *&  psvc  ) const

inline

Access a service by name, type creating it if it doesn't already exist.

Definition at line 94 of file Converter.h.

                                                                                     {
    return service_i( type, name, T::interfaceID(), reinterpret_cast<void**>( &psvc ) );
  }

SmartIF< IService > Converter::service	(	const std::string &	name,
		const bool	createIf = true
	)		const

Return a pointer to the service identified by name (or "type/name")

Definition at line 129 of file Converter.cpp.

                                                                                       {
  SmartIF<INamedInterface> cnvsvc( conversionSvc() );
  SmartIF<IService>        svc;
  if ( cnvsvc ) {
    const ServiceLocatorHelper helper( *serviceLocator(), "Converter", cnvsvc->name() );
    svc = helper.service( name, false, createIf );
  }
  return svc;
}

StatusCode Converter::service_i ( const std::string &  svcName, bool  createIf, const InterfaceID &  iid, void **  ppSvc  ) const

private

implementation of service method

Definition at line 107 of file Converter.cpp.

                                                      {
  // Check for name of conversion service
  SmartIF<INamedInterface> cnvsvc( conversionSvc() );
  if ( cnvsvc ) {
    const ServiceLocatorHelper helper( *serviceLocator(), "Converter", cnvsvc->name() );
    return helper.getService( svcName, createIf, iid, ppSvc );
  }
  return StatusCode::FAILURE;
}

StatusCode Converter::service_i ( const std::string &  svcType, const std::string &  svcName, const InterfaceID &  iid, void **  ppSvc  ) const

private

Definition at line 118 of file Converter.cpp.

                                                      {
  // Check for name of conversion service
  SmartIF<INamedInterface> cnvsvc( conversionSvc() );
  if ( cnvsvc ) {
    const ServiceLocatorHelper helper( *serviceLocator(), "Converter", cnvsvc->name() );
    return helper.createService( svcType, svcName, iid, ppSvc );
  }
  return StatusCode::FAILURE;
}

SmartIF< ISvcLocator > & Converter::serviceLocator ( ) const

protected

Retrieve pointer to service locator.

— Retrieve pointer to service locator

Definition at line 92 of file Converter.cpp.

{ return m_svcLocator; }

StatusCode Converter::setAddressCreator ( IAddressCreator *  creator )

override

Set address creator facility.

Definition at line 83 of file Converter.cpp.

                                                                  {
  m_addressCreator = creator;
  return StatusCode::SUCCESS;
}

StatusCode Converter::setConversionSvc ( IConversionSvc *  svc )

override

Set conversion service the converter is connected to.

Definition at line 74 of file Converter.cpp.

                                                            {
  m_conversionSvc = svc;
  return StatusCode::SUCCESS;
}

StatusCode Converter::setDataProvider ( IDataProviderSvc *  svc )

override

Set Data provider service.

Set data provider service.

Definition at line 61 of file Converter.cpp.

                                                             {
  m_dataProvider = svc;
  m_dataManager  = svc;
  return StatusCode::SUCCESS;
}

StatusCode Converter::updateObj ( IOpaqueAddress *  pAddress, DataObject *  refpObject  )

override

Update the transient object from the other representation.

Definition at line 25 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

StatusCode Converter::updateObjRefs ( IOpaqueAddress *  pAddress, DataObject *  pObject  )

override

Update the references of an updated transient object.

Definition at line 28 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

StatusCode Converter::updateRep ( IOpaqueAddress *  pAddress, DataObject *  pObject  )

override

Update the converted representation of a transient object.

Definition at line 37 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

StatusCode Converter::updateRepRefs ( IOpaqueAddress *  pAddress, DataObject *  pObject  )

override

Update the references of an already converted object.

Definition at line 40 of file Converter.cpp.

{ return StatusCode::SUCCESS; }

Member Data Documentation

SmartIF<IAddressCreator> Converter::m_addressCreator

mutableprivate

Pointer to the address creation service interface.

Definition at line 115 of file Converter.h.

const CLID Converter::m_classType

private

Class type the converter can handle.

Definition at line 113 of file Converter.h.

SmartIF<IConversionSvc> Converter::m_conversionSvc

mutableprivate

Pointer to the connected conversion service.

Definition at line 121 of file Converter.h.

SmartIF<IDataManagerSvc> Converter::m_dataManager

mutableprivate

Pointer to data manager service.

Definition at line 119 of file Converter.h.

SmartIF<IDataProviderSvc> Converter::m_dataProvider

mutableprivate

Pointer to data provider service.

Definition at line 117 of file Converter.h.

SmartIF<IMessageSvc> Converter::m_messageSvc

mutableprivate

MessageSvc reference.

Definition at line 125 of file Converter.h.

long Converter::m_storageType

private

Storage type.

Definition at line 111 of file Converter.h.

SmartIF<ISvcLocator> Converter::m_svcLocator

mutableprivate

Service Locator reference.

Definition at line 123 of file Converter.h.

---

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

• GaudiKernel/GaudiKernel/Converter.h
• GaudiKernel/src/Lib/Converter.cpp