Processor that provides access to conditions data in a Marlin application. More...
#include <ConditionsProcessor.h>
Public Member Functions | |
virtual Processor * | newProcessor () |
Return a new instance of the processor. More... | |
virtual void | init () |
Initializes conditions handlers as defined in the steering file. | |
virtual void | processEvent (LCEvent *evt) |
Called for every run. More... | |
virtual void | end () |
Called after data processing for clean up. | |
Public Member Functions inherited from marlin::Processor | |
Processor (const std::string &typeName) | |
Possible verbosity levels. More... | |
virtual | ~Processor () |
Destructor. | |
virtual void | processRunHeader (LCRunHeader *) |
Called for every run, e.g. More... | |
virtual void | check (LCEvent *) |
Called for every event - right after processEvent() has been called for this processor. More... | |
virtual const std::string & | type () const |
Return type name for the processor (as set in constructor). | |
virtual const std::string & | name () const |
Return name of this processor. | |
virtual const std::string & | logLevelName () const |
Return name of the local verbosity level of this processor - "" if not set. | |
virtual std::shared_ptr < StringParameters > | parameters () |
Return parameters defined for this Processor. | |
virtual void | printDescription () |
Print information about this processor in ASCII steering file format. | |
virtual void | printDescriptionXML (std::ostream &stream=std::cout) |
Print information about this processor in XML steering file format. | |
template<class T > | |
void | printParameters () |
Print the parameters and their values depending on the given verbosity level. | |
void | printParameters () |
Print the parameters and their values with verbosity level MESSAGE. | |
const std::string & | description () |
Description of processor. | |
bool | isFirstEvent () |
True if first event in processEvent(evt) - use this e.g. More... | |
std::string | getLCIOInType (const std::string &colName) |
Return the LCIO input type for the collection colName - empty string if colName is not a registered collection name. | |
std::string | getLCIOOutType (const std::string &colName) |
Return the LCIO output type for the collection colName - empty string if colName is not a registered collection name. | |
bool | isInputCollectionName (const std::string ¶meterName) |
True if the given parameter defines an LCIO input collection, i.e. More... | |
bool | isOutputCollectionName (const std::string ¶meterName) |
True if the given parameter defines an LCIO output collection. | |
virtual void | setParameters (std::shared_ptr< StringParameters > parameters) |
Helper function returns the ProcessorParameter for the given name. More... | |
virtual void | setName (const std::string &processorName) |
Set processor name. | |
Static Public Member Functions | |
static bool | registerChangeListener (lccd::IConditionsChangeListener *cl, const std::string &name) |
Registers an IConditionsChangeListener, e.g. More... | |
Protected Attributes | |
std::string | _dbInit ="" |
Default database init string. | |
StringVec | _simpleHandlerInit {} |
initialization of SimpleFileHandlers | |
StringVec | _dbcondHandlerInit {} |
initialization of DBCondHandlers | |
StringVec | _dbfileHandlerInit {} |
initialization of DBFileHandlers | |
StringVec | _datafileHandlerInit {} |
initialization of DataFileHandlers | |
StringVec | _condHandlerNames {} |
the names of all handlers | |
int | _nRun =-1 |
int | _nEvt =-1 |
Protected Attributes inherited from marlin::Processor | |
std::string | _description ="" |
Describes what the processor does. More... | |
std::string | _typeName ="" |
std::string | _processorName ="" |
std::shared_ptr< StringParameters > | _parameters {} |
ProcParamMap | _map {} |
bool | _isFirstEvent = false |
LCIOTypeMap | _inTypeMap {} |
LCIOTypeMap | _outTypeMap {} |
std::string | _logLevelName {} |
Additional Inherited Members | |
Protected Member Functions inherited from marlin::Processor | |
void | setReturnValue (bool val) |
Set the return value for this processor - typically at end of processEvent(). More... | |
void | setReturnValue (const std::string &name, bool val) |
Set a named return value for this processor - typically at end of processEvent() The value can be used in a condition in the steering file referred to by ProcessorName.name of the processor. | |
template<class T > | |
void | registerProcessorParameter (const std::string ¶meterName, const std::string ¶meterDescription, T ¶meter, const T &defaultVal, int setSize=0) |
Register a steering variable for this processor - call in constructor of processor. More... | |
void | registerInputCollection (const std::string &collectionType, const std::string ¶meterName, const std::string ¶meterDescription, std::string ¶meter, const std::string &defaultVal, int setSize=0) |
Specialization of registerProcessorParameter() for a parameter that defines an input collection - can be used fo checking the consistency of the steering file. | |
void | registerOutputCollection (const std::string &collectionType, const std::string ¶meterName, const std::string ¶meterDescription, std::string ¶meter, const std::string &defaultVal, int setSize=0) |
Specialization of registerProcessorParameter() for a parameter that defines an output collection - can be used fo checking the consistency of the steering file. | |
void | registerInputCollections (const std::string &collectionType, const std::string ¶meterName, const std::string ¶meterDescription, StringVec ¶meter, const StringVec &defaultVal, int setSize=0) |
Specialization of registerProcessorParameter() for a parameter that defines one or several input collections - can be used fo checking the consistency of the steering file. | |
template<class T > | |
void | registerOptionalParameter (const std::string ¶meterName, const std::string ¶meterDescription, T ¶meter, const T &defaultVal, int setSize=0) |
Same as registerProcessorParameter except that the parameter is optional. More... | |
bool | parameterSet (const std::string &name) |
Tests whether the parameter has been set in the steering file. | |
void | checkForExistingParameter (const std::string ¶meterName) |
Tests whether the parameter has been registered before. More... | |
template<class T > | |
void | message (const std::string &m) const |
Print message according to verbosity level of the templated parameter (one of DEBUG, MESSAGE, WARNING, ERROR ) and the global parameter "Verbosity". More... | |
template<class T > | |
void | message (const std::basic_ostream< char, std::char_traits< char > > &m) const |
Same as message(const std::string& message) except that it allows the output of more complex messages in the argument using the log() method, e.g. More... | |
std::stringstream & | log () const |
Returns an empty stringstream that is used by the message method. More... | |
Processor that provides access to conditions data in a Marlin application.
Uses LCCD ConditionsHandler. For every ConditionsHandler you have to specify a line in the steering file. Use MyMarlin -l to get examples for the steering parameters.
The conditions data are added to the event as LCCollections with their name. Optionally IConditionsChangeListener subclasses, e.g. ConditionsMaps can be registered for conditions data 'name', these are updated whenever the data changes.
none
Collections of conditions data are added to the event.
DBCondHandler | Initialization of a conditions database handler |
DBFileHandler | Initialization of a conditions db file handler |
DBInit | Initialization string for conditions database |
DataFileHandler | Initialization of a data file handler |
SimpleFileHandler | Initialization of a simple conditions file handler |
|
inlinevirtual |
Return a new instance of the processor.
Has to be implemented by subclasses.
Implements marlin::Processor.
|
virtual |
Called for every run.
Updates all registered conditions handlers and adds the data to the event.
Reimplemented from marlin::Processor.
|
static |
Registers an IConditionsChangeListener, e.g.
a ConditionsMap with the conditions handler 'name'. Returns true if successfull.
References registerChangeListener().
Referenced by registerChangeListener().