DataOnDemandSvc Class Reference

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

#include <DataOnDemandSvc.h>

Inheritance diagram for DataOnDemandSvc:

[legend]

Collaboration diagram for DataOnDemandSvc:

[legend]

List of all members.

Public Types

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

typedef ROOT::Reflex::Type ClassH

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

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

Public Member Functions

virtual StatusCode initialize ()

Inherited Service overrides: Service initialization.

virtual StatusCode finalize ()

Inherited Service overrides: Service finalization.

virtual StatusCode reinitialize ()

Inherited Service overrides: Service reinitialization.

virtual void handle (const Incident &incident)

IIncidentListener interfaces overrides: incident handling.

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

Standard initializing service constructor.

virtual ~DataOnDemandSvc ()

Standard destructor.

void update_1 (Property &p)

void update_2 (Property &p)

void update_3 (Property &p)

void update_dump (Property &)

update handler for 'Dump' property

Protected Member Functions

StatusCode configureHandler (Leaf &leaf)

Configure handler for leaf.

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

Execute leaf handler (algorithm).

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

Execute node handler (simple object creation using seal reflection).

StatusCode setupNodeHandlers ()

Initialize node handlers.

StatusCode setupAlgHandlers ()

Initialize leaf handlers.

StatusCode setup ()

Setup routine (called by (re-) initialize.

StatusCode update ()

update the handlers

MsgStream & stream () const

get the message stream

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

dump the content of DataOnDemand service

Private Types

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

Private Attributes

IIncidentSvc * m_incSvc

Incident service.

IAlgManager * m_algMgr

Algorithm manager.

IDataProviderSvc * m_dataSvc

Data provider reference.

std::string m_trapType

Trap name.

std::string m_dataSvcName

Data service name.

bool m_partialPath

Flag to allow for the creation of partial leaves.

bool m_dump

flag to force the printout

bool m_init

flag to warm up the configuration

Setup m_algMapping

Mapping to algorithms.

Setup m_nodeMapping

Mapping to nodes.

AlgMap m_algs

Map of algorithms to handle incidents.

NodeMap m_nodes

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

Map m_algMap

the major configuration property { 'data' : 'algorithm' }

Map m_nodeMap

the major configuration property { 'data' : 'type' }

bool m_updateRequired

std::string m_prefix

MsgStream * m_log

ChronoEntity m_total

ulonglong m_statAlg

ulonglong m_statNode

ulonglong m_stat

ChronoEntity m_timer_nodes

ChronoEntity m_timer_algs

ChronoEntity m_timer_all

bool m_locked_nodes

bool m_locked_algs

bool m_locked_all

Classes

struct Leaf

struct Node

Helper class of the DataOnDemandSvc. More...

struct Protection

Helper class of the DataOnDemandSvc. 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 mathes. In the event already the partial path to any handler is missing a leaf handler may be triggered, which includes the partal pathes ( 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 preceeding 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/" ) coudl 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 std::vector<std::string> DataOnDemandSvc::Setup

Definition at line 95 of file DataOnDemandSvc.h.

typedef ROOT::Reflex::Type DataOnDemandSvc::ClassH

Definition at line 96 of file DataOnDemandSvc.h.

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

Definition at line 171 of file DataOnDemandSvc.h.

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

Definition at line 172 of file DataOnDemandSvc.h.

typedef std::map<std::string,std::string> DataOnDemandSvc::Map [private]

Definition at line 274 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 42 of file DataOnDemandSvc.cpp.

00043   : base_class(name, svc)
00044   , m_incSvc   ( 0 )
00045   , m_algMgr   ( 0 )
00046   , m_dataSvc  ( 0 )
00047   //
00048   , m_trapType    ( "DataFault")
00049   , m_dataSvcName ( "EventDataSvc" )
00050   , m_partialPath ( true  )
00051   , m_dump        ( false )
00052   , m_init        ( false )
00053   //
00054   , m_algMapping  ()
00055   , m_nodeMapping ()
00056   //
00057   , m_algMap   (   )
00058   , m_nodeMap  (   )
00059   //
00060   , m_updateRequired ( true )
00061   , m_prefix         ( "/Event/" )
00062   , m_log      ( 0 )
00063   , m_total    (   )
00064   , m_statAlg  ( 0 )
00065   , m_statNode ( 0 )
00066   , m_stat     ( 0 )
00067   //
00068   , m_timer_nodes  () 
00069   , m_timer_algs   ()
00070   , m_timer_all    ()
00071   , m_locked_nodes ( false ) 
00072   , m_locked_algs  ( false )
00073   , m_locked_all   ( false )
00074   //
00075 {
00076   // ==========================================================================
00077   declareProperty 
00078     ( "IncidentName"       , 
00079       m_trapType           , 
00080       "The type of handled Incident" ) ;
00081   //
00082   declareProperty ( "DataSvc"            , m_dataSvcName ) ;
00083   //
00084   declareProperty ( "UsePreceedingPath"  , m_partialPath ) ;
00085   declareProperty 
00086     ( "Dump"        , 
00087       m_dump        ,
00088       "Dump the configuration and stastics" )  -> 
00089     declareUpdateHandler ( &DataOnDemandSvc::update_dump , this ) ;
00090   //
00091   declareProperty 
00092     ( "PreInitialize" , 
00093       m_init          , 
00094       "Flag to (pre)initialize all algorithms" ) ;
00095   //
00096   declareProperty ( "Algorithms"         , m_algMapping  )  ->
00097     declareUpdateHandler ( &DataOnDemandSvc::update_2 , this ) ;
00098   declareProperty ( "Nodes"              , m_nodeMapping ) ->
00099     declareUpdateHandler ( &DataOnDemandSvc::update_3 , this ) ;
00100   //
00101   declareProperty ( "AlgMap"  , m_algMap  ) ->
00102     declareUpdateHandler ( &DataOnDemandSvc::update_1 , this ) ;
00103   declareProperty ( "NodeMap" , m_nodeMap ) ->
00104     declareUpdateHandler ( &DataOnDemandSvc::update_1 , this ) ;
00105   //
00106   declareProperty ( "Prefix"             , m_prefix      ) ;
00107   // ==========================================================================
00108 }

DataOnDemandSvc::~DataOnDemandSvc ( ) [virtual]

Standard destructor.

Definition at line 310 of file DataOnDemandSvc.cpp.

00311 { if ( 0 != m_log      ) { delete m_log      ; m_log      = 0 ; } }

Member Function Documentation

StatusCode DataOnDemandSvc::initialize ( ) [virtual]

Inherited Service overrides: Service initialization.

Reimplemented from Service.

Definition at line 315 of file DataOnDemandSvc.cpp.

00316 {
00317   // initialize the Service Base class
00318   StatusCode sc = Service::initialize();
00319   if ( sc.isFailure() )  { return sc; }
00320   sc = setup();
00321   if ( sc.isFailure() )  { return sc; }
00322   //
00323   if      ( m_dump )                      { dump ( MSG::INFO  ) ; }
00324   else if ( MSG::DEBUG >= outputLevel() ) { dump ( MSG::DEBUG ) ; }
00325   //
00326   if ( m_init ) { return update () ; }
00327   //
00328   return StatusCode::SUCCESS ;
00329 }

StatusCode DataOnDemandSvc::finalize ( void ) [virtual]

Inherited Service overrides: Service finalization.

Reimplemented from Service.

Definition at line 333 of file DataOnDemandSvc.cpp.

00334 {
00335   //
00336   stream ()
00337     << MSG::INFO
00338     << "Handled \"" << m_trapType << "\" incidents: "
00339     << m_statAlg  << "/" << m_statNode << "/" << m_stat << "(Alg/Node/Total)."
00340     << endmsg ;
00341   if ( m_dump || MSG::DEBUG >= outputLevel() )
00342   {
00343     stream ()
00344       << MSG::INFO
00345       << m_total.outputUserTime
00346       ( "Algorithm timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] " , System::milliSec )
00347       << m_total.outputUserTime ( "Total:%2%[s]" , System::Sec ) << endmsg ;
00348     stream ()
00349       << MSG::INFO
00350       << m_timer_nodes.outputUserTime
00351       ( "Nodes     timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] " , System::milliSec )
00352       << m_timer_nodes.outputUserTime ( "Total:%2%[s]" , System::Sec ) << endmsg ;
00353     stream ()
00354       << MSG::INFO
00355       << m_timer_algs .outputUserTime
00356       ( "Algs      timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] " , System::milliSec )
00357       << m_timer_algs .outputUserTime ( "Total:%2%[s]" , System::Sec ) << endmsg ;
00358     stream ()
00359       << MSG::INFO
00360       << m_timer_all  .outputUserTime
00361       ( "All       timing: Mean(+-rms)/Min/Max:%3%(+-%4%)/%6%/%7%[ms] " , System::milliSec )
00362       << m_timer_all  .outputUserTime ( "Total:%2%[s]" , System::Sec ) << endmsg ;
00363   }
00364   // dump it!
00365   if      ( m_dump )                      { dump ( MSG::INFO  , false ) ; }
00366   else if ( MSG::DEBUG >= outputLevel() ) { dump ( MSG::DEBUG , false ) ; }
00367   //
00368   if ( m_incSvc )
00369   {
00370     m_incSvc->removeListener(this, m_trapType);
00371     m_incSvc->release();
00372     m_incSvc = 0;
00373   }
00374   if ( 0 != m_algMgr  ) { m_algMgr   -> release () ; m_algMgr  = 0 ; }
00375   if ( 0 != m_dataSvc ) { m_dataSvc  -> release () ; m_dataSvc = 0 ; }
00376   //
00377   return Service::finalize();
00378 }

StatusCode DataOnDemandSvc::reinitialize ( ) [virtual]

Inherited Service overrides: Service reinitialization.

re-initialization of the service

Reimplemented from Service.

Definition at line 382 of file DataOnDemandSvc.cpp.

00383 {
00384   // reinitialize the Service Base class
00385   if ( 0 != m_incSvc )
00386   {
00387     m_incSvc -> removeListener ( this , m_trapType );
00388     m_incSvc -> release ();
00389     m_incSvc = 0;
00390   }
00391   if ( 0 != m_algMgr  ) { m_algMgr   -> release() ; m_algMgr  = 0 ; }
00392   if ( 0 != m_dataSvc ) { m_dataSvc  -> release() ; m_dataSvc = 0 ; }
00393   if ( 0 != m_log     ) { delete m_log ; m_log = 0 ; }
00394   //
00395   StatusCode sc = Service::reinitialize();
00396   if ( sc.isFailure() )  { return sc; }
00397   //
00398   sc = setup() ;
00399   if ( sc.isFailure() )  { return sc; }
00400   //
00401   if ( m_dump ) { dump ( MSG::INFO ) ; }
00402   else if ( MSG::DEBUG >= outputLevel() ) { dump ( MSG::DEBUG  ) ; }
00403   //
00404   return StatusCode::SUCCESS ;
00405 }

void DataOnDemandSvc::handle ( const Incident & incident ) [virtual]

IIncidentListener interfaces overrides: incident handling.

Implements IIncidentListener.

Definition at line 571 of file DataOnDemandSvc.cpp.

00572 {
00573   
00574   Gaudi::Utils::LockedChrono timer ( m_timer_all , m_locked_all ) ;
00575   
00576   ++m_stat ;
00577   // proper incident type?
00578   if ( incident.type() != m_trapType ) { return ; }             // RETURN
00579   const DataIncident* inc = dynamic_cast<const DataIncident*>(&incident);
00580   if ( 0 == inc                      ) { return ; }             // RETURN
00581   // update if needed!
00582   if ( m_updateRequired ) { update() ; }
00583 
00584   if ( MSG::VERBOSE >= outputLevel() )
00585   {
00586     stream()
00587       << MSG::VERBOSE
00588       << "Incident: [" << incident.type   () << "] "
00589       << " = "         << incident.source ()
00590       << " Location:"  << inc->tag()         << endmsg;
00591   }
00592   // ==========================================================================
00593   // const std::string& tag = inc->tag();
00594   Gaudi::StringKey tag ( inc->tag() ) ;
00595   // ==========================================================================
00596   NodeMap::iterator icl = m_nodes.find ( tag ) ;
00597   if ( icl != m_nodes.end() )
00598   {
00599     StatusCode sc = execHandler ( tag , icl->second ) ;
00600     if ( sc.isSuccess() ) { ++m_statNode ; }
00601     return ;                                                        // RETURN
00602   }
00603   // ==========================================================================
00604   AlgMap::iterator ialg = m_algs.find ( tag ) ;
00605   if ( ialg != m_algs.end() )
00606   {
00607     StatusCode sc = execHandler ( tag , ialg->second ) ;
00608     if ( sc.isSuccess() ) { ++m_statAlg ; }
00609     return ;                                                        // RETURN
00610   }
00611 }

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 524 of file DataOnDemandSvc.cpp.

00525 {
00526   if ( 0 != l.algorithm ) { return StatusCode::SUCCESS ; }  
00527   if ( 0 == m_algMgr  ) { return StatusCode::FAILURE ; } 
00528   l.algorithm = m_algMgr->algorithm(l.name, false);
00529   if ( 0 != l.algorithm ) { return StatusCode::SUCCESS ; }
00530   // create it! 
00531   StatusCode sc = m_algMgr->createAlgorithm ( l.type , l.name , l.algorithm , true ) ;
00532   if ( sc.isFailure() )
00533   {
00534     stream()
00535       << MSG::ERROR
00536       << "Failed to create algorithm "
00537       << l.type << "('" << l.name<< "')" << endmsg;
00538     l.algorithm = 0 ;
00539     return sc ;                                                    // RETURN
00540   }
00541   if ( l.algorithm->isInitialized() ) { return StatusCode:: SUCCESS ;}
00542   // initialize it! 
00543   sc = l.algorithm -> sysInitialize () ;
00544   if ( sc.isFailure() )
00545   {
00546     stream()
00547       << MSG::ERROR
00548       << "Failed to initialize algorithm "
00549       << l.type << "('" << l.name<< "')" << endmsg;
00550     l.algorithm = 0 ;
00551     return sc ;                                                    // RETURN
00552   }
00553   if ( Gaudi::StateMachine::RUNNING == l.algorithm->FSMState() ) 
00554   { return StatusCode::SUCCESS ; }
00555   // run it!
00556   sc = l.algorithm->sysStart() ;
00557   if ( sc.isFailure() )
00558   {
00559     stream()
00560       << MSG::ERROR
00561       << "Failed to 'run'      algorithm "
00562       << l.type << "('" << l.name<< "')" << endmsg;
00563     l.algorithm = 0 ;
00564     return sc ;                                                    // RETURN
00565   }
00566   return StatusCode::SUCCESS  ;
00567 }

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 674 of file DataOnDemandSvc.cpp.

00675 {
00676   Gaudi::Utils::LockedChrono timer ( m_timer_algs ,  m_locked_algs ) ;
00677   //
00678   if ( l.executing ) { return StatusCode::FAILURE ; }             // RETURN
00679   //
00680   if ( 0 == l.algorithm )
00681   {
00682     StatusCode sc = configureHandler ( l ) ;
00683     if ( sc.isFailure() )
00684     {
00685       stream()
00686         << MSG::ERROR
00687         << "Failed to configure handler for: "
00688         << l.name << "[" << l.type << "] " << tag << endmsg;
00689       return sc ;                                                 // RETURN
00690     }
00691   }
00692   //
00693   Chrono atimer ( m_total ) ;
00694   //
00695   Protection p(l.executing);
00696   StatusCode sc = l.algorithm->sysExecute();
00697   if ( sc.isFailure() )
00698   {
00699     stream() << MSG::ERROR
00700              << "Failed to execute the algorithm:"
00701              << l.algorithm->name() << " for location:" << tag << endmsg;
00702     return sc ;                                                       // RETURN
00703   }
00704   ++l.num ;
00705   //
00706   return StatusCode::SUCCESS ;
00707 }

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 616 of file DataOnDemandSvc.cpp.

00617 {
00618   
00619   Gaudi::Utils::LockedChrono timer ( m_timer_nodes ,  m_locked_nodes ) ;
00620   
00621   if ( n.executing ) { return StatusCode::FAILURE ; }            // RETURN
00622   
00623   Protection p(n.executing);
00624   
00625   DataObject* object= 0 ;
00626   
00627   if ( n.dataObject )  { object = new DataObject() ; }
00628   else 
00629   {
00630     // try to recover the handler
00631     if ( !n.clazz  ) { n.clazz = ROOT::Reflex::Type::ByName(n.name) ; }
00632     if ( !n.clazz  )
00633     {
00634       stream()
00635         << MSG::ERROR
00636         << "Failed to get dictionary for class '"
00637         << n.name
00638         << "' for location:" << tag << endmsg;
00639       return StatusCode::FAILURE ;                               // RETURN
00640     }
00641     //
00642     ROOT::Reflex::Object obj = n.clazz.Construct();
00643     
00644     object = (DataObject*) obj.Address();
00645     
00646     if ( !object )
00647     {
00648       stream()
00649         << MSG::ERROR
00650         << "Failed to create an object of type:"
00651         << n.clazz.Name(ROOT::Reflex::SCOPED) << " for location:" << tag
00652         << endmsg;
00653       return StatusCode::FAILURE  ;                               // RETURN
00654     }
00655   }
00656   //
00657   StatusCode sc = m_dataSvc->registerObject(tag, object );
00658   if ( sc.isFailure() )
00659   {
00660     stream()
00661       << MSG::ERROR << "Failed to register an object of type:"
00662       << n.name << " at location:" << tag
00663       << endmsg;
00664     return sc ;                                                  // RETURN
00665   }
00666   ++n.num ;
00667   //
00668   return StatusCode::SUCCESS ;
00669 }

StatusCode DataOnDemandSvc::setupNodeHandlers ( ) [protected]

Initialize node handlers.

Definition at line 443 of file DataOnDemandSvc.cpp.

00444 {
00445   Setup::const_iterator j;
00446   std::string nam, typ, tag;
00447   StatusCode sc = StatusCode::SUCCESS;
00448   // Setup for node leafs, where simply a constructor is called...
00449   for ( j=m_nodeMapping.begin(); j != m_nodeMapping.end(); ++j)
00450   {
00451     Tokenizer tok(true);
00452     tok.analyse(*j, " ", "", "", "=", "'", "'");
00453     for ( Tokenizer::Items::iterator i = tok.items().begin();
00454           i != tok.items().end(); i++ )   {
00455       const std::string& t = (*i).tag();
00456       const std::string& v = (*i).value();
00457       switch( ::toupper(t[0]) )    {
00458       case 'D':
00459         tag = v;
00460         break;
00461       case 'T':
00462         nam = v;
00463         break;
00464       }
00465     }
00466     if ( m_algMap  .end () != m_algMap  .find ( tag ) ||
00467          m_nodeMap .end () != m_nodeMap .find ( tag ) )
00468     {
00469       stream()
00470         << MSG::WARNING
00471         << "The obsolete property 'Nodes' redefines the action for '"
00472         + tag + "' to be '" +nam+"'"
00473         << endmsg ;
00474     }
00475     m_nodeMap[tag] = nam ;
00476   }
00477   //
00478   m_updateRequired = true ;
00479   //
00480   return sc;
00481 }

StatusCode DataOnDemandSvc::setupAlgHandlers ( ) [protected]

Initialize leaf handlers.

Definition at line 485 of file DataOnDemandSvc.cpp.

00486 {
00487   Setup::const_iterator j;
00488   std::string typ, tag;
00489 
00490   for(j=m_algMapping.begin(); j != m_algMapping.end(); ++j)
00491   {
00492     Tokenizer tok(true);
00493     tok.analyse(*j, " ", "", "", "=", "'", "'");
00494     for(Tokenizer::Items::iterator i = tok.items().begin(); i != tok.items().end(); i++ )   {
00495       const std::string& t = (*i).tag();
00496       const std::string& v = (*i).value();
00497       switch( ::toupper(t[0]) )    {
00498       case 'D':
00499         tag = v;
00500         break;
00501       case 'T':
00502         typ = v;
00503         break;
00504       }
00505     }
00506     Gaudi::Utils::TypeNameString item(typ);
00507     if ( m_algMap  .end () != m_algMap  .find ( tag ) ||
00508          m_nodeMap .end () != m_nodeMap .find ( tag ) )
00509     {
00510       stream()
00511         << MSG::WARNING
00512         << "The obsolete property 'Algorithms' redefines the action for '"
00513         + tag + "' to be '" +item.type() +"/"+item.name()+"'"
00514         << endmsg ;
00515     }
00516     m_algMap[tag] = item.type() + "/" + item.name() ;
00517   }
00518   m_updateRequired = true ;
00519   return StatusCode::SUCCESS;
00520 }

StatusCode DataOnDemandSvc::setup ( ) [protected]

Setup routine (called by (re-) initialize.

Definition at line 409 of file DataOnDemandSvc.cpp.

00410 {
00411   m_algMgr = 0;
00412   StatusCode sc =
00413     serviceLocator()->queryInterface(IAlgManager::interfaceID(), pp_cast<void>(&m_algMgr));
00414   if ( sc.isFailure () )
00415   {
00416     stream()
00417       << MSG::ERROR
00418       << "Failed to retrieve the IAlgManager interface." << endmsg;
00419     return sc;
00420   }
00421   sc = service("IncidentSvc", m_incSvc, true);
00422   if ( sc.isFailure () )
00423   {
00424     stream()
00425       << MSG::ERROR << "Failed to retrieve Incident service." << endmsg;
00426     return sc;
00427   }
00428   m_incSvc->addListener(this, m_trapType);
00429   sc = service(m_dataSvcName, m_dataSvc, true);
00430   if ( sc.isFailure () )
00431   {
00432     stream()
00433       << MSG::ERROR
00434       << "Failed to retrieve the data provider interface of "
00435       << m_dataSvcName << endmsg;
00436     return sc;
00437   }
00438   return update() ;
00439 }

void DataOnDemandSvc::update_1 ( Property & p )

Definition at line 112 of file DataOnDemandSvc.cpp.

00113 {
00114   stream() << MSG::VERBOSE << " I am update handler for property " << p << endmsg ;
00115   // force update
00116   m_updateRequired = true ;
00117 }

void DataOnDemandSvc::update_2 ( Property & p )

Definition at line 133 of file DataOnDemandSvc.cpp.

00134 {
00135   stream() << MSG::WARNING
00136            << "The property 'Algorithms' is obsolete, switch to map-like 'AlgMap'  "
00137            << " = { 'data' : 'algorithm' } "
00138            << endmsg ;
00139   // force update
00140   m_updateRequired = true ;
00141 }

void DataOnDemandSvc::update_3 ( Property & p )

Definition at line 121 of file DataOnDemandSvc.cpp.

00122 {
00123   stream() << MSG::WARNING
00124            << "The property 'Nodes'      is obsolete, switch to map-like 'NodeMap' "
00125            << " = { 'data' : 'type'      } "
00126            << endmsg ;
00127   // force update
00128   m_updateRequired = true ;
00129 }

void DataOnDemandSvc::update_dump ( Property & )

update handler for 'Dump' property

Definition at line 145 of file DataOnDemandSvc.cpp.

00146 {
00147   // no action if not yet initialized 
00148   if ( FSMState() < Gaudi::StateMachine::INITIALIZED ) { return ; }
00149   // dump the configuration:
00150   if ( m_dump ) { dump ( MSG::ALWAYS ) ; }
00151 }

StatusCode DataOnDemandSvc::update ( ) [protected]

update the handlers

convert obsolete "Nodes" into new "NodeMap"

convert obsolete "Algorithms" into new "AlgMap"

add the default prefix

get all directories

setup algorithms

setup nodes

Definition at line 235 of file DataOnDemandSvc.cpp.

00236 {
00237   if ( !m_updateRequired ) { return StatusCode::SUCCESS  ; }
00238   
00240   StatusCode sc = setupNodeHandlers() ; // convert "Nodes"      new "NodeMap"
00241   if ( sc.isFailure() )
00242   {
00243     stream() << MSG::ERROR << "Failed to setup old \"Nodes\""      << endmsg ;
00244     return sc ;
00245   }
00247   sc = setupAlgHandlers()   ; // convert "Algorithms" into "AlgMap"
00248   if ( sc.isFailure() )
00249   {
00250     stream() << MSG::ERROR << "Failed to setup old \"Algorithms\"" << endmsg ;
00251     return sc ;
00252   }
00254   add_prefix ( m_algMap  , m_prefix ) ;
00256   add_prefix ( m_nodeMap , m_prefix ) ;
00258   typedef std::set<std::string> Set ;
00259   Set dirs ;
00260   if ( m_partialPath ){ get_dirs ( m_algMap  , dirs ) ; }
00261   if ( m_partialPath ){ get_dirs ( m_nodeMap , dirs ) ; }
00262   //
00263   Set::iterator _e = dirs.find("/Event") ;
00264   if ( dirs.end() != _e ) { dirs.erase( _e ) ; }
00265   // add all directories as nodes
00266   for ( Set::const_iterator dir = dirs.begin() ; dirs.end() != dir ; ++dir )
00267   {
00268     if ( m_algMap  .end () != m_algMap  .find ( *dir ) ) { continue ; }
00269     if ( m_nodeMap .end () != m_nodeMap .find ( *dir ) ) { continue ; }
00270     m_nodeMap [*dir] = "DataObject" ;
00271   }
00272   //
00273   m_algs  .clear  () ;
00274   m_nodes .clear  () ;
00275   //
00277   for ( Map::const_iterator ialg = m_algMap.begin() ;
00278         m_algMap.end() != ialg ; ++ialg )
00279   {
00280     Gaudi::Utils::TypeNameString alg ( ialg->second ) ;
00281     Leaf leaf ( alg.type() , alg.name() ) ;
00282     if  ( m_init ) 
00283     {
00284       StatusCode sc = configureHandler ( leaf ) ; 
00285       if ( sc.isFailure() ) {  leaf =  Leaf( alg.type() , alg.name() ) ; }
00286     }
00287     m_algs[ialg->first] =  leaf ;
00288   }
00290   for ( Map::const_iterator inode = m_nodeMap.begin() ;
00291         m_nodeMap.end() != inode ; ++inode )
00292   {
00293     ClassH cl = ROOT::Reflex::Type::ByName( inode->second ) ;
00294     if ( !cl )
00295     {
00296       stream() << MSG::WARNING
00297                << "Failed to access dictionary class for "
00298                << inode->first << " of type:" << inode->second << endmsg;
00299     }
00300     m_nodes[inode->first] = Node ( cl , false , inode->second ) ;
00301   }
00303   m_updateRequired = false ;
00304   //
00305   return StatusCode::SUCCESS ;
00306 }

MsgStream& DataOnDemandSvc::stream ( ) const [inline, protected]

get the message stream

Definition at line 236 of file DataOnDemandSvc.h.

00237   {
00238     if ( 0 == m_log ) { m_log = new MsgStream( msgSvc() , name() ) ; }
00239     return *m_log;
00240   }

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 715 of file DataOnDemandSvc.cpp.

00717 {
00718   if ( m_algs.empty()  &&  m_nodes.empty() ) { return ; }
00719 
00720   typedef std::pair<std::string,std::string> Pair ;
00721   typedef std::map<std::string,Pair>         PMap ;
00722 
00723   PMap _m ;
00724   for ( AlgMap::const_iterator alg = m_algs.begin() ;
00725         m_algs.end() != alg ; ++alg )
00726   {
00727     PMap::const_iterator check = _m.find(alg->first) ;
00728     if ( _m.end() != check )
00729     {
00730       stream()
00731         << MSG::WARNING
00732         << " The data item is activated for '"
00733         << check->first << "' as '" << check->second.first << "'" << endmsg ;
00734     }
00735     const Leaf& l = alg->second ;
00736     std::string nam = ( l.name == l.type ? l.type  : (l.type+"/"+l.name) ) ;
00737     //
00738     if ( !mode && 0 == l.num ) { continue ; }
00739     //
00740     std::string val ;
00741     if ( mode ) { val = ( 0 == l.algorithm ) ? "F" : "T" ; }
00742     else { val = boost::lexical_cast<std::string>( l.num ) ; }
00743     //
00744     _m[ no_prefix ( alg->first , m_prefix ) ] = std::make_pair ( nam , val ) ;
00745   }
00746   // nodes:
00747   for ( NodeMap::const_iterator node = m_nodes.begin() ;
00748         m_nodes.end() != node ; ++node )
00749   {
00750     PMap::const_iterator check = _m.find(node->first) ;
00751     if ( _m.end() != check )
00752     {
00753       stream()
00754         << MSG::WARNING
00755         << " The data item is already activated for '"
00756         << check->first << "' as '" << check->second.first << "'" << endmsg ;
00757     }
00758     const Node& n = node->second ;
00759     std::string nam = "'" + n.name + "'"  ;
00760     //
00761     std::string val ;
00762 
00763     if ( !mode && 0 == n.num ) { continue ; }
00764 
00765     if ( mode ) { val = ( 0 == n.clazz ) ? "F" : "T" ; }
00766     else { val = boost::lexical_cast<std::string>( n.num ) ; }
00767     //
00768     _m[ no_prefix ( node->first , m_prefix ) ] = std::make_pair ( nam , val ) ;
00769   }
00770   //
00771   if ( _m.empty() ) { return ; }
00772 
00773   // find the correct formats
00774   size_t n1 = 0 ;
00775   size_t n2 = 0 ;
00776   size_t n3 = 0 ;
00777   for  ( PMap::const_iterator it = _m.begin() ; _m.end() != it ; ++it )
00778   {
00779     n1 = std::max ( n1 , it->first.size()         ) ;
00780     n2 = std::max ( n2 , it->second.first.size()  ) ;
00781     n3 = std::max ( n3 , it->second.second.size() ) ;
00782   }
00783   if ( 10 > n1 ) { n1 = 10 ; }
00784   if ( 10 > n2 ) { n2 = 10 ; }
00785   if ( 60 < n1 ) { n1 = 60 ; }
00786   if ( 60 < n2 ) { n2 = 60 ; }
00787   //
00788 
00789   const std::string _f = " | %%1$-%1%.%1%s | %%2$-%2%.%2%s | %%3$%3%.%3%s |" ;
00790   boost::format _ff ( _f ) ;
00791   _ff % n1 % n2 % n3 ;
00792 
00793   const std::string _format  = _ff.str() ;
00794 
00795   MsgStream& msg = stream() << level ;
00796 
00797   if ( mode ) { msg << "Data-On-Demand Actions enabled for:"       ; }
00798   else        { msg << "Data-On-Demand Actions has been used for:" ; }
00799 
00800   boost::format fmt1( _format)  ;
00801   fmt1 % "Address" % "Creator" % ( mode ? "S" : "#" ) ;
00802   //
00803   const std::string header = fmt1.str() ;
00804   std::string line = std::string( header.size() , '-' ) ;
00805   line[0] = ' ' ;
00806 
00807   msg << std::endl << line
00808       << std::endl << header
00809       << std::endl << line ;
00810 
00811   // make the actual printout:
00812   for ( PMap::const_iterator item = _m.begin() ;
00813         _m.end() != item ; ++item )
00814   {
00815     boost::format fmt( _format)  ;
00816     msg << std::endl <<
00817       ( fmt % item->first % item->second.first % item->second.second ) ;
00818   }
00819 
00820   msg << std::endl << line << endmsg ;
00821 
00822 }

Member Data Documentation

IIncidentSvc* DataOnDemandSvc::m_incSvc [private]

Incident service.

Definition at line 250 of file DataOnDemandSvc.h.

IAlgManager* DataOnDemandSvc::m_algMgr [private]

Algorithm manager.

Definition at line 252 of file DataOnDemandSvc.h.

IDataProviderSvc* DataOnDemandSvc::m_dataSvc [private]

Data provider reference.

Definition at line 254 of file DataOnDemandSvc.h.

std::string DataOnDemandSvc::m_trapType [private]

Trap name.

Definition at line 256 of file DataOnDemandSvc.h.

std::string DataOnDemandSvc::m_dataSvcName [private]

Data service name.

Definition at line 258 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_partialPath [private]

Flag to allow for the creation of partial leaves.

Definition at line 260 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_dump [private]

flag to force the printout

Definition at line 262 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_init [private]

flag to warm up the configuration

Definition at line 264 of file DataOnDemandSvc.h.

Setup DataOnDemandSvc::m_algMapping [private]

Mapping to algorithms.

Definition at line 266 of file DataOnDemandSvc.h.

Setup DataOnDemandSvc::m_nodeMapping [private]

Mapping to nodes.

Definition at line 268 of file DataOnDemandSvc.h.

AlgMap DataOnDemandSvc::m_algs [private]

Map of algorithms to handle incidents.

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 272 of file DataOnDemandSvc.h.

Map DataOnDemandSvc::m_algMap [private]

the major configuration property { 'data' : 'algorithm' }

Definition at line 276 of file DataOnDemandSvc.h.

Map DataOnDemandSvc::m_nodeMap [private]

the major configuration property { 'data' : 'type' }

Definition at line 278 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_updateRequired [private]

Definition at line 279 of file DataOnDemandSvc.h.

std::string DataOnDemandSvc::m_prefix [private]

Definition at line 280 of file DataOnDemandSvc.h.

MsgStream* DataOnDemandSvc::m_log [mutable, private]

Definition at line 281 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_total [private]

Definition at line 283 of file DataOnDemandSvc.h.

ulonglong DataOnDemandSvc::m_statAlg [private]

Definition at line 284 of file DataOnDemandSvc.h.

ulonglong DataOnDemandSvc::m_statNode [private]

Definition at line 285 of file DataOnDemandSvc.h.

ulonglong DataOnDemandSvc::m_stat [private]

Definition at line 286 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_timer_nodes [private]

Definition at line 288 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_timer_algs [private]

Definition at line 289 of file DataOnDemandSvc.h.

ChronoEntity DataOnDemandSvc::m_timer_all [private]

Definition at line 290 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_locked_nodes [private]

Definition at line 291 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_locked_algs [private]

Definition at line 292 of file DataOnDemandSvc.h.

bool DataOnDemandSvc::m_locked_all [private]

Definition at line 293 of file DataOnDemandSvc.h.

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

/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v21r7p1/GaudiSvc/src/IncidentSvc/DataOnDemandSvc.h
/afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v21r7p1/GaudiSvc/src/IncidentSvc/DataOnDemandSvc.cpp


Public Types
typedef std::vector< std::string >	Setup
typedef ROOT::Reflex::Type	ClassH
typedef GaudiUtils::HashMap < Gaudi::StringKey, Node >	NodeMap
typedef GaudiUtils::HashMap < Gaudi::StringKey, Leaf >	AlgMap
Public Member Functions
virtual StatusCode	initialize ()
	Inherited Service overrides: Service initialization.
virtual StatusCode	finalize ()
	Inherited Service overrides: Service finalization.
virtual StatusCode	reinitialize ()
	Inherited Service overrides: Service reinitialization.
virtual void	handle (const Incident &incident)
	IIncidentListener interfaces overrides: incident handling.
	DataOnDemandSvc (const std::string &name, ISvcLocator *svc)
	Standard initializing service constructor.
virtual	~DataOnDemandSvc ()
	Standard destructor.
void	update_1 (Property &p)
void	update_2 (Property &p)
void	update_3 (Property &p)
void	update_dump (Property &)
	update handler for 'Dump' property
Protected Member Functions
StatusCode	configureHandler (Leaf &leaf)
	Configure handler for leaf.
StatusCode	execHandler (const std::string &tag, Leaf &leaf)
	Execute leaf handler (algorithm).
StatusCode	execHandler (const std::string &tag, Node &node)
	Execute node handler (simple object creation using seal reflection).
StatusCode	setupNodeHandlers ()
	Initialize node handlers.
StatusCode	setupAlgHandlers ()
	Initialize leaf handlers.
StatusCode	setup ()
	Setup routine (called by (re-) initialize.
StatusCode	update ()
	update the handlers
MsgStream &	stream () const
	get the message stream
void	dump (const MSG::Level level, const bool mode=true) const
	dump the content of DataOnDemand service
Private Types
typedef std::map< std::string, std::string >	Map
Private Attributes
IIncidentSvc *	m_incSvc
	Incident service.
IAlgManager *	m_algMgr
	Algorithm manager.
IDataProviderSvc *	m_dataSvc
	Data provider reference.
std::string	m_trapType
	Trap name.
std::string	m_dataSvcName
	Data service name.
bool	m_partialPath
	Flag to allow for the creation of partial leaves.
bool	m_dump
	flag to force the printout
bool	m_init
	flag to warm up the configuration
Setup	m_algMapping
	Mapping to algorithms.
Setup	m_nodeMapping
	Mapping to nodes.
AlgMap	m_algs
	Map of algorithms to handle incidents.
NodeMap	m_nodes
	Map of "empty" objects to be placed as intermediate nodes.
Map	m_algMap
	the major configuration property { 'data' : 'algorithm' }
Map	m_nodeMap
	the major configuration property { 'data' : 'type' }
bool	m_updateRequired
std::string	m_prefix
MsgStream *	m_log
ChronoEntity	m_total
ulonglong	m_statAlg
ulonglong	m_statNode
ulonglong	m_stat
ChronoEntity	m_timer_nodes
ChronoEntity	m_timer_algs
ChronoEntity	m_timer_all
bool	m_locked_nodes
bool	m_locked_algs
bool	m_locked_all
Classes
struct	Leaf
struct	Node
	Helper class of the DataOnDemandSvc. More...
struct	Protection
	Helper class of the DataOnDemandSvc. More...

Gaudi Framework, version v21r7p1

DataOnDemandSvc Class Reference

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Classes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation