Data service base class. More...

Inheritance diagram for MultiStoreSvc:

[legend]

Collaboration diagram for MultiStoreSvc:

[legend]

Classes
struct	tagROOT
	Root type (address or object) More...

Public Member Functions
CLID	rootCLID () const override
	IDataManagerSvc: Accessor for root event CLID. More...

const std::string &	rootName () const override
	Name for root Event. More...

StatusCode	registerAddress (std::string_view path, ADDRESS *pAddr) override
	IDataManagerSvc: Register object address with the data store. More...

StatusCode	registerAddress (IRegistry parent, std::string_view path, ADDRESS pAddr) override
	IDataManagerSvc: Register object address with the data store. More...

StatusCode	unregisterAddress (std::string_view path) override
	IDataManagerSvc: Unregister object address from the data store. More...

StatusCode	unregisterAddress (IRegistry *pParent, std::string_view path) override
	IDataManagerSvc: Unregister object address from the data store. More...

StatusCode	objectLeaves (const OBJECT pObject, std::vector< IRegistry > &leaves) override
	Explore the object store: retrieve all leaves attached to the object. More...

StatusCode	objectLeaves (const IRegistry pObject, std::vector< IRegistry > &leaves) override
	Explore the object store: retrieve all leaves attached to the object. More...

StatusCode	objectParent (const OBJECT pObject, IRegistry &refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...

StatusCode	objectParent (const IRegistry pObject, IRegistry &refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...

StatusCode	clearSubTree (std::string_view path) override
	Remove all data objects below the sub tree identified. More...

StatusCode	clearSubTree (OBJECT *pObject) override
	Remove all data objects below the sub tree identified. More...

StatusCode	clearStore () override
	IDataManagerSvc: Remove all data objects in the data store. More...

StatusCode	traverseSubTree (std::string_view path, AGENT *pAgent) override
	Analyze by traversing all data objects below the sub tree. More...

StatusCode	traverseSubTree (OBJECT pObject, AGENT pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree. More...

StatusCode	traverseTree (AGENT *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects in the data store. More...

StatusCode	setRoot (std::string path, OBJECT *pObj) override
	Initialize data store for new event by giving new event path and root object. More...

StatusCode	setRoot (std::string path, ADDRESS *pAddr) override
	Initialize data store for new event by giving new event path and address of root object. More...

StatusCode	setDataLoader (IConversionSvc pDataLoader, IDataProviderSvc dpsvc=nullptr) override
	IDataManagerSvc: Pass a default data loader to the service. More...

StatusCode	addPreLoadItem (const DataStoreItem &item) override
	Add an item to the preload list. More...

StatusCode	removePreLoadItem (const DataStoreItem &item) override
	Remove an item from the preload list. More...

StatusCode	resetPreLoad () override
	Clear the preload list. More...

StatusCode	preLoad () override
	load all preload items of the list More...

StatusCode	registerObject (std::string_view parent, std::string_view obj, OBJECT *pObj) override
	Register object with the data store. More...

StatusCode	registerObject (OBJECT parent, std::string_view obj, OBJECT pObj) override
	Register object with the data store. More...

StatusCode	unregisterObject (std::string_view path) override
	Unregister object from the data store. More...

StatusCode	unregisterObject (OBJECT *pObj) override
	Unregister object from the data store. More...

StatusCode	unregisterObject (OBJECT *pObj, std::string_view path) override
	Unregister object from the data store. More...

StatusCode	retrieveObject (IRegistry parent, std::string_view path, OBJECT &pObj) override
	Retrieve object from data store. More...

StatusCode	findObject (std::string_view path, OBJECT *&pObj) override
	Find object identified by its full path in the data store. More...

StatusCode	findObject (IRegistry parent, std::string_view path, OBJECT &pObj) override
	Find object identified by its full path in the data store. More...

StatusCode	linkObject (IRegistry from, std::string_view objPath, OBJECT to) override
	Add a link to another object. More...

StatusCode	linkObject (std::string_view fullPath, OBJECT *to) override
	Add a link to another object. More...

StatusCode	unlinkObject (IRegistry *from, std::string_view objPath) override
	Remove a link to another object. More...

StatusCode	unlinkObject (OBJECT *from, std::string_view objPath) override
	Remove a link to another object. More...

StatusCode	unlinkObject (std::string_view path) override
	Remove a link to another object. More...

StatusCode	updateObject (IRegistry *pDirectory) override
	Update object identified by its directory entry. More...

StatusCode	updateObject (OBJECT *pObj) override
	Update object. More...

StatusCode	create (CSTR &nam, CSTR &typ) override
	Create a partition object. The name identifies the partition uniquely. More...

StatusCode	create (CSTR &nam, CSTR &typ, IInterface *&pPartition) override
	Create a partition object. The name identifies the partition uniquely. More...

StatusCode	drop (CSTR &nam) override
	Drop a partition object. The name identifies the partition uniquely. More...

StatusCode	drop (IInterface *pPartition) override
	Drop a partition object. The name identifies the partition uniquely. More...

StatusCode	activate (CSTR &nam) override
	Activate a partition object. The name identifies the partition uniquely. More...

StatusCode	activate (IInterface *pPartition) override
	Activate a partition object. More...

StatusCode	get (CSTR &nam, IInterface *&pPartition) const override
	Access a partition object. The name identifies the partition uniquely. More...

StatusCode	activePartition (std::string &nam, IInterface *&pPartition) const override
	Access the active partition object. More...

StatusCode	attachServices ()

StatusCode	detachServices ()

StatusCode	initialize () override
	Service initialisation. More...

StatusCode	reinitialize () override
	Service initialisation. More...

StatusCode	finalize () override
	Service initialisation. More...

	~MultiStoreSvc () override
	Standard Destructor. More...

StatusCode	preparePartitions ()
	Prepare partition for usage. More...

StatusCode	clearPartitions ()
	Clear all partitions. More...

StatusCode	makePartitions ()
	Create all partitions according to job options. More...

Public Member Functions inherited from extends< Service, IDataProviderSvc, IDataManagerSvc, IPartitionControl >
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...

Public Member Functions inherited from Service
const std::string &	name () 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	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used 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

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

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. More...

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. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (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::PropertyBase &	getProperty (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

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) More...

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

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

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

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

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

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

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

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

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

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

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

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

Protected Types
typedef std::vector< std::string >	PartitionDefs

typedef std::map< std::string, Partition >	Partitions

Protected Member Functions
template<typename Fun >
StatusCode	fwd (Fun f)

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::PropertyBase *	property (const std::string &name) const

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

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

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

Protected Attributes
Gaudi::Property< CLID >	m_rootCLID {this, "RootCLID", 110, "CLID of root entry"}

Gaudi::Property< std::string >	m_rootName {this, "RootName", "/Event", "name of root entry"}

Gaudi::Property< PartitionDefs >	m_partitionDefs {this, "Partitions", {}, "datastore partition definitions"}

Gaudi::Property< std::string >	m_loader {this, "DataLoader", "EventPersistencySvc", "data loader name"}

Gaudi::Property< std::string >	m_defaultPartition {this, "DefaultPartition", "Default", "default partition name"}

SmartIF< IConversionSvc >	m_dataLoader
	Pointer to data loader service. More...

SmartIF< IAddressCreator >	m_addrCreator
	Reference to address creator. More...

struct MultiStoreSvc::tagROOT	m_root

Partition	m_current
	Current partition. More...

Partitions	m_partitions
	Datastore partitions. 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, " 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< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Additional Inherited Members
Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc, IPartitionControl >
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
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

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

Data service base class.

A data service manages the transient data stores and implements the IDataProviderSvc, the IDataManagerSvc and the IPartitionControl interfaces.

Author: Markus Frank; Sebastien Ponce

Version: 1.0

Definition at line 106 of file MultiStoreSvc.cpp.

Member Typedef Documentation

◆ PartitionDefs

typedef std::vector<std::string> MultiStoreSvc::PartitionDefs

protected

Definition at line 108 of file MultiStoreSvc.cpp.

◆ Partitions

typedef std::map<std::string, Partition> MultiStoreSvc::Partitions

protected

Definition at line 109 of file MultiStoreSvc.cpp.

Constructor & Destructor Documentation

◆ ~MultiStoreSvc()

MultiStoreSvc::~MultiStoreSvc ( )

inlineoverride

Standard Destructor.

Definition at line 496 of file MultiStoreSvc.cpp.

                             {
     setDataLoader( nullptr ).ignore();
     resetPreLoad().ignore();
     clearStore().ignore();
     clearPartitions().ignore();
   }

Member Function Documentation

◆ activate() [1/2]

StatusCode MultiStoreSvc::activate ( CSTR & nam )

inlineoverride

Activate a partition object. The name identifies the partition uniquely.

Definition at line 367 of file MultiStoreSvc.cpp.

                                             {
     auto i = m_partitions.find( nam );
     if ( i != m_partitions.end() ) {
       m_current = i->second;
       return StatusCode::SUCCESS;
     }
     m_current = {};
     return IPartitionControl::Status::PARTITION_NOT_PRESENT;
   }

◆ activate() [2/2]

StatusCode MultiStoreSvc::activate ( IInterface * pPartition )

inlineoverride

Activate a partition object.

Definition at line 378 of file MultiStoreSvc.cpp.

                                                          {
     auto provider = SmartIF<IDataProviderSvc>( pPartition );
     m_current     = Partition();
     if ( !provider ) return IInterface::Status::NO_INTERFACE;
     auto i = std::find_if( std::begin( m_partitions ), std::end( m_partitions ),
                            [&]( Partitions::const_reference p ) { return p.second.dataProvider == provider; } );
     if ( i == std::end( m_partitions ) ) return IPartitionControl::Status::PARTITION_NOT_PRESENT;
     m_current = i->second;
     return StatusCode::SUCCESS;
   }

◆ activePartition()

StatusCode MultiStoreSvc::activePartition	(	std::string &	nam,
		IInterface *&	pPartition
	)		const

inlineoverride

Access the active partition object.

Definition at line 401 of file MultiStoreSvc.cpp.

                                                                                        {
     if ( m_current.dataProvider ) {
       nam        = m_current.name;
       pPartition = m_current.dataProvider;
       return StatusCode::SUCCESS;
     }
     nam.clear();
     pPartition = nullptr;
     return IPartitionControl::Status::NO_ACTIVE_PARTITION;
   }

◆ addPreLoadItem()

StatusCode MultiStoreSvc::addPreLoadItem ( const DataStoreItem & item )

inlineoverride

Add an item to the preload list.

Definition at line 251 of file MultiStoreSvc.cpp.

                                                                   {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.addPreLoadItem( item ); } );
   }

◆ attachServices()

StatusCode MultiStoreSvc::attachServices ( )

inline

Definition at line 412 of file MultiStoreSvc.cpp.

                               {
     // Attach address creator facility
     m_addrCreator = service( m_loader, true );
     if ( !m_addrCreator ) {
       error() << "Failed to retrieve data loader "
               << "\"" << m_loader << "\"" << endmsg;
       return StatusCode::FAILURE;
     }
     // Attach data loader facility
     auto dataLoader = service<IConversionSvc>( m_loader, true );
     if ( !dataLoader ) {
       error() << "Failed to retrieve data loader "
               << "\"" << m_loader << "\"" << endmsg;
       return StatusCode::FAILURE;
     }
     auto sc = setDataLoader( dataLoader.get() );
     if ( !sc.isSuccess() ) {
       error() << "Failed to set data loader "
               << "\"" << m_loader << "\"" << endmsg;
     }
     return sc;
   }

◆ clearPartitions()

StatusCode MultiStoreSvc::clearPartitions ( )

inline

Clear all partitions.

Definition at line 529 of file MultiStoreSvc.cpp.

                                {
     for ( auto& i : m_partitions ) i.second.dataManager->clearStore().ignore();
     m_partitions.clear();
     return StatusCode::SUCCESS;
   }

◆ clearStore()

StatusCode MultiStoreSvc::clearStore ( )

inlineoverride

IDataManagerSvc: Remove all data objects in the data store.

Definition at line 185 of file MultiStoreSvc.cpp.

                                    {
     for ( auto& i : m_partitions ) { i.second.dataManager->clearStore().ignore(); }
     visit(
         m_root.root,
         []( auto* p ) {
           if ( p ) p->release();
         },
         []( std::monostate ) {} );
     m_root.root = {};
     m_root.path.clear();
     return StatusCode::SUCCESS;
   }

◆ clearSubTree() [1/2]

StatusCode MultiStoreSvc::clearSubTree ( std::string_view path )

inlineoverride

Remove all data objects below the sub tree identified.

Definition at line 177 of file MultiStoreSvc.cpp.

                                                           {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.clearSubTree( path ); } );
   }

◆ clearSubTree() [2/2]

StatusCode MultiStoreSvc::clearSubTree ( OBJECT * pObject )

inlineoverride

Remove all data objects below the sub tree identified.

Definition at line 181 of file MultiStoreSvc.cpp.

                                                       {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.clearSubTree( pObject ); } );
   }

