DataOnDemandSvc Class Reference

The DataOnDemandSvc listens to incidents typically triggered by the data service of the configurable name "IncidentName". More...

#include <src/IncidentSvc/DataOnDemandSvc.h>

Inheritance diagram for DataOnDemandSvc:

Collaboration diagram for DataOnDemandSvc:

Classes
struct	Leaf
struct	Node
	Helper class of the DataOnDemandSvc. More...
struct	Protection
	Helper class of the DataOnDemandSvc. More...

Public Types
typedef std::vector< std::string >	Setup
typedef TClass *	ClassH
typedef GaudiUtils::HashMap< Gaudi::StringKey, Node >	NodeMap
typedef GaudiUtils::HashMap< Gaudi::StringKey, Leaf >	AlgMap
Public Types inherited from extends< Service, 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 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...

Public Member Functions
StatusCode	initialize () override
	Inherited Service overrides: Service initialization. More...
StatusCode	finalize () override
	Inherited Service overrides: Service finalization. More...
StatusCode	reinitialize () override
	Inherited Service overrides: Service reinitialization. More...
void	handle (const Incident &incident) override
	IIncidentListener interfaces overrides: incident handling. More...
	DataOnDemandSvc (const std::string &name, ISvcLocator *svc)
	Standard initializing service constructor. More...
	~DataOnDemandSvc () override=default
	Standard destructor. More...
Public Member Functions inherited from extends< Service, 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 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...

Protected Member Functions
StatusCode	configureHandler (Leaf &leaf)
	Configure handler for leaf. More...
StatusCode	execHandler (const std::string &tag, Leaf &leaf)
	Execute leaf handler (algorithm) More...
StatusCode	execHandler (const std::string &tag, Node &node)
	Execute node handler (simple object creation using seal reflection) More...
StatusCode	setupNodeHandlers ()
	Initialize node handlers. More...
StatusCode	setupAlgHandlers ()
	Initialize leaf handlers. More...
