|
Mēnsūra
|
Abstract base class for reader plugins. More...
#include <ReaderPlugin.hpp>
Public Member Functions | |
| ReaderPlugin (std::string const &name) | |
| Constructor. | |
| ReaderPlugin (ReaderPlugin const &)=default | |
| Default copy constructor. | |
| ReaderPlugin (ReaderPlugin &&)=default | |
| Default move constructor. | |
| ReaderPlugin & | operator= (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. | |
| Plugin & | operator= (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 Plugin * | Clone () 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... | |
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... | |
Abstract base class for reader plugins.
Compared to the base class Plugin, here a specific logic to interpret boolean decision issued by ProcessEvent method is implemented. The decision is treated as an indication of a succeful reading. If the value is false, it means that there are events left in the input dataset, and therefore the parent Processor must terminate the event loop and proceed to the next dataset.
Consult documentation for the base class. In particular, in a derived class user must implement methods Clone and ProcessEvent.
1.8.10