◆ create() [1/2]

StatusCode MultiStoreSvc::create	(	CSTR &	nam,
		CSTR &	typ
	)

inlineoverride

Create a partition object. The name identifies the partition uniquely.

Definition at line 327 of file MultiStoreSvc.cpp.

                                                      {
     IInterface* pPartition = nullptr;
     return create( nam, typ, pPartition );
   }

◆ create() [2/2]

StatusCode MultiStoreSvc::create	(	CSTR &	nam,
		CSTR &	typ,
		IInterface *&	pPartition
	)

inlineoverride

Create a partition object. The name identifies the partition uniquely.

Fix-Me:: : In the old implementation the services were "unmanaged" (non-active)

Definition at line 332 of file MultiStoreSvc.cpp.

                                                                               {
     if ( get( nam, pPartition ).isSuccess() ) return IPartitionControl::Status::PARTITION_EXISTS;
     auto isvc = serviceLocator()->service<IService>( typ );
     if ( !isvc ) return IInterface::Status::NO_INTERFACE;
     auto dataMgr  = isvc.as<IDataManagerSvc>();
     auto dataProv = isvc.as<IDataProviderSvc>();
     if ( !dataMgr || !dataProv ) return IInterface::Status::NO_INTERFACE;
     m_partitions.emplace( nam, Partition{dataProv, dataMgr, nam} );
     return StatusCode::SUCCESS;
   }

