DetDataSvc Class Reference

---

More...

#include <DetectorDataSvc/DetDataSvc.h>

Inheritance diagram for DetDataSvc:

Collaboration diagram for DetDataSvc:

Public Member Functions
StatusCode	initialize () override
	Initialize the service. More...
StatusCode	reinitialize () override
	Initialize the service. More...
StatusCode	finalize () override
	Finalize the service. More...
StatusCode	clearStore () override
	Remove all data objects in the data store. More...
StatusCode	updateObject (DataObject *toUpdate) override
	Update object. More...
	DetDataSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor. More...
	~DetDataSvc () override=default
	Standard Destructor. More...
bool	validEventTime () const override
	Check if the event time has been set. More...
const Gaudi::Time &	eventTime () const override
	Get the event time. More...
void	setEventTime (const Gaudi::Time &time) override
	Set the new event time. More...
void	handle (const Incident &) override
	Inform that a new incident has occured. More...
Public Member Functions inherited from extends< TsDataSvc, IDetDataSvc, IIncidentListener >
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...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from TsDataSvc
CLID	rootCLID () const override
	IDataManagerSvc: Accessor for root event CLID. More...
const std::string &	rootName () const override
	IDataManagerSvc: Accessor for root event name. More...
StatusCode	registerAddress (const std::string &fullPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	registerAddress (DataObject *parentObj, const std::string &objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	registerAddress (IRegistry *parentObj, const std::string &objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	unregisterAddress (const std::string &fullPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	unregisterAddress (DataObject *pParent, const std::string &objPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	unregisterAddress (IRegistry *pParent, const std::string &objPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	objectLeaves (const DataObject *pObject, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object. More...
StatusCode	objectLeaves (const IRegistry *pRegistry, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object. More...
StatusCode	objectParent (const DataObject *pObject, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...
StatusCode	objectParent (const IRegistry *pRegistry, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...
StatusCode	clearSubTree (const std::string &sub_tree_path) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by its full path name. More...
StatusCode	clearSubTree (DataObject *pObject) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by the object. More...
StatusCode	clearStore () override
	IDataManagerSvc: Remove all data objects in the data store. More...
StatusCode	traverseSubTree (const std::string &sub_tree_path, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree identified by its full path name. More...
StatusCode	traverseSubTree (DataObject *pObject, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree. More...
StatusCode	traverseTree (IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects in the data store. More...
StatusCode	setRoot (std::string root_name, DataObject *pRootObj) override
	Initialize data store for new event by giving new event path and root object. More...
virtual StatusCode	i_setRoot (std::string root_name, DataObject *pRootObj)
	Initialize data store for new event by giving new event path and root object. More...
StatusCode	setRoot (std::string root_path, IOpaqueAddress *pRootAddr) override
	Initialize data store for new event by giving new event path and address of root object. More...
virtual StatusCode	i_setRoot (std::string root_path, IOpaqueAddress *pRootAddr)
	Initialize data store for new event by giving new event path and address of root object. More...
StatusCode	setDataLoader (IConversionSvc *svc, IDataProviderSvc *dpsvc=nullptr) override
	IDataManagerSvc: IDataManagerSvc: Pass a default data loader to the service and optionally a data provider. More...
StatusCode	addPreLoadItem (const DataStoreItem &item) override
	Add an item to the preload list. More...
StatusCode	addPreLoadItem (const std::string &itemPath) override
	Add an item to the preload list. More...
StatusCode	removePreLoadItem (const DataStoreItem &item) override
	Remove an item from the preload list. More...
StatusCode	removePreLoadItem (const std::string &itemPath) override
	Add an item to the preload list. More...
StatusCode	resetPreLoad () override
	Clear the preload list. More...
virtual StatusCode	preLoad (int depth, int load_depth, DataObject *pObject)
	Execute one level of preloading and recursively load until the final level is reached. More...
StatusCode	preLoad () override
	load all preload items of the list More...
StatusCode	registerObject (const std::string &fullPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (const std::string &parentPath, const std::string &objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (const std::string &parentPath, int item, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (DataObject *parentObj, const std::string &objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (DataObject *parentObj, int item, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	unregisterObject (const std::string &fullPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (const std::string &parentPath, const std::string &objectPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (const std::string &parentPath, int item) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject, const std::string &objectPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject, int item) override
	Unregister object from the data store. More...
StatusCode	retrieveObject (IRegistry *pDirectory, const std::string &path, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (const std::string &fullPath, DataObject *&pObject) override
	Retrieve object identified by its full path from the data store. More...
StatusCode	retrieveObject (const std::string &parentPath, const std::string &objPath, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (const std::string &parentPath, int item, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (DataObject *parentObj, const std::string &objPath, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (DataObject *parentObj, int item, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	findObject (const std::string &fullPath, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	findObject (IRegistry *pDirectory, const std::string &path, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	findObject (const std::string &parentPath, const std::string &objPath, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (const std::string &parentPath, int item, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (DataObject *parentObj, const std::string &objPath, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (DataObject *parentObj, int item, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	linkObject (IRegistry *from, const std::string &objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (const std::string &fromPath, const std::string &objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (DataObject *from, const std::string &objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (const std::string &fullPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	unlinkObject (IRegistry *from, const std::string &objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (const std::string &fromPath, const std::string &objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (DataObject *fromObj, const std::string &objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (const std::string &fullPath) override
	Remove a link to another object. More...
StatusCode	updateObject (IRegistry *pDirectory) override
	Update object identified by its directory entry. More...
StatusCode	updateObject (const std::string &updatePath) override
	Update object. More...
StatusCode	updateObject (DataObject *toUpdate) override
	Update object. More...
StatusCode	updateObject (const std::string &parentPath, const std::string &updatePath) override
	Update object. More...
StatusCode	updateObject (DataObject *pParent, const std::string &updatePath) override
	Update object. More...
StatusCode	initialize () override
	Service initialization. More...
StatusCode	reinitialize () override
	Service initialization. More...
StatusCode	finalize () override
	Service initialization. More...
	~TsDataSvc () override
	Standard Destructor. More...
Public Member Functions inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
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...
	~extends () override=default
	Virtual destructor. 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
	~PropertyHolder () override=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, TYPE &value, const std::string &doc="none") const
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
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleBase &ref, const std::string &doc="none")
	Specializations for various GaudiHandles. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, GaudiHandleArrayBase &ref, const std::string &doc="none")
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, DataObjectHandleBase &ref, const std::string &doc="none")
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
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...
MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces< Interfaces... >
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
StatusCode	setupDetectorDescription ()
	Deal with Detector Description initialization. More...
StatusCode	loadObject (IConversionSvc *pLoader, IRegistry *pNode) override final
	Invoke Persistency service to create transient object from its persistent representation. More...

Private Attributes
Gaudi::Property< int >	m_detStorageType
Gaudi::Property< std::string >	m_detDbLocation
Gaudi::Property< std::string >	m_detDbRootName {this, "DetDbRootName", "dd", "name of the root node of the detector"}
Gaudi::Property< bool >	m_usePersistency {this, "UsePersistency", false, "control if the persistency is required"}
Gaudi::Property< std::string >	m_persistencySvcName
Gaudi::Property< bool >	m_allowLoadInRunning
Gaudi::Time	m_eventTime = 0
	Current event time. More...
SmartIF< IAddressCreator >	m_addrCreator = nullptr
	Address Creator to be used. More...

Additional Inherited Members
Public Types inherited from extends< TsDataSvc, IDetDataSvc, IIncidentListener >
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 TsDataSvc
typedef std::vector< DataStoreItem >	LoadItems
	Define set of load items. More...
Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from Service
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * >	Factory
Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from TsDataSvc
bool	checkRoot ()
	Check if root path is valid. More...
virtual IConversionSvc *	getDataLoader (IRegistry *pReg)
	Retrieve customizable data loader according to registry entry to be retrieved. More...
virtual DataObject *	createDefaultObject () const
	Create default objects in case forced creation of leaves is requested. More...
virtual StatusCode	loadObject (IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation. More...
StatusCode	retrieveEntry (DataSvcHelpers::RegistryEntry *pNode, const std::string &path, DataSvcHelpers::RegistryEntry *&pEntry)
	Retrieve registry entry from store. More...
DataObject *	handleDataFault (IRegistry *pReg, const std::string &path="")
	Invoke data fault handling if enabled. More...
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 > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...
Protected Attributes inherited from TsDataSvc
IConversionSvc *	m_dataLoader = nullptr
	Pointer to data loader service. More...
IIncidentSvc *	m_incidentSvc = nullptr
	Pointer to incident service. More...
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< bool >	m_forceLeaves {this, "ForceLeaves", false, "force creation of default leaves on registerObject"}
Gaudi::Property< std::vector< std::string > >	m_inhibitPathes {this, "InhibitPathes", {}, "inhibited leaves"}
Gaudi::Property< bool >	m_enableFaultHdlr
Gaudi::Property< std::string >	m_faultName {this, "DataFaultName", "DataFault", "Name of the data fault incident"}
Gaudi::Property< bool >	m_enableAccessHdlr
Gaudi::Property< std::string >	m_accessName {this, "DataAccessName", "DataAccess", "Name of the data access incident"}
LoadItems	m_preLoads
	Items to be pre-loaded. More...
DataSvcHelpers::RegistryEntry *	m_root = nullptr
	Pointer to root entry. More...
DataSvcHelpers::InhibitMap *	m_inhibitMap = nullptr
	Map with object paths to be inhibited from loading. More...
tsDataSvcMutex	m_accessMutex
	Mutex to protect access to the store. More...
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}
Gaudi::Property< bool >	m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
Gaudi::Property< bool >	m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
Gaudi::Property< bool >	m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
Gaudi::Property< bool >	m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
Gaudi::Property< bool >	m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
Gaudi::Property< bool >	m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

---

A DataSvc specialized in detector data. Now inherits from TsDataSvc, a thread safe version of the DataSvc, which allows concurrent retrieval of DataObjects.

Author

Marco Clemencic (previous author unknown)

Danilo Piparo

Definition at line 29 of file DetDataSvc.h.

Constructor & Destructor Documentation

DetDataSvc::DetDataSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Constructor.

Definition at line 174 of file DetDataSvc.cpp.

                                                                : base_class( name, svc )
{
  m_detDbRootName.declareUpdateHandler(
      [this]( Gaudi::Details::PropertyBase& ) { m_rootName = "/" + m_detDbRootName; } );
  m_rootName = "/" + m_detDbRootName;
  m_rootCLID = CLID_Catalog;
}

DetDataSvc::~DetDataSvc ( )

overridedefault

Standard Destructor.

Member Function Documentation

StatusCode DetDataSvc::clearStore ( )

override

Remove all data objects in the data store.

Definition at line 148 of file DetDataSvc.cpp.

{

  TsDataSvc::clearStore().ignore();

  if ( m_usePersistency ) {
    // Create root address
    unsigned long iargs[]    = {0, 0};
    const std::string args[] = {m_detDbLocation, m_detDbRootName};
    IOpaqueAddress* rootAddr;
    StatusCode sc = m_addrCreator->createAddress( m_detStorageType, CLID_Catalog, args, iargs, rootAddr );
    // Set detector data store root
    if ( sc.isSuccess() ) {
      sc = i_setRoot( m_rootName, rootAddr );
      if ( sc.isFailure() ) {
        error() << "Unable to set detector data store root" << endmsg;
      }
    } else {
      error() << "Unable to create address for  /dd" << endmsg;
    }
    return sc;
  }
  return StatusCode::SUCCESS;
}

const Gaudi::Time & DetDataSvc::eventTime ( ) const

override

Get the event time.

Definition at line 193 of file DetDataSvc.cpp.

{ return m_eventTime; }

StatusCode DetDataSvc::finalize ( )

override

Finalize the service.

Definition at line 129 of file DetDataSvc.cpp.

{
  DEBMSG << "Finalizing" << endmsg;

  // clears the store
  m_usePersistency = false; // avoid creation of an empty store when clearing
  clearStore().ignore();

  // Releases the address creator
  m_addrCreator = nullptr;

  // Releases the DataLoader
  setDataLoader( nullptr ).ignore();

  // Finalize the base class
  return TsDataSvc::finalize();
}

void DetDataSvc::handle ( const Incident &  inc )

override

Inform that a new incident has occured.

Inform that a new incident has occurred.

Definition at line 196 of file DetDataSvc.cpp.

{
  ON_DEBUG
  {
    debug() << "New incident received" << endmsg;
    debug() << "Incident source: " << inc.source() << endmsg;
    debug() << "Incident type: " << inc.type() << endmsg;
  }
}

StatusCode DetDataSvc::initialize ( )

override

Initialize the service.

Definition at line 27 of file DetDataSvc.cpp.

{
  // Call base class initialization
  StatusCode sc = TsDataSvc::initialize();
  if ( UNLIKELY( sc.isFailure() ) ) return sc;

  // Set Data Loader
  auto cnv_svc = serviceLocator()->service<IConversionSvc>( m_persistencySvcName );
  if ( UNLIKELY( !cnv_svc ) ) {
    error() << "Unable to retrieve " << m_persistencySvcName << endmsg;
    return StatusCode::FAILURE;
  }

  sc = setDataLoader( cnv_svc );
  if ( UNLIKELY( sc.isFailure() ) ) {
    error() << "Unable to set DataLoader" << endmsg;
    return sc;
  }

  // Get address creator from the DetectorPersistencySvc
  m_addrCreator = cnv_svc;
  if ( UNLIKELY( !m_addrCreator ) ) {
    error() << "Unable to get AddressCreator." << endmsg;
    return StatusCode::FAILURE;
  }

  return setupDetectorDescription();
}

StatusCode DetDataSvc::loadObject ( IConversionSvc *  pLoader, IRegistry *  pNode  )

inlinefinaloverrideprivatevirtual

Invoke Persistency service to create transient object from its persistent representation.

Reimplemented from TsDataSvc.

Definition at line 64 of file DetDataSvc.h.

  {
    if ( LIKELY( m_allowLoadInRunning ||
                 serviceLocator().as<IStateful>()->FSMState() != Gaudi::StateMachine::RUNNING ) ) {
      return TsDataSvc::loadObject( pLoader, pNode );
    }
    error() << "Trying to load " << pNode->identifier() << " while RUNNING" << endmsg;
    return StatusCode::FAILURE;
  }

StatusCode DetDataSvc::reinitialize ( )

override

Initialize the service.

Definition at line 110 of file DetDataSvc.cpp.

{
  // The DetectorDataSvc does not need to be re-initialized. If it is done
  // all the Algorithms having references to DetectorElements will become
  // invalid and crash the program.  (Pere Mato)

  // Call base class reinitialization
  // StatusCode sc  = DataSvc::reinitialize();
  // if( sc.isFailure() ) return sc;

  // Delete the associated event time
  // if( 0 != m_eventTime ) delete m_eventTime;
  // m_eventTimeDefined = false;

  // return setupDetectorDescription();
  return StatusCode::SUCCESS;
}

void DetDataSvc::setEventTime ( const Gaudi::Time &  time )

override

Set the new event time.

Definition at line 183 of file DetDataSvc.cpp.

{
  m_eventTime = time;
  DEBMSG << "Event Time set to " << eventTime() << endmsg;
}

StatusCode DetDataSvc::setupDetectorDescription ( )

private

Deal with Detector Description initialization.

Todo:

: remove references to obsolete package XMLDDDBROOT

Definition at line 56 of file DetDataSvc.cpp.

{
  // Initialize the detector data transient store
  ON_DEBUG
  {
    debug() << "Storage type used is: " << m_detStorageType << endmsg;
    debug() << "Setting DetectorDataSvc root node... " << endmsg;
  }

  if ( m_usePersistency ) {

    IOpaqueAddress* rootAddr = nullptr;
    if ( m_detDbLocation.empty() || "empty" == m_detDbLocation ) {

      // if the name of DBlocation is not given - construct it!
      // by retrieving the value of XMLDDBROOT

      if ( isEnvSet( "XMLDDDBROOT" ) ) {
        const std::string loc = getEnv( "XMLDDDBROOT" );
        m_detDbLocation       = loc + "/DDDB/lhcb.xml";
      }
    }
    if ( m_detDbLocation.empty() || "empty" == m_detDbLocation ) {
      error() << "Detector data location name not set. Detector data will "
                 "not be found."
              << endmsg;
      return StatusCode::FAILURE;
    } else {
      // Create address
      unsigned long iargs[]    = {0, 0};
      const std::string args[] = {m_detDbLocation, m_detDbRootName};
      StatusCode sc            = m_addrCreator->createAddress( m_detStorageType, CLID_Catalog, args, iargs, rootAddr );
      if ( sc.isSuccess() ) {
        sc = i_setRoot( m_rootName, rootAddr );
        if ( sc.isFailure() ) {
          error() << "Unable to set detector data store root" << endmsg;
          return sc;
        }
      } else {
        error() << "Unable to create address for  /dd" << endmsg;
        return sc;
      }
    }
    // Writing the description file in the output log file [bugs #2854]
    always() << "Detector description database: " << m_detDbLocation.value() << endmsg;
  } else {
    info() << "Detector description not requested to be loaded" << endmsg;
  }

  return StatusCode::SUCCESS;
}

StatusCode DetDataSvc::updateObject ( DataObject *  toUpdate )

override

Update object.

Todo:

update also its ancestors in the data store if necessary

Definition at line 208 of file DetDataSvc.cpp.

{

  DEBMSG << "Method updateObject starting" << endmsg;

  // Check that object to update exists
  if ( !toUpdate ) {
    error() << "There is no DataObject to update" << endmsg;
    return INVALID_OBJECT;
  }

  // Retrieve IValidity interface of object to update
  IValidity* condition = dynamic_cast<IValidity*>( toUpdate );
  if ( !condition ) {
    warning() << "Cannot update DataObject: DataObject does not implement IValidity" << endmsg;
    return StatusCode::SUCCESS;
  }

  // Check that the event time has been defined
  if ( !validEventTime() ) {
    warning() << "Cannot update DataObject: event time undefined" << endmsg;
    return StatusCode::SUCCESS;
  }

  // No need to update if condition is valid
  if ( condition->isValid( eventTime() ) ) {
    DEBMSG << "DataObject is valid: no need to update" << endmsg;
    return StatusCode::SUCCESS;
  }

  DEBMSG << "DataObject is invalid: update it" << endmsg;
  // TODO: before loading updated object, update HERE its parent in data store

  // Now delegate update to the conversion service by calling the base class
  DEBMSG << "Delegate update to relevant conversion service" << endmsg;
  StatusCode status = TsDataSvc::updateObject( toUpdate );
  if ( !status.isSuccess() ) {
    error() << "Could not update DataObject" << endmsg;
    if ( status == NO_DATA_LOADER ) error() << "There is no data loader" << endmsg;
    return status;
  }

  // Now cross-check that the new condition is valid
  condition = dynamic_cast<IValidity*>( toUpdate );
  if ( !condition ) {
    error() << "Updated DataObject does not implement IValidity" << endmsg;
    return StatusCode::FAILURE;
  }
  if ( FSMState() == Gaudi::StateMachine::RUNNING && !condition->isValid( eventTime() ) ) {
    error() << "Updated DataObject is not valid" << endmsg;
    error() << "Are you sure the conversion service has updated it?" << endmsg;
    return StatusCode::FAILURE;
  }

  // DataObject was successfully updated
  DEBMSG << "Method updateObject exiting successfully" << endmsg;
  return StatusCode::SUCCESS;
}

bool DetDataSvc::validEventTime ( ) const

override

Check if the event time has been set.

Kept for backward compatibility, returns always true.

Definition at line 190 of file DetDataSvc.cpp.

{ return true; }

Member Data Documentation

SmartIF<IAddressCreator> DetDataSvc::m_addrCreator = nullptr

private

Address Creator to be used.

Definition at line 111 of file DetDataSvc.h.

Gaudi::Property<bool> DetDataSvc::m_allowLoadInRunning

private

Initial value:

{this, "AllowLoadInRunning", true,
                                             "if set to false, no new object can be loaded while in running state "
                                             "(updates are still allowed), this forces preloading of the geometry"}

Definition at line 103 of file DetDataSvc.h.

Gaudi::Property<std::string> DetDataSvc::m_detDbLocation

private

Initial value:

{this, "DetDbLocation", "empty",
                                               "location of detector Db (filename,URL)"}

Definition at line 96 of file DetDataSvc.h.

Gaudi::Property<std::string> DetDataSvc::m_detDbRootName {this, "DetDbRootName", "dd", "name of the root node of the detector"}

private

Definition at line 98 of file DetDataSvc.h.

Gaudi::Property<int> DetDataSvc::m_detStorageType

private

Initial value:

{this, "DetStorageType", XML_StorageType,
                                        "Detector Data Persistency Storage type"}

Definition at line 94 of file DetDataSvc.h.

Gaudi::Time DetDataSvc::m_eventTime = 0

private

Current event time.

Definition at line 108 of file DetDataSvc.h.

Gaudi::Property<std::string> DetDataSvc::m_persistencySvcName

private

Initial value:

{this, "PersistencySvc", "DetectorPersistencySvc",
                                                    "name of the persistency service"}

Definition at line 100 of file DetDataSvc.h.

Gaudi::Property<bool> DetDataSvc::m_usePersistency {this, "UsePersistency", false, "control if the persistency is required"}

private

Definition at line 99 of file DetDataSvc.h.

---

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

• GaudiSvc/src/DetectorDataSvc/DetDataSvc.h
• GaudiSvc/src/DetectorDataSvc/DetDataSvc.cpp