Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

DetDataSvc Class Reference

#include <DetectorDataSvc/DetDataSvc.h>

Inheritance diagram for DetDataSvc:

[legend]Collaboration diagram for DetDataSvc:

[legend]List of all members.

---

Detailed Description

A DataSvc specialised in detector data.

Author:

Marco Clemencic (previous author unknown)

Definition at line 24 of file DetDataSvc.h.

Public Member Functions
virtual StatusCode	initialize ()
	Initialize the service.
virtual StatusCode	reinitialize ()
	Initialize the service.
virtual StatusCode	finalize ()
	Finalize the service.
virtual StatusCode	clearStore ()
	Remove all data objects in the data store.
virtual StatusCode	updateObject (DataObject *toUpdate)
	Update object.
	DetDataSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor.
virtual	~DetDataSvc ()
	Standard Destructor.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)
	Query the interface of the service.
virtual const bool	validEventTime () const
	Check if the event time has been set.
virtual const Gaudi::Time &	eventTime () const
	Get the event time.
virtual void	setEventTime (const Gaudi::Time &time)
	Set the new event time.
virtual void	handle (const Incident &)
	Inform that a new incident has occured.
Private Member Functions
StatusCode	setupDetectorDescription ()
	Deal with Detector Description initialization.
Private Attributes
int	m_detStorageType
	Detector Data Persistency Storage type.
std::string	m_detDbLocation
	Location of detector Db (filename,URL).
std::string	m_detDbRootName
	Name of the root node of the detector.
std::string	m_persistencySvcName
	Name of the persistency service.
bool	m_usePersistency
	Flag to control if the persistency is required.
Gaudi::Time	m_eventTime
	Current event time.
IAddressCreator *	m_addrCreator
	Address Creator to be used.
Friends
class	SvcFactory< DetDataSvc >

---

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 208 of file DetDataSvc.cpp.

References CLID_Catalog, Service::declareProperty(), m_addrCreator, m_detDbLocation, m_detDbRootName, m_detStorageType, m_persistencySvcName, DataSvc::m_rootCLID, DataSvc::m_rootName, m_usePersistency, and XML_StorageType.

                                                             :
  DataSvc(name,svc), m_eventTime(0)  {
  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;
  m_addrCreator = 0;
}

DetDataSvc::~DetDataSvc

(

)

[virtual]

Standard Destructor.

Definition at line 221 of file DetDataSvc.cpp.

                         {
}

---

Member Function Documentation

StatusCode DetDataSvc::initialize

(

)

[virtual]

Initialize the service.

Reimplemented from DataSvc.

Definition at line 20 of file DetDataSvc.cpp.

References endreq(), MSG::ERROR, StatusCode::FAILURE, IID_IAddressCreator, DataSvc::initialize(), StatusCode::isFailure(), name, IInterface::queryInterface(), and IInterface::release().

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

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

  // Set Data Loader
  IConversionSvc* cnv_svc;
  sc = serviceLocator()->service(m_persistencySvcName, cnv_svc, true);
  if( sc .isFailure() ) {
    log << MSG::ERROR << "Unable to retrieve " << m_persistencySvcName << endreq;
    return sc;
  }

  sc = setDataLoader( cnv_svc );
  cnv_svc->release();
  if( sc .isFailure() ) {
    log << MSG::ERROR << "Unable to set DataLoader" << endreq;
    return sc;
  }

  // Get address creator fron the DetectorPersistencySvc
  sc = cnv_svc->queryInterface(IID_IAddressCreator, pp_cast<void>(&m_addrCreator));
  if (sc.isFailure()) {
    log << MSG::ERROR << "Unable to get AddressCreator." << endreq; 
    return StatusCode::FAILURE; 
  }

  return setupDetectorDescription();
}

StatusCode DetDataSvc::reinitialize

(

)

[virtual]

Initialize the service.

Reimplemented from DataSvc.

Definition at line 114 of file DetDataSvc.cpp.

References Service::msgSvc(), Service::name(), and StatusCode::SUCCESS.

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

  // 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;
}

StatusCode DetDataSvc::finalize

(

)

[virtual]

Finalize the service.

Reimplemented from DataSvc.

Definition at line 134 of file DetDataSvc.cpp.

References clearStore(), MSG::DEBUG, endreq(), DataSvc::finalize(), StatusCode::ignore(), m_addrCreator, m_usePersistency, Service::msgSvc(), Service::name(), IInterface::release(), and DataSvc::setDataLoader().

{
  MsgStream log(msgSvc(), name());
  log << MSG::DEBUG << "Finalizing" << endreq;

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

  // Releases the address creator
  if (0 != m_addrCreator) {
    m_addrCreator->release();
  }

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

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

StatusCode DetDataSvc::clearStore

(

)

[virtual]

Remove all data objects in the data store.

Reimplemented from DataSvc.

Definition at line 173 of file DetDataSvc.cpp.

References DataSvc::clearStore(), CLID_Catalog, IAddressCreator::createAddress(), endreq(), MSG::ERROR, DataSvc::i_setRoot(), StatusCode::ignore(), StatusCode::isFailure(), StatusCode::isSuccess(), m_addrCreator, m_detDbLocation, m_detDbRootName, m_detStorageType, m_usePersistency, Service::msgSvc(), Service::name(), and StatusCode::SUCCESS.

Referenced by finalize().

                                    {

  MsgStream log(msgSvc(), name());
  
  DataSvc::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() ) {
      std::string dbrName = "/" + m_detDbRootName;
      sc = i_setRoot( dbrName, rootAddr );
      if( sc.isFailure() ) {
        log << MSG::ERROR 
            << "Unable to set detector data store root" << endreq;
      }
    } else {
      log << MSG::ERROR << "Unable to create address for  /dd" << endreq;
    }
    return sc;

  }
  return StatusCode::SUCCESS;

}

StatusCode DetDataSvc::updateObject

(

DataObject *

toUpdate

)

[virtual]

Update object.

Todo:

update also its ancestors in the data store if necessary

Reimplemented from DataSvc.

Definition at line 255 of file DetDataSvc.cpp.

References MSG::DEBUG, endreq(), MSG::ERROR, eventTime(), StatusCode::FAILURE, IDataProviderSvc::INVALID_OBJECT, StatusCode::isSuccess(), IValidity::isValid(), Service::msgSvc(), Service::name(), IDataProviderSvc::NO_DATA_LOADER, StatusCode::SUCCESS, DataSvc::updateObject(), validEventTime(), and MSG::WARNING.

                                                          {

  MsgStream log( msgSvc(), name() );
  log << MSG::DEBUG << "Method updateObject starting" << endreq;

  // Check that object to update exists
  if ( 0 == toUpdate ) { 
    log << MSG::ERROR
        << "There is no DataObject to update" << endreq;
    return INVALID_OBJECT; 
  }

  // Retrieve IValidity interface of object to update
  IValidity* condition = dynamic_cast<IValidity*>( toUpdate );
  if ( 0 == condition ) {
    log << MSG::WARNING
        << "Cannot update DataObject: DataObject does not implement IValidity"
        << endreq;
    return StatusCode::SUCCESS;
  }

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

  // No need to update if condition is valid
  if ( condition->isValid( eventTime() ) ) {
    log << MSG::DEBUG 
        << "DataObject is valid: no need to update" << endreq;
    return StatusCode::SUCCESS;
  } else {
    log << MSG::DEBUG 
        << "DataObject is invalid: update it" << endreq;
  }

  // TODO: before loading updated object, update HERE its parent in data store

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

  // Now cross-check that the new condition is valid
  condition = dynamic_cast<IValidity*>(toUpdate);
  if ( 0 == condition ) {
    log << MSG::ERROR
        << "Updated DataObject does not implement IValidity" << endreq;
    return StatusCode::FAILURE;
  }
  if ( !condition->isValid( eventTime() ) ) {
    log << MSG::ERROR
        << "Updated DataObject is not valid" << endreq;
    log << MSG::ERROR
        << "Are you sure the conversion service has updated it?" << endreq;
    return StatusCode::FAILURE;
  } 

  // DataObject was successfully updated
  log << MSG::DEBUG << "Method updateObject exiting successfully" << endreq;
  return StatusCode::SUCCESS;

}

StatusCode DetDataSvc::setupDetectorDescription

(

)

[private]

Deal with Detector Description initialization.

Definition at line 52 of file DetDataSvc.cpp.

References MSG::ALWAYS, CLID_Catalog, IAddressCreator::createAddress(), MSG::DEBUG, std::basic_string< _CharT, _Traits, _Alloc >::empty(), endreq(), MSG::ERROR, StatusCode::FAILURE, DataSvc::i_setRoot(), MSG::INFO, StatusCode::isFailure(), StatusCode::isSuccess(), m_addrCreator, m_detDbLocation, m_detDbRootName, m_detStorageType, m_usePersistency, Service::msgSvc(), Service::name(), and StatusCode::SUCCESS.

                                                {
  // Now you can use the MsgSvc
  MsgStream log(msgSvc(), name());

  // Initialize the detector data transient store
  log << MSG::DEBUG << "Storage type used is: " << m_detStorageType << endreq;
  log << MSG::DEBUG << "Setting DetectorDataSvc root node... " << endreq;
  
  if( m_usePersistency ) {

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

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

      if ( 0 != getenv("XMLDDDBROOT") ) {
        m_detDbLocation  = getenv("XMLDDDBROOT");
        m_detDbLocation += "/DDDB/lhcb.xml";
      }
    }
    if( m_detDbLocation.empty() || "empty" == m_detDbLocation ) { 
      log << MSG::ERROR
          << "Detector data location name not set. Detector data will "
          << "not be found." << endreq;
      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() ) {
        std::string dbrName = "/" + m_detDbRootName;
        sc = i_setRoot( dbrName, rootAddr );
        if( sc.isFailure() ) {
          log << MSG::ERROR << "Unable to set detector data store root"
              << endreq;
          return sc;
        }
      }
      else {
        log << MSG::ERROR << "Unable to create address for  /dd" << endreq;
        return sc;
      }
    }
    // Writing the description file in the output log file [bugs #2854]
    log << MSG::ALWAYS << "Detector description database: " << m_detDbLocation << endreq;
  }
  else {
    log << MSG::INFO << "Detector description not requested to be loaded"
        << endreq;
  }

  return StatusCode::SUCCESS;
}