◆ detachServices()

StatusCode MultiStoreSvc::detachServices ( )

inline

Definition at line 435 of file MultiStoreSvc.cpp.

                               {
     m_addrCreator.reset();
     m_dataLoader.reset();
     return StatusCode::SUCCESS;
   }

◆ drop() [1/2]

StatusCode MultiStoreSvc::drop ( CSTR & nam )

inlineoverride

Drop a partition object. The name identifies the partition uniquely.

Definition at line 345 of file MultiStoreSvc.cpp.

                                         {
     auto i = m_partitions.find( nam );
     if ( i == m_partitions.end() ) return IPartitionControl::Status::PARTITION_NOT_PRESENT;
     if ( i->second.dataManager == m_current.dataManager ) { m_current = Partition(); }
     i->second.dataManager->clearStore().ignore();
     m_partitions.erase( i );
     return StatusCode::SUCCESS;
   }

◆ drop() [2/2]

StatusCode MultiStoreSvc::drop ( IInterface * pPartition )

inlineoverride

Drop a partition object. The name identifies the partition uniquely.

Definition at line 355 of file MultiStoreSvc.cpp.

                                                      {
     auto provider = SmartIF<IDataProviderSvc>( pPartition );
     if ( !provider ) return IInterface::Status::NO_INTERFACE;
     auto i = std::find_if( std::begin( m_partitions ), std::end( m_partitions ),
                            [&]( Partitions::const_reference p ) { return p.second.dataProvider == provider; } );
     if ( i == std::end( m_partitions ) ) return IPartitionControl::Status::PARTITION_NOT_PRESENT;
     i->second.dataManager->clearStore().ignore();
     m_partitions.erase( i );
     return StatusCode::SUCCESS;
   }

