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< BASE, Interfaces >
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...
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 extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

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

Private Attributes
int	m_detStorageType = XML_StorageType
	Detector Data Persistency Storage type. More...
std::string	m_detDbLocation = "empty"
	Location of detector Db (filename,URL) More...
std::string	m_detDbRootName = "dd"
	Name of the root node of the detector. More...
std::string	m_persistencySvcName = "DetectorPersistencySvc"
	Name of the persistency service. More...
bool	m_usePersistency = false
	Flag to control if the persistency is required. More...
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< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
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 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...
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

---

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

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 183 of file DetDataSvc.cpp.

                                                             :
  base_class(name,svc) {
  declareProperty("DetStorageType",  m_detStorageType = XML_StorageType );
  declareProperty("DetDbLocation",   m_detDbLocation  = "empty" );
  declareProperty("DetDbRootName",   m_detDbRootName  = "dd" );
  declareProperty("UsePersistency",  m_usePersistency = false );
  declareProperty("PersistencySvc",  m_persistencySvcName = "DetectorPersistencySvc" );
  m_rootName = "/dd";
  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 150 of file DetDataSvc.cpp.

                                    {

  MsgStream log(msgSvc(), name());

  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_detDbRootName, 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 206 of file DetDataSvc.cpp.

                                               {
  return m_eventTime;
}

StatusCode DetDataSvc::finalize ( )

override

Finalize the service.

Definition at line 131 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 211 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::reinitialize ( )

override

Initialize the service.

Definition at line 113 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 195 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 55 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") ) {
        m_detDbLocation  = getEnv("XMLDDDBROOT");
        m_detDbLocation += "/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_detDbRootName, 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 << 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 221 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 201 of file DetDataSvc.cpp.

                                        {
  return true;
}

Member Data Documentation

SmartIF<IAddressCreator> DetDataSvc::m_addrCreator = nullptr

private

Address Creator to be used.

Definition at line 105 of file DetDataSvc.h.

std::string DetDataSvc::m_detDbLocation = "empty"

private

Location of detector Db (filename,URL)

Definition at line 90 of file DetDataSvc.h.

std::string DetDataSvc::m_detDbRootName = "dd"

private

Name of the root node of the detector.

Definition at line 93 of file DetDataSvc.h.

int DetDataSvc::m_detStorageType = XML_StorageType

private

Detector Data Persistency Storage type.

Definition at line 87 of file DetDataSvc.h.

Gaudi::Time DetDataSvc::m_eventTime = 0

private

Current event time.

Definition at line 102 of file DetDataSvc.h.

std::string DetDataSvc::m_persistencySvcName = "DetectorPersistencySvc"

private

Name of the persistency service.

Definition at line 96 of file DetDataSvc.h.

bool DetDataSvc::m_usePersistency = false

private

Flag to control if the persistency is required.

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