| # Gaudi Framework, version v21r8 |

Home |  | Generated: 17 Mar 2010

# IUpdateManagerSvc Class Reference

Interface class to the Update Manager service. More...

`#include <GaudiKernel/IUpdateManagerSvc.h>`

Inheritance diagram for IUpdateManagerSvc:

[legend]
Collaboration diagram for IUpdateManagerSvc:

[legend]

List of all members.

## Public Member Functions
| DeclareInterfaceID (IUpdateManagerSvc, 2, 0)
| InterfaceID.
virtual IDataProviderSvc * | dataProvider () const =0
| Give access to the data provider.
virtual IDetDataSvc * | detDataSvc () const =0
| Give access to the detector data service interface (usualy of the data provider itself).
template<class CallerClass>
void | registerCondition (CallerClass *instance, const std::string &condition="", typename ObjectMemberFunction< CallerClass >::MemberFunctionType mf=NULL)
| Register an object (algorithm instance) to the service.
template<class CallerClass, class CondType>
void | registerCondition (CallerClass *instance, const std::string &condition, typename ObjectMemberFunction< CallerClass >::MemberFunctionType mf, CondType *&condPtrDest)
template<class CallerClass>
void | registerCondition (CallerClass *instance, const char *condition, typename ObjectMemberFunction< CallerClass >::MemberFunctionType mf=NULL)
| See above. Needed to avoid conflicts with the next one.
template<class CallerClass, class ObjectClass>
void | registerCondition (CallerClass *instance, ObjectClass *obj, typename ObjectMemberFunction< CallerClass >::MemberFunctionType mf=NULL)
| Like the first version of registerCondition, but instead declaring the dependency on a condition of the service privider, it uses an already registered object.
template<class CallerClass>
void | unregister (CallerClass *instance)
| Generic objects can be unregistered from the UpdateManagerSvc.
template<class CallerClass>
void | invalidate (CallerClass *instance)
| Invalidate the given object in the dependency network.
virtual bool | getValidity (const std::string path, Gaudi::Time &since, Gaudi::Time &until, bool path_to_db=false)=0
| Retrieve the interval of validity (in the UpdateManagerSvc) of the given item.
virtual void | setValidity (const std::string path, const Gaudi::Time &since, const Gaudi::Time &until, bool path_to_db=false)=0
| Change the interval of validity of the given item to the specified values, updating parents if needed.
virtual StatusCode | newEvent ()=0
| Start an update loop using the event time given by the detector data service.
virtual StatusCode | newEvent (const Gaudi::Time &)=0
| Start an update loop using the give event time.
template<class CallerClass>
StatusCode | update (CallerClass *instance)
| Update the given instance.
virtual void | dump ()=0
| Debug method: it dumps the dependency network through the message service (not very readable, for experts only).
virtual void | acquireLock ()=0
| Force the update manager service to wait before entering the newEvent loop.
virtual void | releaseLock ()=0
| Let the update manager service enter the newEvent loop.
virtual void | purge ()=0
| Remove all the items referring to objects present in the transient store.
## Protected Member Functions
virtual void | i_registerCondition (const std::string &condition, BaseObjectMemberFunction *mf, BasePtrSetter *ptr_dest=NULL)=0
virtual void | i_registerCondition (void *obj, BaseObjectMemberFunction *mf)=0
virtual StatusCode | i_update (void *instance)=0
virtual void | i_unregister (void *instance)=0
virtual void | i_invalidate (void *instance)=0
## Friends
class | PythonHelper
## Classes
class | PythonHelper
| Helper class implemented in the python dictionary to allow access from python to template member functions. More...

## Detailed Description

Interface class to the Update Manager service.

Users should only use this interface.

Author:
  Marco CLEMENCIC

Date:
  2005-03-30

Definition at line 175 of file IUpdateManagerSvc.h.

## Member Function Documentation

IUpdateManagerSvc::DeclareInterfaceID | ( | IUpdateManagerSvc | ,
|  | 2 | ,
|  | 0 |  |
| ) |  |  |

InterfaceID.

virtual IDataProviderSvc* IUpdateManagerSvc::dataProvider | ( |  | ) | const`[pure virtual]`

Give access to the data provider.

virtual IDetDataSvc* IUpdateManagerSvc::detDataSvc | ( |  | ) | const`[pure virtual]`

Give access to the detector data service interface (usualy of the data provider itself).

template<class CallerClass>

void IUpdateManagerSvc::registerCondition | ( | CallerClass * | instance,
|  | const std::string & | condition = `""`,
|  | typename ObjectMemberFunction< CallerClass >::MemberFunctionType | mf = `NULL` |
| ) |  |  | `[inline]`

Register an object (algorithm instance) to the service.

The object should provide a method to be called in case of an update of the needed condition. An object can register multiple conditions using the same method: it will be called if at least one of the specified conditions is updated, but only when all of them are up to date.

Returns:
  StatusCode::SUCCESS if the registration went right.

Definition at line 193 of file IUpdateManagerSvc.h.

    00194                                                                                                        {
    00195     i_registerCondition(condition, new ObjectMemberFunction<CallerClass>(instance,mf));
    00196   }

template<class CallerClass, class CondType>

void IUpdateManagerSvc::registerCondition | ( | CallerClass * | instance,
|  | const std::string & | condition,
|  | typename ObjectMemberFunction< CallerClass >::MemberFunctionType | mf,
|  | CondType *& | condPtrDest |
| ) |  |  | `[inline]`

Definition at line 199 of file IUpdateManagerSvc.h.

    00201                                                        {
    00202     i_registerCondition(condition, new ObjectMemberFunction<CallerClass>(instance,mf),
    00203                         new PtrSetter<CondType>(condPtrDest));
    00204   }