◆ finalize()

StatusCode MultiStoreSvc::finalize ( )

inlineoverride

Service initialisation.

Definition at line 481 of file MultiStoreSvc.cpp.

                                  {
     setDataLoader( nullptr ).ignore();
     clearStore().ignore();
     clearPartitions().ignore();
     m_current = Partition();
     detachServices().ignore();
     return Service::finalize();
   }

◆ findObject() [1/2]

StatusCode MultiStoreSvc::findObject	(	std::string_view	path,
		OBJECT *&	pObj
	)

inlineoverride

Find object identified by its full path in the data store.

Definition at line 291 of file MultiStoreSvc.cpp.

                                                                        {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.retrieveObject( path, pObj ); } );
   }

◆ findObject() [2/2]

StatusCode MultiStoreSvc::findObject	(	IRegistry *	parent,
		std::string_view	path,
		OBJECT *&	pObj
	)

inlineoverride

Find object identified by its full path in the data store.

Definition at line 295 of file MultiStoreSvc.cpp.

                                                                                           {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.findObject( parent, path, pObj ); } );
   }

◆ fwd()

template<typename Fun >

StatusCode MultiStoreSvc::fwd ( Fun f )

inlineprotected

Definition at line 133 of file MultiStoreSvc.cpp.

                           {
     auto* svc = m_current.get<std::decay_t<detail::argument_t<Fun>>>();
     return svc ? f( *svc ) : IDataProviderSvc::Status::INVALID_ROOT;
   }

◆ get()

StatusCode MultiStoreSvc::get	(	CSTR &	nam,
		IInterface *&	pPartition
	)		const

inlineoverride

Access a partition object. The name identifies the partition uniquely.

Definition at line 390 of file MultiStoreSvc.cpp.

                                                                       {
     auto i = m_partitions.find( nam );
     if ( i != m_partitions.end() ) {
       pPartition = i->second.dataProvider;
       return StatusCode::SUCCESS;
     }
     pPartition = nullptr;
     return IPartitionControl::Status::PARTITION_NOT_PRESENT;
   }

◆ initialize()

StatusCode MultiStoreSvc::initialize ( )

inlineoverride

Service initialisation.

Definition at line 442 of file MultiStoreSvc.cpp.

                                    {
     // Nothing to do: just call base class initialisation
     StatusCode sc = Service::initialize();
     if ( !sc.isSuccess() ) return sc;
     sc = makePartitions();
     if ( !sc.isSuccess() ) {
       error() << "Failed to connect to all store partitions." << endmsg;
       return sc;
     }
     return attachServices();
   }

◆ linkObject() [1/2]

StatusCode MultiStoreSvc::linkObject	(	IRegistry *	from,
		std::string_view	objPath,
		OBJECT *	to
	)

inlineoverride

Add a link to another object.

