PersistencySvc class implementation definition. More...

#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/PersistencySvc/PersistencySvc.h>

Inheritance diagram for PersistencySvc:

[legend]

Collaboration diagram for PersistencySvc:

[legend]

Classes
class	ServiceEntry

Public Member Functions
IPersistencySvc Interface implementation
long	repSvcType () const override
	Return default service type.

const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. (DUMMY)

StatusCode	createObj (IOpaqueAddress pAddress, DataObject &refpObject) override
	Implementation of IConverter: Create the transient representation of an object.

StatusCode	fillObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Resolve the references of the created transient object.

StatusCode	updateObj (IOpaqueAddress pAddress, DataObject refpObject) override
	Implementation of IConverter: Update the transient object from the other representation.

StatusCode	updateObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Update the references of an updated transient object.

StatusCode	createRep (DataObject pObject, IOpaqueAddress &refpAddress) override
	Implementation of IConverter: Convert the transient object to the requested representation.

StatusCode	fillRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Resolve the references of the converted object.

StatusCode	updateRep (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Update the converted representation of a transient object.

StatusCode	updateRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Update the references of an already converted object.

StatusCode	setDataProvider (IDataProviderSvc *pStore) override
	Define transient datastore.

SmartIF< IDataProviderSvc > &	dataProvider () const override
	Access reference to transient datastore.

StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to.

SmartIF< IConversionSvc > &	conversionSvc () const override
	Get conversion service the converter is connected to.

StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility.

SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility.

StatusCode	addConverter (IConverter *pConverter) override
	Add converter object to conversion service.

StatusCode	addConverter (const CLID &clid) override
	Add converter object to conversion service.

IConverter *	converter (const CLID &clid) override
	Retrieve converter from list.

StatusCode	removeConverter (const CLID &clid) override
	Remove converter object from conversion service (if present).

StatusCode	connectOutput (const std::string &outputFile, const std::string &openMode) override
	Connect the output file to the service with open mode.

StatusCode	connectOutput (const std::string &outputFile) override
	Connect the output file to the service.

StatusCode	commitOutput (const std::string &output, bool do_commit) override
	Commit pending output.

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.

StatusCode	convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress) override
	Convert an address to string form.

StatusCode	createAddress (long svc_type, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress) override
	Convert an address in string form to object form.

: IPersistencySvc implementation
StatusCode	addCnvService (IConversionSvc *service) override
	Add a new Service.

StatusCode	removeCnvService (long type) override
	Remove a Service.

StatusCode	setDefaultCnvService (long type) override
	Set default service type.

StatusCode	getService (long service_type, IConversionSvc *&refpSvc) override
	Retrieve conversion service identified by technology.

StatusCode	getService (const std::string &service_type, IConversionSvc *&refpSvc) override
	Retrieve conversion service identified by technology.

: IService implementation
StatusCode	initialize () override
	Initialize the service.

StatusCode	finalize () override
	stop the service.

Public Member Functions inherited from extends< Service, IConversionSvc, IPersistencySvc, IAddressCreator >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service.

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.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator.

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

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool.

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked.

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property.

Gaudi::Details::PropertyBase *	declareProperty (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.

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation.

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name.

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream)

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor.

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service.

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts.

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS)

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL)

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR)

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING)

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO)

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG)

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE)

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO)

Protected Types
typedef std::map< long, ServiceEntry >	Services

: Object implementation
long	m_cnvDefType = TEST_StorageType
	Default service type.

SmartIF< IDataProviderSvc >	m_dataSvc
	Pointer to data provider service.

Services	m_cnvServices
	List of conversion workers.

std::recursive_mutex	m_servicesMutex
	Mutex to protect accesses to m_cnvServices.

SmartIF< IConversionSvc >	m_cnvDefault
	Default output service.

Gaudi::Property< std::vector< std::string > >	m_svcNames

bool	m_enable = true
	Flag to indicate that the service is enabled.

