Loading [MathJax]/extensions/tex2jax.js
The Gaudi Framework  v31r0 (aeb156f0)
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
DataOnDemandSvc.h
Go to the documentation of this file.
1 #ifndef GAUDISVC_DATAONDEMANDSVC_H
2 #define GAUDISVC_DATAONDEMANDSVC_H
3 // ============================================================================
4 // Include Files
5 // ============================================================================
6 // STD & STL
7 // ============================================================================
8 #include <map>
9 #include <vector>
10 // ============================================================================
11 // GaudiKernel
12 // ============================================================================
17 #include "GaudiKernel/Service.h"
18 #include "GaudiKernel/StatEntity.h"
19 #include "GaudiKernel/StringKey.h"
20 // ============================================================================
21 // ROOT TClass
22 // ============================================================================
23 #include "TClass.h"
24 // ============================================================================
25 // Forward declarations
26 // ============================================================================
27 class IAlgTool;
28 class IAlgorithm;
29 class IAlgManager;
30 class IIncidentSvc;
31 class IDataProviderSvc;
32 class IToolSvc;
33 // ============================================================================
90 class DataOnDemandSvc : public extends<Service, IIncidentListener> {
91 public:
92  // ==========================================================================
93  // Typedefs
95  typedef TClass* ClassH;
96  // ==========================================================================
101  struct Protection {
102  bool& m_bool;
103  Protection( bool& b ) : m_bool( b ) { m_bool = true; }
104  ~Protection() { m_bool = false; }
105  };
106  // ==========================================================================
112  struct Node {
113  // ========================================================================
115  ClassH clazz; // the actual class
117  unsigned long num = 0;
118  bool executing = false;
120  bool dataObject = false; // trivial object? DataObject?
121  // =======================================================================
122  Node() = default;
123  // ========================================================================
124  Node( ClassH c, bool e, std::string n )
125  : clazz( c ), name( std::move( n ) ), executing( e ), dataObject( "DataObject" == name ) {}
126  //
127  Node( const Node& c )
128  : clazz( c.clazz ), name( c.name ), num( c.num ), executing( c.executing ), dataObject( c.dataObject ) {}
129  // ========================================================================
130  };
131  // ==========================================================================
133  struct Leaf {
134  IAlgorithm* algorithm = nullptr;
137  unsigned long num = 0;
138  bool executing = false;
139  Leaf() = default;
140  Leaf( const Leaf& l ) = default;
141  Leaf( std::string t, std::string n ) : name( std::move( n ) ), type( std::move( t ) ) {}
142  };
143  // ==========================================================================
144 public:
145  // ==========================================================================
149  StatusCode initialize() override;
151  StatusCode finalize() override;
153  StatusCode reinitialize() override;
155  void handle( const Incident& incident ) override;
157  using extends::extends;
158  // ==========================================================================
159 protected:
160  // ==========================================================================
166  // ==========================================================================
172  StatusCode execHandler( const std::string& tag, Leaf& leaf );
173  // ==========================================================================
179  StatusCode execHandler( const std::string& tag, Node& node );
180  // ==========================================================================
183  // ==========================================================================
186  // ==========================================================================
188  StatusCode setup();
190  void i_setNodeHandler( const std::string& name, const std::string& type );
193  // ==========================================================================
194 protected:
195  // ==========================================================================
197  StatusCode update();
202  void dump( const MSG::Level level, const bool mode = true ) const;
203  // ==========================================================================
204 private:
205  // ==========================================================================
207  verbose() << "updated property " << p.name() << ", forcing update" << endmsg;
208  m_updateRequired = true;
209  };
211  warning() << p.name() << " " << p.documentation() << endmsg;
212  force_update( p );
213  };
214 
215  // ==========================================================================
225  AlgMap m_algs;
227  NodeMap m_nodes;
228 
229  bool m_updateRequired = true;
230  // ==========================================================================
232  unsigned long long m_statAlg = 0;
233  unsigned long long m_statNode = 0;
234  unsigned long long m_stat = 0;
235  // ==========================================================================
239  bool m_locked_nodes = false;
240  bool m_locked_algs = false;
241  bool m_locked_all = false;
242  // ==========================================================================
245  // ==========================================================================
246  // Properties
247  Gaudi::Property<std::string> m_trapType{this, "IncidentName", "DataFault", "the type of handled Incident"};
248  Gaudi::Property<std::string> m_dataSvcName{this, "DataSvc", "EventDataSvc", "DataSvc name"};
249 
250  Gaudi::Property<bool> m_partialPath{this, "UsePreceedingPath", true, "allow creation of partial leaves"};
252  this, "Dump", false,
253  [this]( auto& ) {
255  },
256  "dump configuration and stastics, if set to True after initialize it triggers a dump immediately"};
257  Gaudi::Property<bool> m_init{this, "PreInitialize", false, "(pre)initialize all algorithms"};
259  this, "AllowPreInitializeFailure", false,
260  "allow (pre)initialization of algorithms to fail without stopping the application"};
261 
263  this, "Algorithms", {}, &DataOnDemandSvc::deprecated_property, "[[deprecated]] use AlgMap"};
265  this, "Nodes", {}, &DataOnDemandSvc::deprecated_property, "[[deprecated]] use NodeMap"};
266 
268  Gaudi::Property<Map> m_algMap{this, "AlgMap", {}, &DataOnDemandSvc::force_update, "mapping {'data': 'algorithm'}"};
269  Gaudi::Property<Map> m_nodeMap{this, "NodeMap", {}, &DataOnDemandSvc::force_update, "mapping {'data': 'type'}"};
270 
271  Gaudi::Property<std::string> m_prefix{this, "Prefix", "/Event/"};
272 
274  this, "NodeMappingTools", {}, "list of tools of type IDODNodeMapper"};
276  this, "AlgMappingTools", {}, "list of tools of type IDODAlgMapper"};
277 };
278 // ============================================================================
279 
280 // ============================================================================
281 // The END
282 // ============================================================================
283 #endif // GAUDISVC_DATAONDEMANDSVC_H
void i_setNodeHandler(const std::string &name, const std::string &type)
Internal method to initialize a node handler.
The interface implemented by the IToolSvc base class.
Definition: IToolSvc.h:19
ChronoEntity m_timer_all
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
The DataOnDemandSvc listens to incidents typically triggered by the data service of the configurable ...
Implementation of property with value of concrete type.
Definition: Property.h:352
ChronoEntity m_timer_algs
a small helper class for implementation of ChronoStatSvc service, It also could be used as some local...
Definition: ChronoEntity.h:21
const std::string name() const
property name
Definition: Property.h:36
SmartIF< IIncidentSvc > m_incSvc
Incident service.
void handle(const Incident &incident) override
IIncidentListener interfaces overrides: incident handling.
std::vector< std::string > Setup
MsgStream & verbose() const
shortcut for the method msgStream(MSG::VERBOSE)
The IAlgManager is the interface implemented by the Algorithm Factory in the Application Manager to s...
Definition: IAlgManager.h:27
Gaudi::Property< std::string > m_trapType
STL namespace.
Gaudi::Property< Map > m_nodeMap
Gaudi::Property< bool > m_init
Data provider interface definition.
StatusCode initialize() override
Inherited Service overrides: Service initialization.
void force_update(Gaudi::Details::PropertyBase &p)
void deprecated_property(Gaudi::Details::PropertyBase &p)
STL class.
SmartIF< IDataProviderSvc > m_dataSvc
Data provider reference.
Gaudi::Property< Setup > m_algMapping
Gaudi::Property< std::vector< std::string > > m_algMapTools
ClassH clazz
the actual class
Gaudi::Property< std::string > m_prefix
unsigned long long m_stat
Gaudi::Property< std::vector< std::string > > m_nodeMapTools
Helper class to parse a string of format "type/name".
Gaudi::Property< Map > m_algMap
StatusCode setup()
Setup routine (called by (re-) initialize.
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
StatusCode execHandler(const std::string &tag, Leaf &leaf)
Execute leaf handler (algorithm)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
StatusCode setupNodeHandlers()
Initialize node handlers.
Helper class of the DataOnDemandSvc.
NodeMap m_nodes
Map of "empty" objects to be placed as intermediate nodes.
PropertyBase base class allowing PropertyBase* collections to be "homogeneous".
Definition: Property.h:32
void dump(const MSG::Level level, const bool mode=true) const
dump the content of DataOnDemand service
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:28
dictionary l
Definition: gaudirun.py:517
Gaudi::Property< bool > m_partialPath
std::vector< IDODNodeMapper * > m_nodeMappers
SmartIF< IAlgManager > m_algMgr
Algorithm manager.
Node(ClassH c, bool e, std::string n)
SmartIF< IToolSvc > m_toolSvc
Data provider reference.
AlgMap m_algs
Map of algorithms to handle incidents.
Base class used to extend a class implementing other interfaces.
Definition: extends.h:10
Gaudi::Property< Setup > m_nodeMapping
Leaf(std::string t, std::string n)
ChronoEntity m_timer_nodes
Gaudi::Property< std::string > m_dataSvcName
Base class for all Incidents (computing events).
Definition: Incident.h:17
std::string documentation() const
property documentation
Definition: Property.h:38
The interface implemented by the AlgTool base class.
Definition: IAlgTool.h:23
StatusCode finalize() override
Inherited Service overrides: Service finalization.
Gaudi::StateMachine::State FSMState() const override
Definition: Service.h:52
GaudiUtils::HashMap< Gaudi::StringKey, Node > NodeMap
ChronoEntity m_total
StatusCode setupAlgHandlers()
Initialize leaf handlers.
Helper class of the DataOnDemandSvc.
StatusCode i_setAlgHandler(const std::string &name, const Gaudi::Utils::TypeNameString &alg)
Internal method to initialize an algorithm handler.
Gaudi::Property< bool > m_dump
StatusCode configureHandler(Leaf &leaf)
Configure handler for leaf.
Gaudi::Property< bool > m_allowInitFailure
std::vector< IDODAlgMapper * > m_algMappers
std::map< std::string, std::string > Map
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
unsigned long long m_statNode
The interface implemented by the IncidentSvc service.
Definition: IIncidentSvc.h:23
unsigned long long m_statAlg
StatusCode reinitialize() override
Inherited Service overrides: Service reinitialization.
StatusCode update()
update the handlers
GaudiUtils::HashMap< Gaudi::StringKey, Leaf > AlgMap