StatusCode DetDataSvc::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			[virtual]

Query the interface of the service.

Reimplemented from DataSvc.

Definition at line 156 of file DetDataSvc.cpp.

References IInterface::addRef(), IID_IDetDataSvc, IID_IIncidentListener, DataSvc::queryInterface(), StatusCode::SUCCESS, and InterfaceID::versionMatch().

{
  // With the highest priority return the specific interfaces
  // If interfaces are not directly available, try out a base class
  if ( IID_IDetDataSvc.versionMatch(riid) ) {
    *ppvInterface = (IDetDataSvc*)this;
  } else if ( IID_IIncidentListener.versionMatch(riid) ) {
    *ppvInterface = (IIncidentListener*)this;
  } else {
    return DataSvc::queryInterface(riid, ppvInterface);
  }
  addRef();
  return StatusCode::SUCCESS;
}

const bool DetDataSvc::validEventTime

(

)

const [virtual]

Check if the event time has been set.

Kept for backward compatibility, returns always true.

Implements IDetDataSvc.

Definition at line 235 of file DetDataSvc.cpp.

Referenced by updateObject().

                                              { 
  return true; 
}

const Gaudi::Time & DetDataSvc::eventTime

(

)

const [virtual]

Get the event time.

Implements IDetDataSvc.

Definition at line 240 of file DetDataSvc.cpp.

References m_eventTime.

Referenced by setEventTime(), and updateObject().

                                               { 
  return m_eventTime; 
}

void DetDataSvc::setEventTime

(

const Gaudi::Time &

time

)

[virtual]

Set the new event time.

Implements IDetDataSvc.

Definition at line 225 of file DetDataSvc.cpp.

References MSG::DEBUG, endmsg(), eventTime(), m_eventTime, Service::msgSvc(), Service::name(), and Service::outputLevel().

                                                      {
  // m_eventTime = TimePoint( time );
  m_eventTime = time;
  if ( msgSvc()->outputLevel() <= MSG::DEBUG) {
    MsgStream log( msgSvc(), name() );
    log << MSG::DEBUG << "Event Time set to " << eventTime() << endmsg;
  }
}

void DetDataSvc::handle

(

const Incident &

)

[virtual]

Inform that a new incident has occured.

Implements IIncidentListener.

Definition at line 245 of file DetDataSvc.cpp.

References MSG::DEBUG, endreq(), Service::msgSvc(), Service::name(), Incident::source(), and Incident::type().

                                              { 
  MsgStream log( msgSvc(), name() );
  log << MSG::DEBUG << "New incident received" << endreq;
  log << MSG::DEBUG << "Incident source: " << inc.source() << endreq;
  log << MSG::DEBUG << "Incident type: " << inc.type() << endreq;
  return; 
}

---

Friends And Related Function Documentation

friend class SvcFactory< DetDataSvc > [friend]

Definition at line 29 of file DetDataSvc.h.

---

Member Data Documentation

int DetDataSvc::m_detStorageType [private]

Detector Data Persistency Storage type.

Definition at line 95 of file DetDataSvc.h.

Referenced by clearStore(), DetDataSvc(), and setupDetectorDescription().

std::string DetDataSvc::m_detDbLocation [private]

Location of detector Db (filename,URL).

Definition at line 98 of file DetDataSvc.h.

Referenced by clearStore(), DetDataSvc(), and setupDetectorDescription().

std::string DetDataSvc::m_detDbRootName [private]

Name of the root node of the detector.

Definition at line 101 of file DetDataSvc.h.

Referenced by clearStore(), DetDataSvc(), and setupDetectorDescription().

std::string DetDataSvc::m_persistencySvcName [private]

Name of the persistency service.

Definition at line 104 of file DetDataSvc.h.

Referenced by DetDataSvc().

bool DetDataSvc::m_usePersistency [private]

Flag to control if the persistency is required.

Definition at line 107 of file DetDataSvc.h.

Referenced by clearStore(), DetDataSvc(), finalize(), and setupDetectorDescription().

Gaudi::Time DetDataSvc::m_eventTime [private]

Current event time.

Definition at line 110 of file DetDataSvc.h.

Referenced by eventTime(), and setEventTime().

IAddressCreator* DetDataSvc::m_addrCreator [private]

Address Creator to be used.

Definition at line 113 of file DetDataSvc.h.

Referenced by clearStore(), DetDataSvc(), finalize(), and setupDetectorDescription().

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/DetectorDataSvc/DetDataSvc.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/DetectorDataSvc/DetDataSvc.cpp

---