Definition at line 299 of file MultiStoreSvc.cpp.

                                                                                         {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.linkObject( from, objPath, to ); } );
   }

◆ linkObject() [2/2]

StatusCode MultiStoreSvc::linkObject	(	std::string_view	fullPath,
		OBJECT *	to
	)

inlineoverride

Add a link to another object.

Definition at line 303 of file MultiStoreSvc.cpp.

                                                                         {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.linkObject( fullPath, to ); } );
   }

◆ makePartitions()

StatusCode MultiStoreSvc::makePartitions ( )

inline

Create all partitions according to job options.

Definition at line 536 of file MultiStoreSvc.cpp.

                               {
     using Parser = Gaudi::Utils::AttribStringParser;
     std::string typ, nam;
     clearPartitions().ignore();
     for ( auto part : m_partitionDefs ) {
       for ( auto attrib : Parser( std::move( part ) ) ) {
         switch ( ::toupper( attrib.tag[0] ) ) {
         case 'N':
           nam = std::move( attrib.value );
           break;
         case 'T':
           typ = std::move( attrib.value );
           break;
         }
       }
       StatusCode sc = create( nam, typ );
       if ( !sc.isSuccess() ) return sc;
       if ( m_defaultPartition.empty() ) m_defaultPartition = nam;
     }
     return StatusCode::SUCCESS;
   }

◆ objectLeaves() [1/2]

StatusCode MultiStoreSvc::objectLeaves	(	const OBJECT *	pObject,
		std::vector< IRegistry * > &	leaves
	)

inlineoverride

Explore the object store: retrieve all leaves attached to the object.

Definition at line 161 of file MultiStoreSvc.cpp.

                                                                                            {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.objectLeaves( pObject, leaves ); } );
   }

◆ objectLeaves() [2/2]

StatusCode MultiStoreSvc::objectLeaves	(	const IRegistry *	pObject,
		std::vector< IRegistry * > &	leaves
	)

inlineoverride

Explore the object store: retrieve all leaves attached to the object.

Definition at line 165 of file MultiStoreSvc.cpp.

                                                                                               {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.objectLeaves( pObject, leaves ); } );
   }

◆ objectParent() [1/2]

StatusCode MultiStoreSvc::objectParent	(	const OBJECT *	pObject,
		IRegistry *&	refpParent
	)

inlineoverride

IDataManagerSvc: Explore the object store: retrieve the object's parent.

Definition at line 169 of file MultiStoreSvc.cpp.

                                                                                     {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.objectParent( pObject, refpParent ); } );
   }

◆ objectParent() [2/2]

StatusCode MultiStoreSvc::objectParent	(	const IRegistry *	pObject,
		IRegistry *&	refpParent
	)

inlineoverride

IDataManagerSvc: Explore the object store: retrieve the object's parent.

Definition at line 173 of file MultiStoreSvc.cpp.

                                                                                        {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.objectParent( pObject, refpParent ); } );
   }

◆ preLoad()

StatusCode MultiStoreSvc::preLoad ( )

inlineoverride

load all preload items of the list

Definition at line 263 of file MultiStoreSvc.cpp.

                                 {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.preLoad(); } );
   }

◆ preparePartitions()

StatusCode MultiStoreSvc::preparePartitions ( )

inline

Prepare partition for usage.

Definition at line 504 of file MultiStoreSvc.cpp.

                                  {
     StatusCode iret = StatusCode::SUCCESS;
     for ( auto& i : m_partitions ) {
       StatusCode sc = visit(
           m_root.root,
           [&]( ADDRESS* address ) -> StatusCode {
             if ( !address ) return StatusCode::FAILURE;
             ADDRESS* pAdd = nullptr;
             ADDRESS* p    = address;
             auto     sc   = m_addrCreator->createAddress( p->svcType(), p->clID(), p->par(), p->ipar(), pAdd );
             return sc.isSuccess() ? i.second.dataManager->setRoot( m_root.path, pAdd ) : sc;
           },
           [&]( OBJECT* object ) -> StatusCode {
             if ( object && object->clID() == CLID_DataObject ) {
               return i.second.dataManager->setRoot( m_root.path, new DataObject() );
             }
             return StatusCode::FAILURE;
           },
           []( std::monostate ) -> StatusCode { return StatusCode::FAILURE; } );
       if ( !sc.isSuccess() ) iret = sc;
     }
     return iret;
   }

◆ registerAddress() [1/2]

StatusCode MultiStoreSvc::registerAddress	(	std::string_view	path,
		ADDRESS *	pAddr
	)

inlineoverride

IDataManagerSvc: Register object address with the data store.

Definition at line 145 of file MultiStoreSvc.cpp.

                                                                              {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.registerAddress( path, pAddr ); } );
   }

◆ registerAddress() [2/2]