template<class CallerClass>

void IUpdateManagerSvc::registerCondition | ( | CallerClass * | instance,
|  | const char * | condition,
|  | typename ObjectMemberFunction< CallerClass >::MemberFunctionType | mf = `NULL` |
| ) |  |  | `[inline]`

See above. Needed to avoid conflicts with the next one.

Definition at line 208 of file IUpdateManagerSvc.h.

    00209                                                                                                        {
    00210     i_registerCondition(std::string(condition), new ObjectMemberFunction<CallerClass>(instance,mf));
    00211   }

template<class CallerClass, class ObjectClass>

void IUpdateManagerSvc::registerCondition | ( | CallerClass * | instance,
|  | ObjectClass * | obj,
|  | typename ObjectMemberFunction< CallerClass >::MemberFunctionType | mf = `NULL` |
| ) |  |  | `[inline]`

Like the first version of registerCondition, but instead declaring the dependency on a condition of the service privider, it uses an already registered object.

It means that a generic object can depend on another generic object that depends on a ValidDataObject. The dependency network is kept consistent by the UpdateManagerSvc.

Definition at line 217 of file IUpdateManagerSvc.h.

    00218                                                                                                        {
    00219         i_registerCondition(dynamic_cast<void*>(obj), new ObjectMemberFunction<CallerClass>(instance,mf));
    00220   }

template<class CallerClass>

void IUpdateManagerSvc::unregister | ( | CallerClass * | instance | ) | `[inline]`

Generic objects can be unregistered from the UpdateManagerSvc.

The dependency network is always consistent, but internal IOVs are not modified.

Warning:
  {Removing a node which other nodes depends on can create problems if the / methods of this other nodes are called.}

Definition at line 226 of file IUpdateManagerSvc.h.

    00226                                                 {
    00227     i_unregister(dynamic_cast<void*>(instance));
    00228   }

template<class CallerClass>

void IUpdateManagerSvc::invalidate | ( | CallerClass * | instance | ) | `[inline]`

Invalidate the given object in the dependency network.

It means that all the objects depending on that one will be updated before the next event.

Definition at line 233 of file IUpdateManagerSvc.h.

    00233 {i_invalidate(dynamic_cast<void*>(instance));}

virtual bool IUpdateManagerSvc::getValidity | ( | const std::string | path,
|  | Gaudi::Time & | since,
|  | Gaudi::Time & | until,
|  | bool | path_to_db = `false` |
| ) |  |  | `[pure virtual]`

Retrieve the interval of validity (in the UpdateManagerSvc) of the given item.

Returns:
  false if the item was not found.

virtual void IUpdateManagerSvc::setValidity | ( | const std::string | path,
|  | const Gaudi::Time & | since,
|  | const Gaudi::Time & | until,
|  | bool | path_to_db = `false` |
| ) |  |  | `[pure virtual]`

Change the interval of validity of the given item to the specified values, updating parents if needed.

The change can only restrict the current IOV, If you want to expand the validity you should act on the transient data store and the change will be reflected at the next update.

virtual StatusCode IUpdateManagerSvc::newEvent | ( |  | ) | `[pure virtual]`

Start an update loop using the event time given by the detector data service.

virtual StatusCode IUpdateManagerSvc::newEvent | ( | const Gaudi::Time & |  | ) | `[pure virtual]`

Start an update loop using the give event time.

NOTE: the given event time is only used to check if updates are needed, the real update is done using the detector data service event time. (may change in future)

template<class CallerClass>

StatusCode IUpdateManagerSvc::update | ( | CallerClass * | instance | ) | `[inline]`

Update the given instance.

This method should be called by the object after registration to ensure that the needed operations is done immediately and not before the next event.

Definition at line 256 of file IUpdateManagerSvc.h.

    00256                                                  {
    00257     return i_update(dynamic_cast<void*>(instance));
    00258   }

virtual void IUpdateManagerSvc::dump | ( |  | ) | `[pure virtual]`

Debug method: it dumps the dependency network through the message service (not very readable, for experts only).

virtual void IUpdateManagerSvc::acquireLock | ( |  | ) | `[pure virtual]`

Force the update manager service to wait before entering the newEvent loop.

virtual void IUpdateManagerSvc::releaseLock | ( |  | ) | `[pure virtual]`

Let the update manager service enter the newEvent loop.

virtual void IUpdateManagerSvc::purge | ( |  | ) | `[pure virtual]`

Remove all the items referring to objects present in the transient store.

This is needed when the Detector Transient Store is purged, otherwise we will keep pointers to not existing objects.

virtual void IUpdateManagerSvc::i_registerCondition | ( | const std::string & | condition,
|  | BaseObjectMemberFunction * | mf,
|  | BasePtrSetter * | ptr_dest = `NULL` |
| ) |  |  | `[protected, pure virtual]`

virtual void IUpdateManagerSvc::i_registerCondition | ( | void * | obj,
|  | BaseObjectMemberFunction * | mf |
| ) |  |  | `[protected, pure virtual]`

virtual StatusCode IUpdateManagerSvc::i_update | ( | void * | instance | ) | `[protected, pure virtual]`

virtual void IUpdateManagerSvc::i_unregister | ( | void * | instance | ) | `[protected, pure virtual]`

virtual void IUpdateManagerSvc::i_invalidate | ( | void * | instance | ) | `[protected, pure virtual]`

## Friends And Related Function Documentation

friend class PythonHelper`[friend]`

Definition at line 289 of file IUpdateManagerSvc.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v21r8/GaudiKernel/GaudiKernel/IUpdateManagerSvc.h