Mēnsūra
Public Member Functions | Protected Attributes | List of all members
EventIDReader Class Reference

An abstract base class for a reader plugin that provides event ID. More...

#include <EventIDReader.hpp>

Inheritance diagram for EventIDReader:
ReaderPlugin Plugin PECInputData

Public Member Functions

 EventIDReader (std::string const name="EventID")
 Creates plugin with the given name.
 
 EventIDReader (EventIDReader const &)=default
 Default copy constructor.
 
 EventIDReader (EventIDReader &&)=default
 Default move constructor.
 
EventIDReaderoperator= (EventIDReader const &)=default
 Default assignment operator.
 
virtual ~EventIDReader () noexcept
 Trivial destructor.
 
EventID const & GetEventID () const
 Returns ID of the current event.
 
- Public Member Functions inherited from ReaderPlugin
 ReaderPlugin (std::string const &name)
 Constructor.
 
 ReaderPlugin (ReaderPlugin const &)=default
 Default copy constructor.
 
 ReaderPlugin (ReaderPlugin &&)=default
 Default move constructor.
 
ReaderPluginoperator= (ReaderPlugin const &)=default
 Default assignment operator.
 
virtual ~ReaderPlugin ()
 Trivial destructor.
 
- Public Member Functions inherited from Plugin
 Plugin (std::string const &name)
 Constructor.
 
 Plugin (Plugin const &)=default
 Default copy constructor.
 
 Plugin (Plugin &&)=default
 Default move constructor.
 
Pluginoperator= (Plugin const &)=default
 Default assignment operator.
 
virtual ~Plugin ()
 Trivial destructor.
 
virtual void BeginRun (Dataset const &dataset)
 Performs initialization needed when processing of a new dataset starts. More...
 
virtual PluginClone () const =0
 Clones the object. More...
 
virtual void EndRun ()
 Performs necessary actions needed after processing of a dataset is finished. More...
 
Processor const & GetMaster () const
 Returns a reference to the master. More...
 
std::string const & GetName () const
 Returns name of the plugin.
 
EventOutcome ProcessEventToOutcome ()
 Processes a new event from the current dataset. More...
 
void SetMaster (Processor const *processor)
 Provides a pointer to an instance of Processor class that owns the plugin. More...
 

Protected Attributes

EventID eventID
 ID of the current event converted into the standard format of the framework.
 

Additional Inherited Members

- Public Types inherited from Plugin
enum  EventOutcome { EventOutcome::Ok, EventOutcome::FilterFailed, EventOutcome::NoEvents }
 Outcome of processing of an event. More...
 
- Protected Member Functions inherited from Plugin
Plugin const * GetDependencyPlugin (std::string const &name) const
 Returns a pointer to a precedent plugin in the path with the given name. More...
 

Detailed Description

An abstract base class for a reader plugin that provides event ID.


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