A DataSvc specialized in detector data. More...

#include <DetectorDataSvc/DetDataSvc.h>

Inheritance diagram for DetDataSvc:

[legend]

Collaboration diagram for DetDataSvc:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialize the service.

StatusCode	reinitialize () override
	Initialize the service.

StatusCode	finalize () override
	Finalize the service.

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

StatusCode	updateObject (DataObject *toUpdate) override
	Update object.

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

	~DetDataSvc () override=default
	Standard Destructor.

bool	validEventTime () const override
	Check if the event time has been set.

const Gaudi::Time &	eventTime () const override
	Get the event time.

void	setEventTime (const Gaudi::Time &time) override
	Set the new event time.

void	handle (const Incident &) override
	Inform that a new incident has occured.

Public Member Functions inherited from extends< TsDataSvc, IDetDataSvc, IIncidentListener >
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 TsDataSvc
CLID	rootCLID () const override
	IDataManagerSvc: Accessor for root event CLID.

const std::string &	rootName () const override
	IDataManagerSvc: Accessor for root event name.

StatusCode	registerAddress (std::string_view fullPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store.

StatusCode	registerAddress (IRegistry parentObj, std::string_view objectPath, IOpaqueAddress pAddress) override
	IDataManagerSvc: Register object address with the data store.

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

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

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

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

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

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

StatusCode	clearSubTree (std::string_view sub_tree_path) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by its full path name.

StatusCode	clearSubTree (DataObject *pObject) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by the object.

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

StatusCode	traverseSubTree (std::string_view sub_tree_path, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree identified by its full path name.

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

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

StatusCode	setRoot (std::string root_name, DataObject *pRootObj) override
	Initialize data store for new event by giving new event path and root object.

virtual StatusCode	i_setRoot (std::string root_name, DataObject *pRootObj)
	Initialize data store for new event by giving new event path and root object.

StatusCode	i_setRoot (DataObject *pRootObj)

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.

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.

StatusCode	i_setRoot (IOpaqueAddress *pRootAddr)

StatusCode	setDataLoader (IConversionSvc svc, IDataProviderSvc dpsvc=nullptr) override
	IDataManagerSvc: IDataManagerSvc: Pass a default data loader to the service and optionally a data provider.

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

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

StatusCode	resetPreLoad () override
	Clear the preload list.

virtual StatusCode	preLoad (int depth, int load_depth, DataObject *pObject)
	Execute one level of preloading and recursively load until the final level is reached.

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

StatusCode	registerObject (std::string_view parentPath, std::string_view objPath, DataObject *pObject) override
	Register object with the data store.

StatusCode	registerObject (DataObject parentObj, std::string_view objPath, DataObject pObject) override
	Register object with the data store.

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

StatusCode	unregisterObject (DataObject *pObject) override
	Unregister object from the data store.

StatusCode	unregisterObject (DataObject *pObject, std::string_view objectPath) override
	Unregister object from the data store.

StatusCode	retrieveObject (IRegistry pDirectory, std::string_view path, DataObject &pObject) override
	Retrieve object from data store.

StatusCode	findObject (std::string_view fullPath, DataObject *&pObject) override
	Find object identified by its full path in the data store.

StatusCode	findObject (IRegistry pDirectory, std::string_view path, DataObject &pObject) override
	Find object identified by its full path in the data store.

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

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

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

StatusCode	unlinkObject (DataObject *fromObj, std::string_view objPath) override
	Remove a link to another object.

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

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

StatusCode	updateObject (DataObject *toUpdate) override
	Update object.

StatusCode	initialize () override
	Service initialization.

StatusCode	reinitialize () override
	Service initialization.

StatusCode	finalize () override
	Service initialization.

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

	TsDataSvc (const TsDataSvc &)=delete
	no copy constructor

TsDataSvc &	operator= (const TsDataSvc &)=delete
	no assignment operator

StatusCode	registerAddress (DataObject parentObj, std::string_view objectPath, IOpaqueAddress pAddress)
	Register object address with the data store.

StatusCode	unregisterAddress (DataObject *pParent, std::string_view objPath)
	Unregister object address from the data store.

StatusCode	registerObject (std::string_view fullPath, DataObject *pObject)
	Register object with the data store.

StatusCode	registerObject (std::string_view parentPath, int item, DataObject *pObject)
	Register object with the data store.

StatusCode	registerObject (DataObject parentObj, int item, DataObject pObject)
	Register object with the data store.

StatusCode	retrieveObject (std::string_view fullPath, DataObject *&pObject)
	Retrieve object identified by its full path from the data store.

StatusCode	retrieveObject (std::string_view parentPath, std::string_view objectPath, DataObject *&pObject)
	Retrieve object from data store.

StatusCode	retrieveObject (std::string_view parentPath, int item, DataObject *&pObject)
	Retrieve object from data store.

StatusCode	retrieveObject (DataObject parentObj, std::string_view objectPath, DataObject &pObject)
	Retrieve object from data store.

StatusCode	retrieveObject (DataObject parentObj, int item, DataObject &pObject)
	Retrieve object from data store.

StatusCode	findObject (std::string_view parentPath, std::string_view objectPath, DataObject *&pObject)
	Find object identified by its parent object and the path to the object relative to the parent.

StatusCode	findObject (std::string_view parentPath, int item, DataObject *&pObject)
	Find object identified by its parent object and an integer identifier in the data store.

StatusCode	findObject (DataObject parentObj, std::string_view objectPath, DataObject &pObject)
	Find object identified by its parent object and the path to the object relative to the parent.

StatusCode	findObject (DataObject parentObj, int item, DataObject &pObject)
	Find object identified by its parent object and an integer identifier in the data store.

StatusCode	linkObject (std::string_view fromPath, std::string_view objPath, DataObject *toObj)
	Add a link to another object.

StatusCode	linkObject (DataObject fromObj, std::string_view objPath, DataObject toObj)
	Add a link to another object.

StatusCode	unlinkObject (std::string_view fromPath, std::string_view objPath)
	Remove a link to another object.

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

Private Member Functions
StatusCode	setupDetectorDescription ()
	Deal with Detector Description initialization.

StatusCode	loadObject (IConversionSvc pLoader, IRegistry pNode) override final
	Invoke Persistency service to create transient object from its persistent representation.

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

virtual StatusCode	loadObject (IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation.

Private Attributes
Gaudi::Property< int >	m_detStorageType

Gaudi::Property< std::string >	m_detDbLocation

Gaudi::Property< std::string >	m_detDbRootName

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.

SmartIF< IAddressCreator >	m_addrCreator = nullptr
	Address Creator to be used.

Additional Inherited Members
Public Types inherited from extends< TsDataSvc, IDetDataSvc, IIncidentListener >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
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 TsDataSvc
bool	checkRoot ()
	Check if root path is valid.

virtual IConversionSvc *	getDataLoader (IRegistry *pReg)
	Retrieve customizable data loader according to registry entry to be retrieved.

virtual DataObject *	createDefaultObject () const
	Create default objects in case forced creation of leaves is requested.

StatusCode	retrieveEntry (DataSvcHelpers::RegistryEntry pNode, std::string_view path, DataSvcHelpers::RegistryEntry &pEntry)
	Retrieve registry entry from store.

DataObject *	handleDataFault (IRegistry *pReg, std::string_view path={})
	Invoke data fault handling if enabled.

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 TsDataSvc
tsDataSvcMutex	m_accessMutex
	Mutex to protect access to the store.

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

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 38 of file DetDataSvc.h.

Constructor & Destructor Documentation

◆ DetDataSvc()

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

Standard Constructor.

Definition at line 176 of file DetDataSvc.cpp.

                                                                : extends( name, svc ) {
  setProperty( "RootCLID", CLID_Catalog ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
}

◆ ~DetDataSvc()

DetDataSvc::~DetDataSvc ( )

overridedefault

Standard Destructor.

Member Function Documentation

◆ clearStore()

StatusCode DetDataSvc::clearStore ( )

override

Remove all data objects in the data store.

Definition at line 153 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( 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;
}

◆ eventTime()

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

override

Get the event time.

Definition at line 190 of file DetDataSvc.cpp.

190{ return m_eventTime; }

DetDataSvc::m_eventTime

Gaudi::Time m_eventTime

Current event time.

Definition DetDataSvc.h:121

◆ finalize()

StatusCode DetDataSvc::finalize ( )

override

Finalize the service.

Definition at line 135 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();
}

◆ handle()

void DetDataSvc::handle ( const Incident & inc )

override

Inform that a new incident has occured.

Inform that a new incident has occurred.

Definition at line 193 of file DetDataSvc.cpp.

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

◆ initialize()

StatusCode DetDataSvc::initialize ( )

override

Initialize the service.

Definition at line 37 of file DetDataSvc.cpp.

                                  {
  // Call base class initialization
  StatusCode sc = TsDataSvc::initialize();
  if ( sc.isFailure() ) return sc;
 
  // Set Data Loader
  auto cnv_svc = serviceLocator()->service<IConversionSvc>( m_persistencySvcName );
  if ( !cnv_svc ) {
    error() << "Unable to retrieve " << m_persistencySvcName << endmsg;
    return StatusCode::FAILURE;
  }
 
  sc = setDataLoader( cnv_svc );
  if ( sc.isFailure() ) {
    error() << "Unable to set DataLoader" << endmsg;
    return sc;
  }
 
  // Get address creator from the DetectorPersistencySvc
  m_addrCreator = cnv_svc;
  if ( !m_addrCreator ) {
    error() << "Unable to get AddressCreator." << endmsg;
    return StatusCode::FAILURE;
  }
 
  return setupDetectorDescription();
}

◆ loadObject() [1/2]

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 72 of file DetDataSvc.h.

                                                                                    {
    if ( 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;
  }

◆ loadObject() [2/2]

StatusCode TsDataSvc::loadObject ( IRegistry * pNode )

privatevirtual

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

Reimplemented from TsDataSvc.

Definition at line 273 of file TsDataSvc.cpp.

                                                       {
  IConversionSvc* pLoader = getDataLoader( pRegistry );
  return loadObject( pLoader, pRegistry );
}

◆ reinitialize()

StatusCode DetDataSvc::reinitialize ( )

override

Initialize the service.

Definition at line 117 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;
}

◆ setEventTime()

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

override

Set the new event time.

Definition at line 181 of file DetDataSvc.cpp.

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

◆ setupDetectorDescription()

StatusCode DetDataSvc::setupDetectorDescription ( )

private

Deal with Detector Description initialization.

Todo: : remove references to obsolete package XMLDDDBROOT

Definition at line 65 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() || m_detDbLocation == "empty" ) {
 
      // 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() || m_detDbLocation == "empty" ) {
      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( 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;
}

◆ updateObject() [1/2]

StatusCode DetDataSvc::updateObject ( DataObject * toUpdate )

override

Update object.

Todo: update also its ancestors in the data store if necessary

Definition at line 203 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 Status::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 == 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;
}

◆ updateObject() [2/2]

StatusCode TsDataSvc::updateObject ( IRegistry * pDirectory )

overrideprivate

Update object identified by its directory entry.

Update object.

Definition at line 236 of file TsDataSvc.cpp.

                                                         {
  if ( !pRegistry ) return Status::INVALID_OBJ_ADDR; // Precondition: Addres must be valid
  DataObject* toUpdate = pRegistry->object();
  return toUpdate ? updateObject( toUpdate ) : loadObject( pRegistry );
}

◆ validEventTime()

bool DetDataSvc::validEventTime ( ) const

override

Check if the event time has been set.

Kept for backward compatibility, returns always true.

Definition at line 187 of file DetDataSvc.cpp.

187{ return true; }

Member Data Documentation

◆ m_addrCreator

SmartIF<IAddressCreator> DetDataSvc::m_addrCreator = nullptr

private

Address Creator to be used.

Definition at line 124 of file DetDataSvc.h.

◆ m_allowLoadInRunning

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 116 of file DetDataSvc.h.

                                          { 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" };

◆ m_detDbLocation

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

private

Initial value:

{ this, "DetDbLocation", "empty",

"location of detector Db (filename,URL)" }

Definition at line 102 of file DetDataSvc.h.

102 { this, "DetDbLocation", "empty",

103 "location of detector Db (filename,URL)" };

◆ m_detDbRootName

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

private

Initial value:

{ this,
                                                "DetDbRootName",
                                                "dd",
                                                [this]( Gaudi::Details::PropertyBase& ) {
                                                  this->setProperty( "RootName", "/" + this->m_detDbRootName ).ignore();
                                                },
                                                Gaudi::Details::Property::ImmediatelyInvokeHandler{ true },
                                                "name of the root node of the detector" }

Definition at line 104 of file DetDataSvc.h.

                                          { this,
                                                "DetDbRootName",
                                                "dd",
                                                [this]( Gaudi::Details::PropertyBase& ) {
                                                  this->setProperty( "RootName", "/" + this->m_detDbRootName ).ignore();
                                                },
                                                Gaudi::Details::Property::ImmediatelyInvokeHandler{ true },
                                                "name of the root node of the detector" };

◆ m_detStorageType

Gaudi::Property<int> DetDataSvc::m_detStorageType

private

Initial value:

{ this, "DetStorageType", XML_StorageType,

"Detector Data Persistency Storage type" }

XML_StorageType

const long XML_StorageType

Definition ClassID.h:65

Definition at line 100 of file DetDataSvc.h.

100 { this, "DetStorageType", XML_StorageType,

101 "Detector Data Persistency Storage type" };

◆ m_eventTime

Gaudi::Time DetDataSvc::m_eventTime = 0

private

Current event time.

Definition at line 121 of file DetDataSvc.h.

◆ m_persistencySvcName

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

private

Initial value:

{ this, "PersistencySvc", "DetectorPersistencySvc",

"name of the persistency service" }

Definition at line 113 of file DetDataSvc.h.

113 { this, "PersistencySvc", "DetectorPersistencySvc",

114 "name of the persistency service" };

◆ m_usePersistency

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

private

Definition at line 112 of file DetDataSvc.h.

112{ this, "UsePersistency", false, "control if the persistency is required" };

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DetDataSvc()

◆ ~DetDataSvc()

Member Function Documentation

◆ clearStore()

◆ eventTime()

◆ finalize()

◆ handle()

◆ initialize()

◆ loadObject() [1/2]

◆ loadObject() [2/2]

◆ reinitialize()

◆ setEventTime()

◆ setupDetectorDescription()

◆ updateObject() [1/2]

◆ updateObject() [2/2]

◆ validEventTime()

Member Data Documentation

◆ m_addrCreator

◆ m_allowLoadInRunning

◆ m_detDbLocation

◆ m_detDbRootName

◆ m_detStorageType

◆ m_eventTime

◆ m_persistencySvcName

◆ m_usePersistency