StatusCode MultiStoreSvc::registerAddress	(	IRegistry *	parent,
		std::string_view	path,
		ADDRESS *	pAddr
	)

inlineoverride

IDataManagerSvc: Register object address with the data store.

Definition at line 149 of file MultiStoreSvc.cpp.

                                                                                                 {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.registerAddress( parent, path, pAddr ); } );
   }

◆ registerObject() [1/2]

StatusCode MultiStoreSvc::registerObject	(	std::string_view	parent,
		std::string_view	obj,
		OBJECT *	pObj
	)

inlineoverride

Register object with the data store.

Definition at line 267 of file MultiStoreSvc.cpp.

                                                                                                 {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.registerObject( parent, obj, pObj ); } );
   }

◆ registerObject() [2/2]

StatusCode MultiStoreSvc::registerObject	(	OBJECT *	parent,
		std::string_view	obj,
		OBJECT *	pObj
	)

inlineoverride

Register object with the data store.

Definition at line 271 of file MultiStoreSvc.cpp.

                                                                                          {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.registerObject( parent, obj, pObj ); } );
   }

◆ reinitialize()

StatusCode MultiStoreSvc::reinitialize ( )

inlineoverride

Service initialisation.

Definition at line 455 of file MultiStoreSvc.cpp.

                                      {
     StatusCode sc = Service::reinitialize();
     if ( !sc.isSuccess() ) {
       error() << "Enable to reinitialize base class" << endmsg;
       return sc;
     }
     sc = detachServices();
     if ( !sc.isSuccess() ) {
       error() << "Failed to detach necessary services." << endmsg;
       return sc;
     }
     sc = attachServices();
     if ( !sc.isSuccess() ) {
       error() << "Failed to attach necessary services." << endmsg;
       return sc;
     }
     sc = makePartitions();
     if ( !sc.isSuccess() ) {
       error() << "Failed to connect to store partitions." << endmsg;
       return sc;
     }
     // return
     return StatusCode::SUCCESS;
   }

◆ removePreLoadItem()

StatusCode MultiStoreSvc::removePreLoadItem ( const DataStoreItem & item )

inlineoverride

Remove an item from the preload list.

Definition at line 255 of file MultiStoreSvc.cpp.

                                                                      {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.removePreLoadItem( item ); } );
   }

◆ resetPreLoad()

StatusCode MultiStoreSvc::resetPreLoad ( )

inlineoverride

Clear the preload list.

Definition at line 259 of file MultiStoreSvc.cpp.

                                      {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.resetPreLoad(); } );
   }

◆ retrieveObject()

StatusCode MultiStoreSvc::retrieveObject	(	IRegistry *	parent,
		std::string_view	path,
		OBJECT *&	pObj
	)

inlineoverride

Retrieve object from data store.

Definition at line 287 of file MultiStoreSvc.cpp.

                                                                                               {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.retrieveObject( parent, path, pObj ); } );
   }

◆ rootCLID()

CLID MultiStoreSvc::rootCLID ( ) const

inlineoverride

IDataManagerSvc: Accessor for root event CLID.

Definition at line 140 of file MultiStoreSvc.cpp.

140 { return m_rootCLID; }

MultiStoreSvc::m_rootCLID

Gaudi::Property< CLID > m_rootCLID

Definition: MultiStoreSvc.cpp:111

◆ rootName()

const std::string& MultiStoreSvc::rootName ( ) const

inlineoverride

Name for root Event.

Definition at line 142 of file MultiStoreSvc.cpp.

142 { return m_rootName; }

MultiStoreSvc::m_rootName

Gaudi::Property< std::string > m_rootName

Definition: MultiStoreSvc.cpp:112

◆ setDataLoader()

StatusCode MultiStoreSvc::setDataLoader	(	IConversionSvc *	pDataLoader,
		IDataProviderSvc *	dpsvc = `nullptr`
	)

inlineoverride

IDataManagerSvc: Pass a default data loader to the service.

Definition at line 241 of file MultiStoreSvc.cpp.

                                                                                                       {
     m_dataLoader = pDataLoader;
     if ( m_dataLoader )
       if ( auto sc = m_dataLoader->setDataProvider( dpsvc ? dpsvc : this ); !sc ) return sc;
     for ( auto& i : m_partitions ) {
       if ( auto sc = i.second.dataManager->setDataLoader( m_dataLoader.get() ); !sc ) return sc;
     }
     return StatusCode::SUCCESS;
   }

◆ setRoot() [1/2]

StatusCode MultiStoreSvc::setRoot	(	std::string	path,
		OBJECT *	pObj
	)

inlineoverride

Initialize data store for new event by giving new event path and root object.

Takes care to clear the store before reinitializing it

