|
Marlin
1.17.1
|
|
Marlin
1.17.1
|
Base class for data source handlers that can read arbitrary non-LCIO input files and create LCIO events and run headers from that. More...
#include <DataSourceProcessor.h>
Public Member Functions | |
| DataSourceProcessor (const std::string &typeName) | |
| virtual void | readDataSource (int numEvents)=0 |
| User call back to read the data source and create the LCIO event and run header. More... | |
 Public Member Functions inherited from marlin::Processor | |
| Processor (const std::string &typeName) | |
| Possible verbosity levels. More... | |
| virtual | ~Processor () |
| Destructor. | |
| virtual Processor * | newProcessor ()=0 |
| Return a new instance of the processor. More... | |
| virtual void | init () |
| Called at the begin of the job before anything is read. More... | |
| virtual void | processRunHeader (LCRunHeader *) |
| Called for every run, e.g. More... | |
| virtual void | processEvent (LCEvent *) |
| Called for every event - the working horse. | |
| virtual void | check (LCEvent *) |
| Called for every event - right after processEvent() has been called for this processor. More... | |
| virtual void | end () |
| Called after data processing for clean up in the inverse order of the init() method so that resources allocated in the first processor also will be available for all following processors. | |
| 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. | |
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... | |
| 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 {} |
Base class for data source handlers that can read arbitrary non-LCIO input files and create LCIO events and run headers from that.
If a user subclass is defined as active processor in the steering file and there are no LCIO input files defined than this class is called to generate the LCIO data stream.
|
pure virtual |
User call back to read the data source and create the LCIO event and run header.
The user needs to call ProcessMgr::processRunHeader(LCRunHeader* rhdr) and ProcessMgr::processEvent(LCEvent* evt) in order to call the relevant Processor methods in readDataSource().
| numEvents | The number of events the DataSourceProcessor should generate. |
Implemented in marlin::StdHepReader.
Referenced by marlin::ProcessorMgr::readDataSource().
1.8.5