SmartIF< IAddressCreator >	m_addrCreator
	Pointer to the IAddressCreator interface of this, for addressCreator().

SmartIF< IConversionSvc > &	service (const std::string &nam)
	Retrieve conversion service by name.

SmartIF< IConversionSvc > &	service (long service_type)
	Retrieve conversion service from list.

SmartIF< IAddressCreator > &	addressCreator (long service_type)
	Retrieve address creator from list.

void	encodeAddrHdr (long service_type, const CLID &clid, std::string &address) const
	Retrieve string from storage type and clid.

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.

StatusCode	makeCall (int typ, IOpaqueAddress &pAddress, DataObject &pObject)
	Implementation helper.

bool	enable (bool value)
	Set enabled flag.

Additional Inherited Members
Public Types inherited from extends< Service, IConversionSvc, IPersistencySvc, IAddressCreator >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory<IService( const std::string&, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl
	Typedef used to refer to this class from derived classes, as in.

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.

MSG::Level	resetMessaging ()
	Reinitialize internal states.

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

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()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

PersistencySvc class implementation definition.

System: The LHCb Offline System

Package: PersistencySvc

Dependencies:

STL: <vector>, <algorithm>, <functional>
Generic service definition: "Kernel/Service.h"
IConversionSvc definition: "Kernel/IConversionSvc.h"
PersistencySvc definition: "Kernel/Interfaces/IPersistencySvc.h"

History:

 +---------+----------------------------------------------+---------+
 |    Date |                 Comment                      | Who     |
 +---------+----------------------------------------------+---------+
 | 3/11/98 | Initial version                              | M.Frank |
 +---------+----------------------------------------------+---------+

Author: Markus Frank

Version: 1.0

Definition at line 57 of file PersistencySvc.h.

Member Typedef Documentation

◆ Services

typedef std::map<long, ServiceEntry> PersistencySvc::Services

protected

Definition at line 80 of file PersistencySvc.h.

Member Function Documentation

◆ addCnvService()

StatusCode PersistencySvc::addCnvService ( IConversionSvc * service )

override

Add a new Service.

Add data service.

Definition at line 230 of file PersistencySvc.cpp.

                                                                {
  std::scoped_lock _{ m_servicesMutex };
  if ( !servc ) return Status::BAD_STORAGE_TYPE;
  long type    = servc->repSvcType();
  long def_typ = ( m_cnvDefault ? m_cnvDefault->repSvcType() : 0 );
  auto it      = m_cnvServices.find( type );
  auto cnv_svc = ( it != m_cnvServices.end() ? it->second.conversionSvc() : nullptr );
  if ( type == def_typ ) m_cnvDefault = servc;
  if ( cnv_svc == servc ) return StatusCode::SUCCESS;
 
  auto iservc = make_SmartIF( servc );
  auto icr    = iservc.as<IAddressCreator>();
  if ( icr ) {
    auto isvc = iservc.as<IService>();
    if ( isvc ) {
      if ( cnv_svc ) removeCnvService( type ).ignore();
      auto p = m_cnvServices.emplace( type, ServiceEntry( type, isvc, iservc, icr ) );
      if ( !p.second ) {
        error() << "Cannot add Conversion service " << isvc->name() << endmsg;
        return StatusCode::FAILURE;
      }
      info() << "Added successfully Conversion service " << isvc->name() << endmsg;
      iservc->setAddressCreator( this ).ignore();
      iservc->setDataProvider( m_dataSvc ).ignore();
      return StatusCode::SUCCESS;
    }
  }
  error() << "Cannot add Conversion service for type " << type << endmsg;
  return StatusCode::FAILURE;
}

◆ addConverter() [1/2]

StatusCode PersistencySvc::addConverter ( const CLID & clid )

override

Add converter object to conversion service.

Definition at line 170 of file PersistencySvc.cpp.

170{ return StatusCode::FAILURE; }

◆ addConverter() [2/2]

StatusCode PersistencySvc::addConverter ( IConverter * pConverter )

override

Add converter object to conversion service.

Definition at line 173 of file PersistencySvc.cpp.

                                                                {
  if ( !pConverter ) return Status::NO_CONVERTER;
  IConversionSvc* svc = service( pConverter->repSvcType() );
  return svc ? svc->addConverter( pConverter ) : Status::BAD_STORAGE_TYPE;
}

◆ addressCreator() [1/2]

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

override

Retrieve address creator facility.

Definition at line 402 of file PersistencySvc.cpp.

402{ return m_addrCreator; }

PersistencySvc::m_addrCreator

SmartIF< IAddressCreator > m_addrCreator

Pointer to the IAddressCreator interface of this, for addressCreator().

Definition PersistencySvc.h:246

◆ addressCreator() [2/2]

SmartIF< IAddressCreator > & PersistencySvc::addressCreator ( long service_type )

protected

Retrieve address creator from list.

Retrieve address creator service from list.

Definition at line 132 of file PersistencySvc.cpp.

                                                                    {
  std::scoped_lock _{ m_servicesMutex };
 
  long typ = type;
  auto it  = m_cnvServices.find( typ );
  if ( it == m_cnvServices.end() ) {
    IConversionSvc* s = service( type );
    if ( s ) {
      it = m_cnvServices.find( typ );
      if ( it != m_cnvServices.end() ) return it->second.addrCreator();
    }
    static SmartIF<IAddressCreator> no_creator;
    return no_creator;
  }
  return it->second.addrCreator();
}

◆ commitOutput()

StatusCode PersistencySvc::commitOutput	(	const std::string &	output,
		bool	do_commit )

override

Commit pending output.

Definition at line 291 of file PersistencySvc.cpp.

291{ return StatusCode::SUCCESS; }

◆ connectOutput() [1/2]

StatusCode PersistencySvc::connectOutput ( const std::string & outputFile )

override

Connect the output file to the service.

Definition at line 288 of file PersistencySvc.cpp.

288{ return StatusCode::SUCCESS; }

◆ connectOutput() [2/2]

StatusCode PersistencySvc::connectOutput	(	const std::string &	outputFile,
		const std::string &	openMode )

override

Connect the output file to the service with open mode.

Definition at line 283 of file PersistencySvc.cpp.

                                                                                          {
  return connectOutput( outputFile );
}

◆ conversionSvc()

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

override

Get conversion service the converter is connected to.

Definition at line 167 of file PersistencySvc.cpp.

167{ return m_cnvDefault; }

◆ convertAddress()

StatusCode PersistencySvc::convertAddress	(	const IOpaqueAddress *	pAddress,
		std::string &	refAddress )

override

Convert an address to string form.

Definition at line 302 of file PersistencySvc.cpp.

                                                                                                 {
  // Assumption is that the Persistency service prepends a header
  // and requests the conversion service referred to by the service
  // type to encode the rest
  long svc_type = 0;
  CLID clid     = 0;
  if ( pAddress ) {
    svc_type = pAddress->svcType();
    clid     = pAddress->clID();
  }
  IAddressCreator* svc    = addressCreator( svc_type );
  StatusCode       status = Status::BAD_STORAGE_TYPE; // Preset error
  refAddress.clear();
 
  if ( svc ) {
    // Found service, set header
    encodeAddrHdr( svc_type, clid, refAddress );
    std::string address;
    // Get rest of address from conversion service
    status = svc->convertAddress( pAddress, address );
    refAddress += address;
  }
  return status;
}

◆ converter()

IConverter * PersistencySvc::converter ( const CLID & clid )

override

Retrieve converter from list.

Definition at line 192 of file PersistencySvc.cpp.

192{ return nullptr; }

◆ createAddress() [1/2]

StatusCode PersistencySvc::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 328 of file PersistencySvc.cpp.

                                                                         {
  // Assumption is that the Persistency service decodes that header
  // and requests the conversion service referred to by the service
  // type to decode the rest
  long        new_svc_type = 0;
  CLID        new_clid     = 0;
  std::string address_trailer;
  decodeAddrHdr( refAddress, new_svc_type, new_clid, address_trailer );
  IAddressCreator* svc = addressCreator( new_svc_type );
  return svc ? svc->createAddress( new_svc_type, new_clid, address_trailer, refpAddress ) : Status::BAD_STORAGE_TYPE;
}

◆ createAddress() [2/2]

StatusCode PersistencySvc::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 at line 294 of file PersistencySvc.cpp.

                                                                                                     {
  refpAddress          = nullptr;
  IAddressCreator* svc = addressCreator( svc_type );
  return svc ? svc->createAddress( svc_type, clid, pars, ipars, refpAddress ) : Status::BAD_STORAGE_TYPE;
}

◆ createObj()

StatusCode PersistencySvc::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 92 of file PersistencySvc.cpp.

                                                                                  {
  return makeCall( CREATE_OBJ, pAddr, refpObj );
}

◆ createRep()

StatusCode PersistencySvc::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 112 of file PersistencySvc.cpp.

                                                                                  {
  return makeCall( CREATE_REP, refpAddr, pObj );
}

◆ dataProvider()

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

override

Access reference to transient datastore.

Access the dataprovider service.

Definition at line 158 of file PersistencySvc.cpp.

158{ return m_dataSvc; }

◆ decodeAddrHdr()

void PersistencySvc::decodeAddrHdr	(	const std::string &	address,
		long &	service_type,
		CLID &	clid,
		std::string &	address_trailer ) const

protected

Retrieve storage type and clid from address header of string.

Definition at line 352 of file PersistencySvc.cpp.

                                                                       {
  // For address header, use xml-style format of
  // <address_header service_type="xxx" clid="yyy" />
  service_type = 0;
  clid         = 0;
  address_trailer.clear();
 
  // Check for address_header tag
  size_t pos = address.find( "<address_header" );
  if ( std::string::npos != pos ) {
    // Get service_type
    pos = address.find( "service_type=\"" );
    if ( std::string::npos != pos ) {
      pos += 14;
      size_t end = address.find( '"', pos );
      if ( std::string::npos != end ) {
        service_type = std::stol( address.substr( pos, end - pos ) );
        // Get clid
        pos = address.find( "clid=\"" );
        if ( std::string::npos != pos ) {
          pos += 6;
          end = address.find( '\"', pos );
          if ( std::string::npos != end ) {
            std::istringstream str;
            str.str( address.substr( pos, end - pos ) );
            str >> clid;
            // Get trailer_address
            pos = address.find( '>' );
            if ( pos < ( address.size() - 2 ) ) { // this means that '>' was found (pos != npos)
                                                  // it is before the last char
              address_trailer = address.substr( pos + 1 );
            }
          }
        }
      }
    }
  }
}

◆ enable()

bool PersistencySvc::enable ( bool value )

protected

Set enabled flag.

Definition at line 507 of file PersistencySvc.cpp.

                                        {
  std::swap( value, m_enable );
  return value;
}

◆ encodeAddrHdr()

void PersistencySvc::encodeAddrHdr	(	long	service_type,
		const CLID &	clid,
		std::string &	address ) const

protected

Retrieve string from storage type and clid.

Definition at line 342 of file PersistencySvc.cpp.

                                                                                                  {
  // For address header, use xml-style format of
  // <addrhdr service_type="xxx" clid="yyy" />
  std::stringstream stream;
  int               svctyp = service_type; // must put int into stream, not char
  stream << "<address_header service_type=\"" << svctyp << "\" clid=\"" << clid << "\" /> ";
  address = stream.str();
}

◆ fillObjRefs()

StatusCode PersistencySvc::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 97 of file PersistencySvc.cpp.

                                                                                {
  return makeCall( FILL_OBJ_REFS, pAddr, pObj );
}

◆ fillRepRefs()

StatusCode PersistencySvc::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 117 of file PersistencySvc.cpp.

                                                                                {
  return makeCall( FILL_REP_REFS, pAddr, pObj );
}

◆ finalize()

StatusCode PersistencySvc::finalize ( )

override

stop the service.

Definition at line 497 of file PersistencySvc.cpp.

                                    {
  std::scoped_lock _{ m_servicesMutex };
  // Release all workers
  m_cnvServices.clear();
  // Release references to this to avoid loops
  m_addrCreator = nullptr;
  return StatusCode::SUCCESS;
}

◆ getService() [1/2]

StatusCode PersistencySvc::getService	(	const std::string &	service_type,
		IConversionSvc *&	refpSvc )

override

Retrieve conversion service identified by technology.

Definition at line 411 of file PersistencySvc.cpp.

                                                                                               {
  const char* imp = service_type.c_str();
  long        len = service_type.length();
  if ( ::strncasecmp( imp, "SICB", len ) == 0 )
    return getService( SICB_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "ZEBRA", len ) == 0 )
    return getService( SICB_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "MS Access", len ) == 0 )
    return getService( ACCESS_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Microsoft Access", strlen( "Microsoft Access" ) ) == 0 )
    return getService( ACCESS_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "SQL Server", len ) == 0 )
    return getService( SQLSERVER_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Microsoft ODBC for Oracle", len ) == 0 )
    return getService( ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Oracle ODBC", strlen( "Oracle ODBC" ) ) == 0 )
    return getService( ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "Oracle OCI", strlen( "Oracle OCI" ) ) == 0 )
    return getService( ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "MySQL", len ) == 0 )
    return getService( MYSQL_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "ROOT", len ) == 0 )
    return getService( ROOT_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "OBJY", len ) == 0 )
    return getService( OBJY_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "OBJYECTI", 7 ) == 0 )
    return getService( OBJY_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ROOTKEY", 12 ) == 0 )
    return getService( POOL_ROOTKEY_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ROOTTREE", 12 ) == 0 )
    return getService( POOL_ROOTTREE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ROOT", 9 ) == 0 )
    return getService( POOL_ROOT_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_MySQL", 8 ) == 0 )
    return getService( POOL_MYSQL_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ORACLE", 8 ) == 0 )
    return getService( POOL_ORACLE_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL_ACCESS", 8 ) == 0 )
    return getService( POOL_ACCESS_StorageType, refpSvc );
  else if ( ::strncasecmp( imp, "POOL", 4 ) == 0 )
    return getService( POOL_StorageType, refpSvc );
 
  std::scoped_lock _{ m_servicesMutex };
  for ( const auto& i : m_cnvServices ) {
    SmartIF<IService> svc( i.second.conversionSvc() );
    if ( svc ) {
      // Check wether this is already an active service: first check by service name
      if ( svc->name() == service_type ) {
        refpSvc = i.second.conversionSvc();
        return StatusCode::SUCCESS;
      }
      // Check wether this is already an active service: now check by service type
      auto instance = svc.get();
      if ( System::typeinfoName( typeid( *instance ) ) == service_type ) {
        refpSvc = i.second.conversionSvc();
        return StatusCode::SUCCESS;
      }
    }
  }
  // if not, check if the service is in the list and may be requested
  for ( const auto& i : m_svcNames.value() ) {
    Gaudi::Utils::TypeNameString itm( i );
    if ( itm.name() == service_type || itm.type() == service_type ) {
      IConversionSvc* svc = service( i );
      if ( svc ) {
        refpSvc = svc;
        return StatusCode::SUCCESS;
      }
    }
  }
  return StatusCode::FAILURE;
}

◆ getService() [2/2]

StatusCode PersistencySvc::getService	(	long	service_type,
		IConversionSvc *&	refpSvc )

override

Retrieve conversion service identified by technology.

Definition at line 405 of file PersistencySvc.cpp.

                                                                                   {
  refpSvc = service( service_type );
  return refpSvc ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

◆ initialize()

StatusCode PersistencySvc::initialize ( )

override

Initialize the service.

Definition at line 488 of file PersistencySvc.cpp.

                                      {
  m_addrCreator = this; // initialize internal pointer to IAddressCreator interface
  // Initialize basic service
  StatusCode status = Service::initialize();
  if ( !status.isSuccess() ) { error() << "Error initializing Service base class." << endmsg; }
  return status;
}

◆ makeCall()

StatusCode PersistencySvc::makeCall	(	int	typ,
		IOpaqueAddress *&	pAddress,
		DataObject *&	pObject )

protected

Implementation helper.

Definition at line 37 of file PersistencySvc.cpp.

                                                                                              {
  if ( m_enable ) {
    IConversionSvc* svc = nullptr;
    switch ( typ ) {
    case CREATE_REP:
    case FILL_REP_REFS:
    case UPDATE_REP:
    case UPDATE_REP_REFS:
      svc = m_cnvDefault;
      break;
    default:
      if ( !pAddress ) return Status::INVALID_ADDRESS;
      svc = service( pAddress->svcType() );
      if ( !svc ) return Status::BAD_STORAGE_TYPE;
      break;
    }
 
    StatusCode status = StatusCode::FAILURE;
    switch ( typ ) {
    case CREATE_OBJ:
      pObject = nullptr;
      status  = svc->createObj( pAddress, pObject );
      break;
    case FILL_OBJ_REFS:
      status = svc->fillObjRefs( pAddress, pObject );
      break;
    case UPDATE_OBJ:
      status = svc->updateObj( pAddress, pObject );
      break;
    case UPDATE_OBJ_REFS:
      status = svc->updateObjRefs( pAddress, pObject );
      break;
    case CREATE_REP:
      status = svc->createRep( pObject, pAddress );
      break;
    case FILL_REP_REFS:
      status = svc->fillRepRefs( pAddress, pObject );
      break;
    case UPDATE_REP:
      status = svc->updateRep( pAddress, pObject );
      break;
    case UPDATE_REP_REFS:
      status = svc->updateRepRefs( pAddress, pObject );
      break;
    default:
      status = StatusCode::FAILURE;
      break;
    }
    status.ignore();
    return status;
  }
  return StatusCode::SUCCESS;
}

◆ objType()

const CLID & PersistencySvc::objType ( ) const

override

Retrieve the class type of objects the converter produces. (DUMMY)

Retrieve the class type of objects the converter produces.

Definition at line 485 of file PersistencySvc.cpp.

485{ return CLID_NULL; }

◆ removeCnvService()

StatusCode PersistencySvc::removeCnvService ( long type )

override

Remove a Service.

Remove conversion service.

Definition at line 262 of file PersistencySvc.cpp.

                                                          {
  std::scoped_lock _{ m_servicesMutex };
 
  auto it = m_cnvServices.find( svctype );
  if ( it == m_cnvServices.end() ) return Status::BAD_STORAGE_TYPE;
  it->second.service()->release();
  it->second.addrCreator()->release();
  m_cnvServices.erase( it );
  return StatusCode::SUCCESS;
}

◆ removeConverter()

StatusCode PersistencySvc::removeConverter ( const CLID & clid )

override

Remove converter object from conversion service (if present).

Definition at line 180 of file PersistencySvc.cpp.

                                                             {
  std::scoped_lock _{ m_servicesMutex };
  // Remove converter type from all services
  StatusCode status = Status::NO_CONVERTER, iret = StatusCode::SUCCESS;
  for ( auto& i : m_cnvServices ) {
    iret = i.second.conversionSvc()->removeConverter( clid );
    if ( iret.isSuccess() ) status = iret;
  }
  return status;
}

◆ repSvcType()

long PersistencySvc::repSvcType ( ) const

override

Return default service type.

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

Definition at line 274 of file PersistencySvc.cpp.

274{ return m_cnvDefault ? m_cnvDefault->repSvcType() : 0; }

◆ service() [1/2]

SmartIF< IConversionSvc > & PersistencySvc::service ( const std::string & nam )

protected

Retrieve conversion service by name.

Definition at line 195 of file PersistencySvc.cpp.

                                                                       {
  Gaudi::Utils::TypeNameString tn( nam );
 
  std::scoped_lock _{ m_servicesMutex };
 
  auto it = std::find_if( m_cnvServices.begin(), m_cnvServices.end(),
                          [&]( Services::const_reference i ) { return i.second.service()->name() == tn.name(); } );
  if ( it != m_cnvServices.end() ) return it->second.conversionSvc();
 
  auto svc = Service::service<IConversionSvc>( nam, true );
  if ( svc && addCnvService( svc.get() ).isSuccess() ) {
    return service( nam ); // now it is in the list
  }
 
  error() << "Cannot access Conversion service " << nam << endmsg;
  static SmartIF<IConversionSvc> no_svc;
  return no_svc;
}

◆ service() [2/2]

SmartIF< IConversionSvc > & PersistencySvc::service ( long service_type )

protected

Retrieve conversion service from list.

Definition at line 215 of file PersistencySvc.cpp.

                                                            {
  std::scoped_lock _{ m_servicesMutex };
  // Check wether this is already an active service
  auto it = m_cnvServices.find( type );
  if ( it != m_cnvServices.end() ) return it->second.conversionSvc();
  // if not, check if the service is in the list and may be requested
  for ( const auto& i : m_svcNames.value() ) {
    auto& svc = service( i );
    if ( svc && svc->repSvcType() == type ) return svc;
  }
  static SmartIF<IConversionSvc> no_svc;
  return no_svc;
}

◆ setAddressCreator()

StatusCode PersistencySvc::setAddressCreator ( IAddressCreator * creator )

override

Set address creator facility.

Definition at line 393 of file PersistencySvc.cpp.

                                                               {
  // The persistency service is an address creation dispatcher itself.
  // The persistency service can NEVER create addresses itself.
  // The entry point must only be provided in order to fulfill the needs of the
  // implementing interfaces.
  return StatusCode::FAILURE;
}

◆ setConversionSvc()

StatusCode PersistencySvc::setConversionSvc ( IConversionSvc * svc )

override

Set conversion service the converter is connected to.

Definition at line 161 of file PersistencySvc.cpp.

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

◆ setDataProvider()

StatusCode PersistencySvc::setDataProvider ( IDataProviderSvc * pStore )

override

Define transient datastore.

Define transient data store.

Definition at line 150 of file PersistencySvc.cpp.

                                                                       {
  std::scoped_lock _{ m_servicesMutex };
  m_dataSvc = pDataSvc;
  for ( auto& i : m_cnvServices ) { i.second.conversionSvc()->setDataProvider( m_dataSvc ).ignore(); }
  return StatusCode::SUCCESS;
}

◆ setDefaultCnvService()

StatusCode PersistencySvc::setDefaultCnvService ( long type )

override

Set default service type.

Set default conversion service.

Definition at line 277 of file PersistencySvc.cpp.

                                                           {
  m_cnvDefault = service( type );
  return StatusCode::SUCCESS;
}

◆ updateObj()

StatusCode PersistencySvc::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 102 of file PersistencySvc.cpp.

                                                                              {
  return makeCall( UPDATE_OBJ, pAddr, pObj );
}

◆ updateObjRefs()

StatusCode PersistencySvc::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 107 of file PersistencySvc.cpp.

                                                                                  {
  return makeCall( UPDATE_OBJ_REFS, pAddr, pObj );
}

◆ updateRep()

StatusCode PersistencySvc::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 122 of file PersistencySvc.cpp.

                                                                              {
  return makeCall( UPDATE_REP, pAddr, pObj );
}

◆ updateRepRefs()

StatusCode PersistencySvc::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 127 of file PersistencySvc.cpp.

                                                                                  {
  return makeCall( UPDATE_REP_REFS, pAddr, pObj );
}

Member Data Documentation

◆ m_addrCreator

SmartIF<IAddressCreator> PersistencySvc::m_addrCreator

mutableprotected

Pointer to the IAddressCreator interface of this, for addressCreator().

Definition at line 246 of file PersistencySvc.h.

◆ m_cnvDefault

SmartIF<IConversionSvc> PersistencySvc::m_cnvDefault

mutableprotected

Default output service.

Definition at line 230 of file PersistencySvc.h.

◆ m_cnvDefType

long PersistencySvc::m_cnvDefType = TEST_StorageType

protected

Default service type.

Definition at line 221 of file PersistencySvc.h.

◆ m_cnvServices

Services PersistencySvc::m_cnvServices

protected

List of conversion workers.

Definition at line 225 of file PersistencySvc.h.

◆ m_dataSvc

SmartIF<IDataProviderSvc> PersistencySvc::m_dataSvc

mutableprotected

Pointer to data provider service.

Definition at line 223 of file PersistencySvc.h.

◆ m_enable

bool PersistencySvc::m_enable = true

protected

Flag to indicate that the service is enabled.

Definition at line 243 of file PersistencySvc.h.

◆ m_servicesMutex

std::recursive_mutex PersistencySvc::m_servicesMutex

mutableprotected

Mutex to protect accesses to m_cnvServices.

Definition at line 227 of file PersistencySvc.h.

◆ m_svcNames

Gaudi::Property<std::vector<std::string> > PersistencySvc::m_svcNames

protected

Initial value:

{
      this,
      "CnvServices",
      {},
      [this]( auto& p ) {
        if ( this->msgLevel( MSG::DEBUG ) ) this->debug() << p << endmsg;
      },
      "Names of services to be requested from the service locator and added by default",
      "OrderedSet<std::string>" }

Definition at line 232 of file PersistencySvc.h.

                                                {
      this,
      "CnvServices",
      {},
      [this]( auto& p ) {
        if ( this->msgLevel( MSG::DEBUG ) ) this->debug() << p << endmsg;
      },
      "Names of services to be requested from the service locator and added by default",
      "OrderedSet<std::string>" };

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

GaudiCommonSvc/src/PersistencySvc/PersistencySvc.h
GaudiCommonSvc/src/PersistencySvc/PersistencySvc.cpp

Classes

Public Member Functions

Protected Types

: Object implementation

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Services

Member Function Documentation

◆ addCnvService()

◆ addConverter() [1/2]

◆ addConverter() [2/2]

◆ addressCreator() [1/2]

◆ addressCreator() [2/2]

◆ commitOutput()

◆ connectOutput() [1/2]

◆ connectOutput() [2/2]

◆ conversionSvc()

◆ convertAddress()

◆ converter()

◆ createAddress() [1/2]

◆ createAddress() [2/2]

◆ createObj()

◆ createRep()

◆ dataProvider()

◆ decodeAddrHdr()

◆ enable()

◆ encodeAddrHdr()

◆ fillObjRefs()

◆ fillRepRefs()

◆ finalize()

◆ getService() [1/2]

◆ getService() [2/2]

◆ initialize()

◆ makeCall()

◆ objType()

◆ removeCnvService()

◆ removeConverter()

◆ repSvcType()

◆ service() [1/2]

◆ service() [2/2]

◆ setAddressCreator()

◆ setConversionSvc()

◆ setDataProvider()

◆ setDefaultCnvService()

◆ updateObj()

◆ updateObjRefs()

◆ updateRep()

◆ updateRepRefs()

Member Data Documentation

◆ m_addrCreator

◆ m_cnvDefault

◆ m_cnvDefType

◆ m_cnvServices

◆ m_dataSvc

◆ m_enable

◆ m_servicesMutex

◆ m_svcNames