Definition at line 211 of file MultiStoreSvc.cpp.

                                                               {
     visit(
         m_root.root,
         []( auto* p ) {
           if ( p ) p->release();
         },
         []( std::monostate ) {} );
     m_root.path = std::move( path );
     m_root.root = pObj;
     if ( auto sc = preparePartitions(); !sc ) return sc;
     return activate( m_defaultPartition );
   }

◆ setRoot() [2/2]

StatusCode MultiStoreSvc::setRoot	(	std::string	path,
		ADDRESS *	pAddr
	)

inlineoverride

Initialize data store for new event by giving new event path and address of root object.

Takes care to clear the store before reinitializing it

Definition at line 226 of file MultiStoreSvc.cpp.

                                                                 {
     visit(
         m_root.root,
         []( auto* p ) {
           if ( p ) p->release();
         },
         []( std::monostate ) {} );
     m_root.path = std::move( path );
     m_root.root = pAddr;
     if ( !pAddr ) return StatusCode::FAILURE;
     pAddr->addRef();
     if ( auto sc = preparePartitions(); !sc ) return sc;
     return activate( m_defaultPartition );
   }

◆ traverseSubTree() [1/2]

StatusCode MultiStoreSvc::traverseSubTree	(	std::string_view	path,
		AGENT *	pAgent
	)

inlineoverride

Analyze by traversing all data objects below the sub tree.

Definition at line 198 of file MultiStoreSvc.cpp.

                                                                             {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.traverseSubTree( path, pAgent ); } );
   }

◆ traverseSubTree() [2/2]

StatusCode MultiStoreSvc::traverseSubTree	(	OBJECT *	pObject,
		AGENT *	pAgent
	)

inlineoverride

IDataManagerSvc: Analyze by traversing all data objects below the sub tree.

Definition at line 202 of file MultiStoreSvc.cpp.

                                                                         {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.traverseSubTree( pObject, pAgent ); } );
   }

◆ traverseTree()

StatusCode MultiStoreSvc::traverseTree ( AGENT * pAgent )

inlineoverride

IDataManagerSvc: Analyze by traversing all data objects in the data store.

Definition at line 206 of file MultiStoreSvc.cpp.

                                                     {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.traverseTree( pAgent ); } );
   }

◆ unlinkObject() [1/3]

StatusCode MultiStoreSvc::unlinkObject	(	IRegistry *	from,
		std::string_view	objPath
	)

inlineoverride

Remove a link to another object.

Definition at line 307 of file MultiStoreSvc.cpp.

                                                                               {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.unlinkObject( from, objPath ); } );
   }

◆ unlinkObject() [2/3]

StatusCode MultiStoreSvc::unlinkObject	(	OBJECT *	from,
		std::string_view	objPath
	)

inlineoverride

Remove a link to another object.

Definition at line 311 of file MultiStoreSvc.cpp.

                                                                            {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.unlinkObject( from, objPath ); } );
   }

◆ unlinkObject() [3/3]

StatusCode MultiStoreSvc::unlinkObject ( std::string_view path )

inlineoverride

Remove a link to another object.

Definition at line 315 of file MultiStoreSvc.cpp.

                                                           {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.unlinkObject( path ); } );
   }

◆ unregisterAddress() [1/2]

StatusCode MultiStoreSvc::unregisterAddress ( std::string_view path )

inlineoverride

IDataManagerSvc: Unregister object address from the data store.

Definition at line 153 of file MultiStoreSvc.cpp.

                                                                {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.unregisterAddress( path ); } );
   }

◆ unregisterAddress() [2/2]

StatusCode MultiStoreSvc::unregisterAddress	(	IRegistry *	pParent,
		std::string_view	path
	)

inlineoverride

IDataManagerSvc: Unregister object address from the data store.

Definition at line 157 of file MultiStoreSvc.cpp.

                                                                                    {
     return fwd( [&]( IDataManagerSvc& svc ) { return svc.unregisterAddress( pParent, path ); } );
   }

◆ unregisterObject() [1/3]

StatusCode MultiStoreSvc::unregisterObject ( std::string_view path )

inlineoverride

Unregister object from the data store.

Definition at line 275 of file MultiStoreSvc.cpp.

                                                               {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.unregisterObject( path ); } );
   }

◆ unregisterObject() [2/3]

StatusCode MultiStoreSvc::unregisterObject ( OBJECT * pObj )

inlineoverride

Unregister object from the data store.

Definition at line 279 of file MultiStoreSvc.cpp.

                                                        {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.unregisterObject( pObj ); } );
   }

◆ unregisterObject() [3/3]

StatusCode MultiStoreSvc::unregisterObject	(	OBJECT *	pObj,
		std::string_view	path
	)

inlineoverride

Unregister object from the data store.

Definition at line 283 of file MultiStoreSvc.cpp.

                                                                             {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.unregisterObject( pObj, path ); } );
   }

◆ updateObject() [1/2]

StatusCode MultiStoreSvc::updateObject ( IRegistry * pDirectory )