StatusCode	setup ()
	Setup routine (called by (re-) initialize. More...
void	i_setNodeHandler (const std::string &name, const std::string &type)
	Internal method to initialize a node handler. More...
StatusCode	i_setAlgHandler (const std::string &name, const Gaudi::Utils::TypeNameString &alg)
	Internal method to initialize an algorithm handler. More...
StatusCode	update ()
	update the handlers More...
void	dump (const MSG::Level level, const bool mode=true) const
	dump the content of DataOnDemand service 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...

Private Types
typedef std::map< std::string, std::string >	Map

Private Attributes
SmartIF< IIncidentSvc >	m_incSvc = nullptr
	Incident service. More...
SmartIF< IAlgManager >	m_algMgr = nullptr
	Algorithm manager. More...
SmartIF< IDataProviderSvc >	m_dataSvc = nullptr
	Data provider reference. More...
SmartIF< IToolSvc >	m_toolSvc
	Data provider reference. More...
AlgMap	m_algs
	Map of algorithms to handle incidents. More...
NodeMap	m_nodes
	Map of "empty" objects to be placed as intermediate nodes. More...
bool	m_updateRequired = true
ChronoEntity	m_total
ulonglong	m_statAlg = 0
ulonglong	m_statNode = 0
ulonglong	m_stat = 0
ChronoEntity	m_timer_nodes
ChronoEntity	m_timer_algs
ChronoEntity	m_timer_all
bool	m_locked_nodes = false
bool	m_locked_algs = false
bool	m_locked_all = false
std::vector< IDODNodeMapper * >	m_nodeMappers
std::vector< IDODAlgMapper * >	m_algMappers
Gaudi::Property< std::string >	m_trapType {this, "IncidentName", "DataFault", "the type of handled Incident"}
Gaudi::Property< std::string >	m_dataSvcName {this, "DataSvc", "EventDataSvc", "DataSvc name"}
Gaudi::Property< bool >	m_partialPath {this, "UsePreceedingPath", true, "allow creation of partial leaves"}
Gaudi::Property< bool >	m_dump
Gaudi::Property< bool >	m_init {this, "PreInitialize", false, "(pre)initialize all algorithms"}
Gaudi::Property< bool >	m_allowInitFailure
Gaudi::Property< Setup >	m_algMapping {this, "Algorithms", {}, "[[deprecated]] use AlgMap"}
Gaudi::Property< Setup >	m_nodeMapping {this, "Nodes", {}, "[[deprecated]] use NodeMap"}
Gaudi::Property< Map >	m_algMap {this, "AlgMap", {}, "mapping {'data': 'algorithm'}"}
Gaudi::Property< Map >	m_nodeMap {this, "NodeMap", {}, "mapping {'data': 'type'}"}
Gaudi::Property< std::string >	m_prefix {this, "Prefix", "/Event/"}
Gaudi::Property< std::vector< std::string > >	m_nodeMapTools
Gaudi::Property< std::vector< std::string > >	m_algMapTools

Additional Inherited Members
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

The DataOnDemandSvc listens to incidents typically triggered by the data service of the configurable name "IncidentName".

In the job options handlers can be declared, which allow to configure this service. Such handlers are either:

• Node handlers, if objects other than the default object type have to be instantiated. DataOnDemandSvc.Nodes = { "DATA='/Event/Rec' TYPE='DataObject'", "DATA='/Event/Rec/Muon' TYPE='DataObject'" };
• Leaf handlers (Algorithms), which get instantiated and executed on demand. DataOnDemandSvc.Algorithms = { "DATA='/Event/Rec/Muon/Digits' TYPE='MuonDigitAlg/MyMuonDigits'" }; If the algorithm name is omitted the class name will be the instance name.

The handlers only get called if the exact path matches. In the event already the partial path to any handler is missing a leaf handler may be triggered, which includes the partial paths ( DataOnDemandSvc.UsePreceedingPath = true )

2006-10-15: New options (using map-like semantics:)

 DataOnDemandSvc.AlgMap  +=
{ "Phys/StdLoosePions/Particles" : "PreLoadParticles/StdLoosePions" ,
  "Phys/StdLoosePions/Vertioces" : "PreLoadParticles/StdLoosePions" } ;

 DataOnDemandSvc.NodeMap +=
{ "Phys" : "DataObject" ,
  "MC"   : "DataObject" } ;

New treatment of preceding paths. for each registered leaf or node the all parent nodes are added into the node-map with default directory type 'DataObject'

The major properties are equipped with handlers (more or less mandatory for interactive work in python)

From now the default prefix ( "/Event/" ) could be omitted from any data-item. It will be added automatically.

Author

M.Frank

Version

1.0

Definition at line 90 of file DataOnDemandSvc.h.

Member Typedef Documentation

typedef GaudiUtils::HashMap<Gaudi::StringKey, Leaf> DataOnDemandSvc::AlgMap

Definition at line 152 of file DataOnDemandSvc.h.

typedef TClass* DataOnDemandSvc::ClassH

Definition at line 96 of file DataOnDemandSvc.h.

typedef std::map<std::string, std::string> DataOnDemandSvc::Map

private

Definition at line 264 of file DataOnDemandSvc.h.

typedef GaudiUtils::HashMap<Gaudi::StringKey, Node> DataOnDemandSvc::NodeMap

Definition at line 151 of file DataOnDemandSvc.h.

typedef std::vector<std::string> DataOnDemandSvc::Setup

Definition at line 95 of file DataOnDemandSvc.h.

Constructor & Destructor Documentation

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

Standard initializing service constructor.

Parameters

name	[IN] Service instance name
svc	[IN] Pointer to service locator

Returns

Reference to DataOnDemandSvc object.

Definition at line 41 of file DataOnDemandSvc.cpp.

                                                                          : base_class( name, svc )
{
  m_dump.declareUpdateHandler( [this]( Gaudi::Details::PropertyBase& ) {
    if ( m_dump && FSMState() >= Gaudi::StateMachine::INITIALIZED ) {
      dump( MSG::ALWAYS );
    }
  } );

  auto force_update = [this]( Gaudi::Details::PropertyBase& p ) {
    verbose() << "updated property " << p.name() << ", forcig update" << endmsg;
    m_updateRequired = true;
  };
  m_algMap.declareUpdateHandler( force_update );
  m_nodeMap.declareUpdateHandler( force_update );

  auto deprecated_property = [this, force_update]( Gaudi::Details::PropertyBase& p ) {
    warning() << p.name() << " " << p.documentation() << endmsg;
    force_update( p );
  };
  m_algMapping.declareUpdateHandler( deprecated_property );
  m_nodeMapping.declareUpdateHandler( deprecated_property );
  // ==========================================================================
}

DataOnDemandSvc::~DataOnDemandSvc ( )

overridedefault

Standard destructor.

Member Function Documentation

StatusCode DataOnDemandSvc::configureHandler ( Leaf &  leaf )

protected

Configure handler for leaf.

Parameters

leaf	[IN] Reference to leaf handler

Returns

StatusCode indicating success or failure

Definition at line 455 of file DataOnDemandSvc.cpp.

{
  if ( l.algorithm ) {
    return StatusCode::SUCCESS;
  }
  if ( !m_algMgr ) {
    return StatusCode::FAILURE;
  }
  l.algorithm = m_algMgr->algorithm( l.name, false );
  if ( l.algorithm ) {
    return StatusCode::SUCCESS;
  }
  // create it!
  StatusCode sc = m_algMgr->createAlgorithm( l.type, l.name, l.algorithm, true );
  if ( sc.isFailure() ) {
    error() << "Failed to create algorithm " << l.type << "('" << l.name << "')" << endmsg;
    l.algorithm = nullptr;
    return sc; // RETURN
  }
  if ( l.algorithm->isInitialized() ) {
    return StatusCode::SUCCESS;
  }
  // initialize it!
  sc = l.algorithm->sysInitialize();
  if ( sc.isFailure() ) {
    error() << "Failed to initialize algorithm " << l.type << "('" << l.name << "')" << endmsg;
    l.algorithm = nullptr;
    return sc; // RETURN
  }
  if ( Gaudi::StateMachine::RUNNING == l.algorithm->FSMState() ) {
    return StatusCode::SUCCESS;
  }
  // run it!
  sc = l.algorithm->sysStart();
  if ( sc.isFailure() ) {
    error() << "Failed to 'run'      algorithm " << l.type << "('" << l.name << "')" << endmsg;
    l.algorithm = nullptr;
    return sc; // RETURN
  }
  return StatusCode::SUCCESS;
}

void DataOnDemandSvc::dump ( const MSG::Level  level, const bool  mode = true  ) const

protected

dump the content of DataOnDemand service

Parameters

level	the printout level
mode	the printout mode

Definition at line 710 of file DataOnDemandSvc.cpp.

{
  if ( m_algs.empty() && m_nodes.empty() ) {
    return;
  }

  typedef std::pair<std::string, std::string> Pair;
  std::map<std::string, Pair> _m;
  for ( auto& alg : m_algs ) {
    auto check = _m.find( alg.first );
    if ( _m.end() != check ) {
      warning() << " The data item is activated for '" << check->first << "' as '" << check->second.first << "'"
                << endmsg;
    }
    const Leaf& l   = alg.second;
    std::string nam = ( l.name == l.type ? l.type : ( l.type + "/" + l.name ) );
    //
    if ( !mode && 0 == l.num ) {
      continue;
    }
    //
    std::string val;
    if ( mode ) {
      val = ( !l.algorithm ) ? "F" : "T";
    } else {
      val = std::to_string( l.num );
    }
    //
    _m[no_prefix( alg.first, m_prefix )] = {nam, val};
  }
  // nodes:
  for ( const auto& node : m_nodes ) {
    auto check = _m.find( node.first );
    if ( _m.end() != check ) {
      warning() << " The data item is already activated for '" << check->first << "' as '" << check->second.first << "'"
                << endmsg;
    }
    const Node& n   = node.second;
    std::string nam = "'" + n.name + "'";
    //
    std::string val;

    if ( !mode && 0 == n.num ) {
      continue;
    }

    if ( mode ) {
      val = ( 0 == n.clazz ) ? "F" : "T";
    } else {
      val = std::to_string( n.num );
    }
    //
    _m[no_prefix( node.first, m_prefix )] = {nam, val};
  }
  //
  if ( _m.empty() ) {
    return;
  }

  // find the correct formats
  size_t n1 = 0;
  size_t n2 = 0;
  size_t n3 = 0;
  for ( const auto& i : _m ) {
    n1 = std::max( n1, i.first.size() );
    n2 = std::max( n2, i.second.first.size() );
    n3 = std::max( n3, i.second.second.size() );
  }
  if ( 10 > n1 ) {
    n1 = 10;
  }
  if ( 10 > n2 ) {
    n2 = 10;
  }
  if ( 60 < n1 ) {
    n1 = 60;
  }
  if ( 60 < n2 ) {
    n2 = 60;
  }
  //

  const std::string _f = " | %%1$-%1%.%1%s | %%2$-%2%.%2%s | %%3$%3%.%3%s |";
  boost::format _ff( _f );
  _ff % n1 % n2 % n3;

  const std::string _format = _ff.str();

  auto& msg = msgStream( level );

  if ( mode ) {
    msg << "Data-On-Demand Actions enabled for:";
  } else {
    msg << "Data-On-Demand Actions has been used for:";
  }

  boost::format fmt1( _format );
  fmt1 % "Address" % "Creator" % ( mode ? "S" : "#" );
  //
  const std::string header = fmt1.str();
  std::string line         = std::string( header.size(), '-' );
  line[0]                  = ' ';

  msg << '\n' << line << '\n' << header << '\n' << line;

  // make the actual printout:
  for ( const auto& item : _m ) {
    boost::format fmt( _format );
    msg << '\n' << ( fmt % item.first % item.second.first % item.second.second );
  }

  msg << '\n' << line << endmsg;
}

StatusCode DataOnDemandSvc::execHandler ( const std::string &  tag, Leaf &  leaf  )

protected

Execute leaf handler (algorithm)

Parameters

tag	[IN] Path to requested leaf
leaf	[IN] Reference to leaf handler

Returns

StatusCode indicating success or failure

Definition at line 671 of file DataOnDemandSvc.cpp.

{
  Gaudi::Utils::LockedChrono timer( m_timer_algs, m_locked_algs );
  //
  if ( l.executing ) {
    return StatusCode::FAILURE;
  } // RETURN
  //
  if ( !l.algorithm ) {
    StatusCode sc = configureHandler( l );
    if ( sc.isFailure() ) {
      error() << "Failed to configure handler for: " << l.name << "[" << l.type << "] " << tag << endmsg;
      return sc; // RETURN
    }
  }
  //
  Chrono atimer( m_total );
  //
  Protection p( l.executing );
  // FIXME: this will cause problems for Hive, as we need to set
  // the EventContext of the called Algorithm.
  // if (!l.algorithm->getContext()) {
  //   l.algorithm->setContext( &Gaudi::Hive::currentContext() );
  // }
  StatusCode sc = l.algorithm->sysExecute( Gaudi::Hive::currentContext() );
  if ( sc.isFailure() ) {
    error() << "Failed to execute the algorithm:" << l.algorithm->name() << " for location:" << tag << endmsg;
    return sc; // RETURN
  }
  ++l.num;
  //
  return StatusCode::SUCCESS;
}

StatusCode DataOnDemandSvc::execHandler ( const std::string &  tag, Node &  node  )

protected

Execute node handler (simple object creation using seal reflection)

Parameters

tag	[IN] Path to requested leaf
node	[IN] Reference to node handler

Returns

StatusCode indicating success or failure

Definition at line 626 of file DataOnDemandSvc.cpp.

{

  Gaudi::Utils::LockedChrono timer( m_timer_nodes, m_locked_nodes );

  if ( n.executing ) {
    return StatusCode::FAILURE;
  } // RETURN

  Protection p( n.executing );

  std::unique_ptr<DataObject> object;

  if ( n.dataObject ) {
    object.reset( new DataObject() );
  } else {
    // try to recover the handler
    if ( !n.clazz ) {
      n.clazz = TClass::GetClass( n.name.c_str() );
    }
    if ( !n.clazz ) {
      error() << "Failed to get dictionary for class '" << n.name << "' for location:" << tag << endmsg;
      return StatusCode::FAILURE; // RETURN
    }

    object.reset( reinterpret_cast<DataObject*>( n.clazz->New() ) );

    if ( !object ) {
      error() << "Failed to create an object of type:" << n.clazz->GetName() << " for location:" << tag << endmsg;
      return StatusCode::FAILURE; // RETURN
    }
  }
  //
  StatusCode sc = m_dataSvc->registerObject( tag, object.release() );
  if ( sc.isFailure() ) {
    error() << "Failed to register an object of type:" << n.name << " at location:" << tag << endmsg;
    return sc; // RETURN
  }
  ++n.num;
  //
  return StatusCode::SUCCESS;
}

StatusCode DataOnDemandSvc::finalize ( )

override

Inherited Service overrides: Service finalization.

Definition at line 262 of file DataOnDemandSvc.cpp.

{
  //
  info() << "Handled \"" << m_trapType.value() << "\" incidents: " << m_statAlg << "/" << m_statNode << "/" << m_stat
         << "(Alg/Node/Total)." << endmsg;
  if ( m_dump || msgLevel( MSG::DEBUG ) ) {
    info() << m_total.outputUserTime( "Algorithm timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] ",
                                      System::milliSec )
           << m_total.outputUserTime( "Total:%2%[s]", System::Sec ) << endmsg;
    info() << m_timer_nodes.outputUserTime( "Nodes     timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] ",
                                            System::milliSec )
           << m_timer_nodes.outputUserTime( "Total:%2%[s]", System::Sec ) << endmsg;
    info() << m_timer_algs.outputUserTime( "Algs      timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] ",
                                           System::milliSec )
           << m_timer_algs.outputUserTime( "Total:%2%[s]", System::Sec ) << endmsg;
    info() << m_timer_all.outputUserTime( "All       timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] ",
                                          System::milliSec )
           << m_timer_all.outputUserTime( "Total:%2%[s]", System::Sec ) << endmsg;
  }
  // dump it!
  if ( m_dump ) {
    dump( MSG::INFO, false );
  } else if ( msgLevel( MSG::DEBUG ) ) {
    dump( MSG::DEBUG, false );
  }
  //
  if ( m_incSvc ) {
    m_incSvc->removeListener( this, m_trapType );
    m_incSvc.reset();
  }
  m_algMgr.reset();
  m_dataSvc.reset();
  if ( m_toolSvc ) { // we may not have retrieved the ToolSvc
    // Do not call releaseTool if the ToolSvc was already finalized.
    if ( SmartIF<IStateful>( m_toolSvc )->FSMState() > Gaudi::StateMachine::CONFIGURED ) {
      for ( const auto& i : m_nodeMappers ) m_toolSvc->releaseTool( i ).ignore();
      for ( const auto& i : m_algMappers ) m_toolSvc->releaseTool( i ).ignore();
    } else {
      warning() << "ToolSvc already finalized: cannot release tools. Check options." << endmsg;
    }
    m_nodeMappers.clear();
    m_algMappers.clear();
    m_toolSvc.reset();
  }
  return Service::finalize();
}

void DataOnDemandSvc::handle ( const Incident &  incident )

override

IIncidentListener interfaces overrides: incident handling.

Definition at line 553 of file DataOnDemandSvc.cpp.

{

  Gaudi::Utils::LockedChrono timer( m_timer_all, m_locked_all );

  ++m_stat;
  // proper incident type?
  if ( incident.type() != m_trapType ) {
    return;
  } // RETURN
  const DataIncident* inc = dynamic_cast<const DataIncident*>( &incident );
  if ( !inc ) {
    return;
  } // RETURN
  // update if needed!
  if ( m_updateRequired ) {
    update();
  }

  if ( msgLevel( MSG::VERBOSE ) ) {
    verbose() << "Incident: [" << incident.type() << "] "
              << " = " << incident.source() << " Location:" << inc->tag() << endmsg;
  }
  // ==========================================================================
  Gaudi::StringKey tag( inc->tag() );
  // ==========================================================================
  auto icl = m_nodes.find( tag );
  if ( icl != m_nodes.end() ) {
    StatusCode sc = execHandler( tag, icl->second );
    if ( sc.isSuccess() ) {
      ++m_statNode;
    }
    return; // RETURN
  }
  // ==========================================================================
  auto ialg = m_algs.find( tag );
  if ( ialg != m_algs.end() ) {
    StatusCode sc = execHandler( tag, ialg->second );
    if ( sc.isSuccess() ) {
      ++m_statAlg;
    }
    return; // RETURN
  }
  // ==========================================================================
  // Fall back on the tools
  if ( m_toolSvc ) {
    if ( msgLevel( MSG::VERBOSE ) ) verbose() << "Try to find mapping with mapping tools" << endmsg;
    Finder finder( no_prefix( inc->tag(), m_prefix ), m_nodeMappers, m_algMappers );
    //  - try the node mappers
    std::string node = finder.node();
    if ( isGood( node ) ) {
      // if one is found update the internal node mapping and try again.
      if ( msgLevel( MSG::VERBOSE ) ) verbose() << "Found Node handler: " << node << endmsg;
      i_setNodeHandler( inc->tag(), node );
      handle( incident );
      --m_stat; // avoid double counting because of recursion
      return;
    }
    //  - try alg mappings
    Gaudi::Utils::TypeNameString alg = finder.alg();
    if ( isGood( alg ) ) {
      // we got an algorithm, update alg map and try to handle again
      if ( msgLevel( MSG::VERBOSE ) ) verbose() << "Found Algorithm handler: " << alg << endmsg;
      i_setAlgHandler( inc->tag(), alg ).ignore();
      handle( incident );
      --m_stat; // avoid double counting because of recursion
      return;
    }
  }
}

StatusCode DataOnDemandSvc::i_setAlgHandler ( const std::string &  name, const Gaudi::Utils::TypeNameString &  alg  )

protected

Internal method to initialize an algorithm handler.

Definition at line 154 of file DataOnDemandSvc.cpp.

{
  Leaf leaf( alg.type(), alg.name() );
  if ( m_init ) {
    StatusCode sc = configureHandler( leaf );
    if ( sc.isFailure() ) {
      if ( m_allowInitFailure ) {
        // re-store the content of the leaf object to try again to initialize
        // the algorithm later (on demand)
        leaf = Leaf( alg.type(), alg.name() );
      } else
        return sc;
    }
  }
  m_algs[name] = leaf;
  return StatusCode::SUCCESS;
}

void DataOnDemandSvc::i_setNodeHandler ( const std::string &  name, const std::string &  type  )

protected

Internal method to initialize a node handler.

Definition at line 145 of file DataOnDemandSvc.cpp.

{
  ClassH cl = TClass::GetClass( type.c_str() );
  if ( !cl ) {
    warning() << "Failed to access dictionary class for " << name << " of type:" << type << endmsg;
  }
  m_nodes[name] = Node( cl, false, type );
}

StatusCode DataOnDemandSvc::initialize ( )

override

Inherited Service overrides: Service initialization.

Definition at line 235 of file DataOnDemandSvc.cpp.

{
  // initialize the Service Base class
  StatusCode sc = Service::initialize();
  if ( sc.isFailure() ) {
    return sc;
  }
  sc = setup();
  if ( sc.isFailure() ) {
    return sc;
  }
  //
  if ( m_dump ) {
    dump( MSG::INFO );
  } else if ( msgLevel( MSG::DEBUG ) ) {
    dump( MSG::DEBUG );
  }
  //
  if ( m_init ) {
    return update();
  }
  //
  return StatusCode::SUCCESS;
}

StatusCode DataOnDemandSvc::reinitialize ( )

override

Inherited Service overrides: Service reinitialization.

re-initialization of the service

Definition at line 311 of file DataOnDemandSvc.cpp.

{
  // reinitialize the Service Base class
  if ( m_incSvc ) {
    m_incSvc->removeListener( this, m_trapType );
    m_incSvc.reset();
  }
  m_algMgr.reset();
  m_dataSvc.reset();
  for ( const auto& i : m_nodeMappers ) m_toolSvc->releaseTool( i ).ignore();
  m_nodeMappers.clear();
  for ( const auto& i : m_algMappers ) m_toolSvc->releaseTool( i ).ignore();
  m_algMappers.clear();
  m_toolSvc.reset();
  //
  StatusCode sc = Service::reinitialize();
  if ( sc.isFailure() ) {
    return sc;
  }
  //
  sc = setup();
  if ( sc.isFailure() ) {
    return sc;
  }
  //
  if ( m_dump ) {
    dump( MSG::INFO );
  } else if ( msgLevel( MSG::DEBUG ) ) {
    dump( MSG::DEBUG );
  }
  //
  return StatusCode::SUCCESS;
}

StatusCode DataOnDemandSvc::setup ( )

protected

Setup routine (called by (re-) initialize.

Definition at line 347 of file DataOnDemandSvc.cpp.

{
  if ( !( m_algMgr = serviceLocator() ) ) // assignment meant
  {
    error() << "Failed to retrieve the IAlgManager interface." << endmsg;
    return StatusCode::FAILURE;
  }

  if ( !( m_incSvc = serviceLocator()->service( "IncidentSvc" ) ) ) // assignment meant
  {
    error() << "Failed to retrieve Incident service." << endmsg;
    return StatusCode::FAILURE;
  }
  m_incSvc->addListener( this, m_trapType );

  if ( !( m_dataSvc = serviceLocator()->service( m_dataSvcName ) ) ) // assignment meant
  {
    error() << "Failed to retrieve the data provider interface of " << m_dataSvcName << endmsg;
    return StatusCode::FAILURE;
  }

  // No need to get the ToolSvc if we are not using tools
  if ( !( m_nodeMapTools.empty() && m_algMapTools.empty() ) ) {
    if ( !( m_toolSvc = serviceLocator()->service( "ToolSvc" ) ) ) // assignment meant
    {
      error() << "Failed to retrieve ToolSvc" << endmsg;
      return StatusCode::FAILURE;
    }

    // load the node mapping tools
    IDODNodeMapper* nodetool = nullptr;
    for ( const auto& i : m_nodeMapTools ) {
      const StatusCode sc = m_toolSvc->retrieveTool( i, nodetool );
      if ( sc.isFailure() ) return sc;
      m_nodeMappers.push_back( nodetool );
    }
    IDODAlgMapper* algtool = nullptr;
    for ( const auto& i : m_algMapTools ) {
      const StatusCode sc = m_toolSvc->retrieveTool( i, algtool );
      if ( sc.isFailure() ) return sc;
      m_algMappers.push_back( algtool );
    }
  }
  return update();
}

StatusCode DataOnDemandSvc::setupAlgHandlers ( )

protected

Initialize leaf handlers.

Definition at line 425 of file DataOnDemandSvc.cpp.

{
  std::string typ, tag;

  for ( auto alg : m_algMapping ) {
    using Parser = Gaudi::Utils::AttribStringParser;
    for ( auto attrib : Parser( alg ) ) {
      switch (::toupper( attrib.tag[0] ) ) {
      case 'D':
        tag = std::move( attrib.value );
        break;
      case 'T':
        typ = std::move( attrib.value );
        break;
      }
    }
    Gaudi::Utils::TypeNameString item( typ );
    if ( m_algMap.end() != m_algMap.find( tag ) || m_nodeMap.end() != m_nodeMap.find( tag ) ) {
      warning() << "The obsolete property 'Algorithms' redefines the action for '" + tag + "' to be '" + item.type() +
                       "/" + item.name() + "'"
                << endmsg;
    }
    m_algMap[tag] = item.type() + "/" + item.name();
  }
  m_updateRequired = true;
  return StatusCode::SUCCESS;
}

StatusCode DataOnDemandSvc::setupNodeHandlers ( )

protected

Initialize node handlers.

Definition at line 395 of file DataOnDemandSvc.cpp.

{
  std::string nam, typ, tag;
  StatusCode sc = StatusCode::SUCCESS;
  // Setup for node leafs, where simply a constructor is called...
  for ( auto node : m_nodeMapping ) {
    using Parser = Gaudi::Utils::AttribStringParser;
    for ( auto attrib : Parser( node ) ) {
      switch (::toupper( attrib.tag[0] ) ) {
      case 'D':
        tag = std::move( attrib.value );
        break;
      case 'T':
        nam = std::move( attrib.value );
        break;
      }
    }
    if ( m_algMap.end() != m_algMap.find( tag ) || m_nodeMap.end() != m_nodeMap.find( tag ) ) {
      warning() << "The obsolete property 'Nodes' redefines the action for '" + tag + "' to be '" + nam + "'" << endmsg;
    }
    m_nodeMap[tag] = nam;
  }
  //
  m_updateRequired = true;
  //
  return sc;
}

StatusCode DataOnDemandSvc::update ( )

protected

update the handlers

convert obsolete "Nodes" into new "NodeMap"

convert obsolete "Algorithms" into new "AlgMap"

add the default prefix

add the default prefix

get all directories

setup algorithms

setup nodes

Definition at line 175 of file DataOnDemandSvc.cpp.

{
  if ( !m_updateRequired ) {
    return StatusCode::SUCCESS;
  }

  StatusCode sc = setupNodeHandlers(); // convert "Nodes"      new "NodeMap"
  if ( sc.isFailure() ) {
    error() << "Failed to setup old \"Nodes\"" << endmsg;
    return sc;
  }
  sc = setupAlgHandlers(); // convert "Algorithms" into "AlgMap"
  if ( sc.isFailure() ) {
    error() << "Failed to setup old \"Algorithms\"" << endmsg;
    return sc;
  }
  add_prefix( m_algMap, m_prefix );
  add_prefix( m_nodeMap, m_prefix );
  std::set<std::string> dirs;
  if ( m_partialPath ) {
    get_dirs( m_algMap, dirs );
  }
  if ( m_partialPath ) {
    get_dirs( m_nodeMap, dirs );
  }
  //
  auto _e = dirs.find( "/Event" );
  if ( dirs.end() != _e ) {
    dirs.erase( _e );
  }
  // add all directories as nodes
  for ( const auto& dir : dirs ) {
    if ( m_algMap.end() == m_algMap.find( dir ) && m_nodeMap.end() == m_nodeMap.find( dir ) )
      m_nodeMap[dir] = "DataObject";
  }
  //
  m_algs.clear();
  m_nodes.clear();
  //
  for ( const auto& alg : m_algMap ) {
    if ( i_setAlgHandler( alg.first, alg.second ).isFailure() ) return StatusCode::FAILURE;
  }
  for ( const auto& node : m_nodeMap ) {
    i_setNodeHandler( node.first, node.second );
  }
  m_updateRequired = false;
  //
  return StatusCode::SUCCESS;
}

Member Data Documentation

Gaudi::Property<Map> DataOnDemandSvc::m_algMap {this, "AlgMap", {}, "mapping {'data': 'algorithm'}"}

private

Definition at line 265 of file DataOnDemandSvc.h.

std::vector<IDODAlgMapper*> DataOnDemandSvc::m_algMappers

private

Definition at line 246 of file DataOnDemandSvc.h.

Gaudi::Property<Setup> DataOnDemandSvc::m_algMapping {this, "Algorithms", {}, "[[deprecated]] use AlgMap"}

private

Definition at line 261 of file DataOnDemandSvc.h.

Gaudi::Property<std::vector<std::string> > DataOnDemandSvc::m_algMapTools

private

Initial value:

{
      this, "AlgMappingTools", {}, "list of tools of type IDODAlgMapper"}

Definition at line 272 of file DataOnDemandSvc.h.

SmartIF<IAlgManager> DataOnDemandSvc::m_algMgr = nullptr

private

Algorithm manager.

Definition at line 221 of file DataOnDemandSvc.h.

AlgMap DataOnDemandSvc::m_algs

private

Map of algorithms to handle incidents.

Definition at line 227 of file DataOnDemandSvc.h.

Gaudi::Property<bool> DataOnDemandSvc::m_allowInitFailure

private

Initial value:

{
      this, "AllowPreInitializeFailure", false,
      "allow (pre)initialization of algorithms to fail without stopping the application"}

Definition at line 257 of file DataOnDemandSvc.h.

SmartIF<IDataProviderSvc> DataOnDemandSvc::m_dataSvc = nullptr

private

Data provider reference.

Definition at line 223 of file DataOnDemandSvc.h.

Gaudi::Property<std::string> DataOnDemandSvc::m_dataSvcName {this, "DataSvc", "EventDataSvc", "DataSvc name"}

private

Definition at line 250 of file DataOnDemandSvc.h.

Gaudi::Property<bool> DataOnDemandSvc::m_dump

private

Initial value:

{
      this, "Dump", false,
      "dump configuration and stastics, if set to True after initialize it triggers a dump immediately"}

Definition at line 253 of file DataOnDemandSvc.h.

SmartIF<IIncidentSvc> DataOnDemandSvc::m_incSvc = nullptr

private

Incident service.

Definition at line 219 of file DataOnDemandSvc.h.

Gaudi::Property<bool> DataOnDemandSvc::m_init {this, "PreInitialize", false, "(pre)initialize all algorithms"}

private

Definition at line 256 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_locked_algs = false

private

Definition at line 242 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_locked_all = false

private

Definition at line 243 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_locked_nodes = false

private

Definition at line 241 of file DataOnDemandSvc.h.

Gaudi::Property<Map> DataOnDemandSvc::m_nodeMap {this, "NodeMap", {}, "mapping {'data': 'type'}"}

private

Definition at line 266 of file DataOnDemandSvc.h.

std::vector<IDODNodeMapper*> DataOnDemandSvc::m_nodeMappers

private

Definition at line 245 of file DataOnDemandSvc.h.

Gaudi::Property<Setup> DataOnDemandSvc::m_nodeMapping {this, "Nodes", {}, "[[deprecated]] use NodeMap"}

private

Definition at line 262 of file DataOnDemandSvc.h.

Gaudi::Property<std::vector<std::string> > DataOnDemandSvc::m_nodeMapTools

private

Initial value:

{
      this, "NodeMappingTools", {}, "list of tools of type IDODNodeMapper"}

Definition at line 270 of file DataOnDemandSvc.h.

NodeMap DataOnDemandSvc::m_nodes

private

Map of "empty" objects to be placed as intermediate nodes.

Definition at line 229 of file DataOnDemandSvc.h.

Gaudi::Property<bool> DataOnDemandSvc::m_partialPath {this, "UsePreceedingPath", true, "allow creation of partial leaves"}

private

Definition at line 252 of file DataOnDemandSvc.h.

Gaudi::Property<std::string> DataOnDemandSvc::m_prefix {this, "Prefix", "/Event/"}

private

Definition at line 268 of file DataOnDemandSvc.h.

ulonglong DataOnDemandSvc::m_stat = 0

private

Definition at line 236 of file DataOnDemandSvc.h.

ulonglong DataOnDemandSvc::m_statAlg = 0

private

Definition at line 234 of file DataOnDemandSvc.h.

ulonglong DataOnDemandSvc::m_statNode = 0

private

Definition at line 235 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_timer_algs

private

Definition at line 239 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_timer_all

private

Definition at line 240 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_timer_nodes

private

Definition at line 238 of file DataOnDemandSvc.h.

SmartIF<IToolSvc> DataOnDemandSvc::m_toolSvc

private

Data provider reference.

Definition at line 225 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_total

private

Definition at line 233 of file DataOnDemandSvc.h.

Gaudi::Property<std::string> DataOnDemandSvc::m_trapType {this, "IncidentName", "DataFault", "the type of handled Incident"}

private

Definition at line 249 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_updateRequired = true

private

Definition at line 231 of file DataOnDemandSvc.h.

---

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

• GaudiCoreSvc/src/IncidentSvc/DataOnDemandSvc.h
• GaudiCoreSvc/src/IncidentSvc/DataOnDemandSvc.cpp