LCCD  1.5.0
Public Member Functions | List of all members
lccd::IConditionsHandler Class Referenceabstract

Abstract handler for conditions data. More...

#include <IConditionsHandler.hh>

Inheritance diagram for lccd::IConditionsHandler:
lccd::ConditionsHandlerBase lccd::DataFileHandler lccd::DBCondHandler lccd::DBFileHandler lccd::SimpleFileHandler

Public Member Functions

virtual void updateEvent (lcio::LCEvent *evt)=0
 Retrieves the new conditions data if required by evt->getTimestamp() and adds a collection to event with its name. More...
 
virtual void update (LCCDTimeStamp timestamp)=0
 Retrieves the new conditions data if required by timestamp. More...
 
virtual lcio::LCCollection * currentCollection ()=0
 Returns the current collection of conditions data.
 
virtual void registerChangeListener (IConditionsChangeListener *cl)=0
 Every IConditionsChangeListener will be notified if the conditions data of this instance has changed.
 
virtual void removeChangeListener (IConditionsChangeListener *cl)=0
 Remove the specified listener from list of registered listeners ;.
 
virtual bool isChangeListenerRegistered (IConditionsChangeListener *cl)=0
 checks if the changeListner is Registered
 
virtual void registerDefaultCollection (lcio::LCCollection *col)=0
 Register a pointer to a default collection which will be passed to the IConditionsChangeListener if no data can be found for a given time stamp.
 
virtual lcio::LCCollection * defaultCollection ()=0
 The default collection registered with the handler.
 
virtual lcio::LCCollection * lastValidCollection ()=0
 The last valid collection held by the handler.
 
virtual const std::string name ()=0
 The name of this conditions handler - used, e.g. More...
 
virtual LCCDTimeStamp validSince ()=0
 First timestamp for which the current conditions data is valid.
 
virtual LCCDTimeStamp validTill ()=0
 Last timestamp for which the current conditions data is valid.
 

Detailed Description

Abstract handler for conditions data.

Need one implementation instance for every data set. Check documentation of concrete implemetation for behaviour on update, e.g. a simple file handler might ignore calls to update and always hold the same data set.

Author
F.Gaede, S.Aplin, DESY
Version
Id:
IConditionsHandler.hh,v 1.3 2007-04-27 13:21:31 gaede Exp

Member Function Documentation

virtual const std::string lccd::IConditionsHandler::name ( )
pure virtual

The name of this conditions handler - used, e.g.

as name of the collection in update( lcio::LCEvent* evt ).

See Also
update( lcio::LCEvent* evt )

Implemented in lccd::ConditionsHandlerBase.

virtual void lccd::IConditionsHandler::update ( LCCDTimeStamp  timestamp)
pure virtual

Retrieves the new conditions data if required by timestamp.

Notifies all registered listeners
See implementation classes for details.

Implemented in lccd::DBFileHandler, lccd::DBCondHandler, lccd::ConditionsHandlerBase, lccd::DataFileHandler, and lccd::SimpleFileHandler.

virtual void lccd::IConditionsHandler::updateEvent ( lcio::LCEvent *  evt)
pure virtual

Retrieves the new conditions data if required by evt->getTimestamp() and adds a collection to event with its name.

Notifies all registered listeners

Implemented in lccd::ConditionsHandlerBase, and lccd::DataFileHandler.


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