inlineoverride

Update object identified by its directory entry.

Definition at line 319 of file MultiStoreSvc.cpp.

                                                             {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.updateObject( pDirectory ); } );
   }

◆ updateObject() [2/2]

StatusCode MultiStoreSvc::updateObject ( OBJECT * pObj )

inlineoverride

Update object.

Definition at line 323 of file MultiStoreSvc.cpp.

                                                    {
     return fwd( [&]( IDataProviderSvc& svc ) { return svc.updateObject( pObj ); } );
   }

Member Data Documentation

◆ m_addrCreator

SmartIF<IAddressCreator> MultiStoreSvc::m_addrCreator

protected

Reference to address creator.

Definition at line 120 of file MultiStoreSvc.cpp.

◆ m_current

Partition MultiStoreSvc::m_current

protected

Current partition.

Definition at line 127 of file MultiStoreSvc.cpp.

◆ m_dataLoader

SmartIF<IConversionSvc> MultiStoreSvc::m_dataLoader

protected

Pointer to data loader service.

Definition at line 118 of file MultiStoreSvc.cpp.

◆ m_defaultPartition

Gaudi::Property<std::string> MultiStoreSvc::m_defaultPartition {this, "DefaultPartition", "Default", "default partition name"}

protected

Definition at line 115 of file MultiStoreSvc.cpp.

◆ m_loader

Gaudi::Property<std::string> MultiStoreSvc::m_loader {this, "DataLoader", "EventPersistencySvc", "data loader name"}

protected

Definition at line 114 of file MultiStoreSvc.cpp.

◆ m_partitionDefs

Gaudi::Property<PartitionDefs> MultiStoreSvc::m_partitionDefs {this, "Partitions", {}, "datastore partition definitions"}

protected

Definition at line 113 of file MultiStoreSvc.cpp.

◆ m_partitions

Partitions MultiStoreSvc::m_partitions

protected

Datastore partitions.

Definition at line 129 of file MultiStoreSvc.cpp.

◆ m_root

struct MultiStoreSvc::tagROOT MultiStoreSvc::m_root

protected

◆ m_rootCLID

Gaudi::Property<CLID> MultiStoreSvc::m_rootCLID {this, "RootCLID", 110, "CLID of root entry"}

protected

Definition at line 111 of file MultiStoreSvc.cpp.

◆ m_rootName

Gaudi::Property<std::string> MultiStoreSvc::m_rootName {this, "RootName", "/Event", "name of root entry"}

protected

Definition at line 112 of file MultiStoreSvc.cpp.

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

GaudiCommonSvc/src/DataSvc/MultiStoreSvc.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PartitionDefs

◆ Partitions

Constructor & Destructor Documentation

◆ ~MultiStoreSvc()

Member Function Documentation

◆ activate() [1/2]

◆ activate() [2/2]

◆ activePartition()

◆ addPreLoadItem()

◆ attachServices()

◆ clearPartitions()

◆ clearStore()

◆ clearSubTree() [1/2]

◆ clearSubTree() [2/2]

◆ create() [1/2]

◆ create() [2/2]

◆ detachServices()

◆ drop() [1/2]

◆ drop() [2/2]

◆ finalize()

◆ findObject() [1/2]

◆ findObject() [2/2]

◆ fwd()

◆ get()

◆ initialize()

◆ linkObject() [1/2]

◆ linkObject() [2/2]

◆ makePartitions()

◆ objectLeaves() [1/2]

◆ objectLeaves() [2/2]

◆ objectParent() [1/2]

◆ objectParent() [2/2]

◆ preLoad()

◆ preparePartitions()

◆ registerAddress() [1/2]

◆ registerAddress() [2/2]

◆ registerObject() [1/2]

◆ registerObject() [2/2]

◆ reinitialize()

◆ removePreLoadItem()

◆ resetPreLoad()

◆ retrieveObject()

◆ rootCLID()

◆ rootName()

◆ setDataLoader()

◆ setRoot() [1/2]

◆ setRoot() [2/2]

◆ traverseSubTree() [1/2]

◆ traverseSubTree() [2/2]

◆ traverseTree()

◆ unlinkObject() [1/3]

◆ unlinkObject() [2/3]

◆ unlinkObject() [3/3]

◆ unregisterAddress() [1/2]

◆ unregisterAddress() [2/2]

◆ unregisterObject() [1/3]

◆ unregisterObject() [2/3]

◆ unregisterObject() [3/3]

◆ updateObject() [1/2]

◆ updateObject() [2/2]

Member Data Documentation

◆ m_addrCreator

◆ m_current

◆ m_dataLoader

◆ m_defaultPartition

◆ m_loader

◆ m_partitionDefs

◆ m_partitions

◆ m_root

◆ m_rootCLID

◆ m_rootName