DetDataSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef DETECTORDATASVC_DETDATASVC_H
#define DETECTORDATASVC_DETDATASVC_H

// Base classes
//#include "GaudiKernel/DataSvc.h"
// D. Piparo: Change to the new thread safe version
#include "GaudiKernel/IDetDataSvc.h"
#include "GaudiKernel/IIncidentListener.h"
#include "GaudiKernel/IRegistry.h"
#include "GaudiKernel/Time.h"
#include "GaudiKernel/TsDataSvc.h"

// Forward declarations
class StatusCode;
class IAddressCreator;

 //--------------------------------------------------------------------------

class DetDataSvc : public extends<TsDataSvc, IDetDataSvc, IIncidentListener> {

  // unhides DataSvc updateObject methods
  using TsDataSvc::updateObject;

public:
  // Overloaded DataSvc methods

  StatusCode initialize() override;

  StatusCode reinitialize() override;

  StatusCode finalize() override;

  StatusCode clearStore() override;

  StatusCode updateObject( DataObject* toUpdate ) override;

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

  ~DetDataSvc() override = default;

private:
  StatusCode setupDetectorDescription();

  using TsDataSvc::loadObject;
  StatusCode loadObject( IConversionSvc* pLoader, IRegistry* pNode ) override final {
    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;
  }

public:
  // Implementation of the IDetDataSvc interface

  bool validEventTime() const override;

  const Gaudi::Time& eventTime() const override;

  void setEventTime( const Gaudi::Time& time ) override;

public:
  // Implementation of the IIncidentListener interface

  void handle( const Incident& ) override;

private:
  Gaudi::Property<int>         m_detStorageType{this, "DetStorageType", XML_StorageType,
                                        "Detector Data Persistency Storage type"};
  Gaudi::Property<std::string> m_detDbLocation{this, "DetDbLocation", "empty",
                                               "location of detector Db (filename,URL)"};
  Gaudi::Property<std::string> m_detDbRootName{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"};
  Gaudi::Property<bool> m_usePersistency{this, "UsePersistency", false, "control if the persistency is required"};
  Gaudi::Property<std::string> m_persistencySvcName{this, "PersistencySvc", "DetectorPersistencySvc",
                                                    "name of the persistency service"};

  Gaudi::Property<bool> m_allowLoadInRunning{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"};

  Gaudi::Time m_eventTime = 0;

  SmartIF<IAddressCreator> m_addrCreator = nullptr;
};

#endif // DETECTORDATASVC_DETDATASVC_H