HepMC3 event record library
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
ReaderPlugin Class Reference

Detailed Description

GenEvent I/O parsing and serialization using external plugin.

Definition at line 23 of file ReaderPlugin.h.

#include <ReaderPlugin.h>

+ Inheritance diagram for ReaderPlugin:
+ Collaboration diagram for ReaderPlugin:

Public Member Functions

 ReaderPlugin (std::istream &stream, const std::string &libname, const std::string &newreader)
 Constructor to read from stream.
 
 ReaderPlugin (const std::string &filename, const std::string &libname, const std::string &newreader)
 Constructor to read from file.
 
bool read_event (GenEvent &ev) override
 Reading event.
 
void close () override
 Close.
 
bool failed () override
 State.
 
 ~ReaderPlugin () override
 Destructor.
 
virtual bool skip (const int)
 skip or fast forward reading of some events
 
std::shared_ptr< GenRunInforun_info () const
 Get the global GenRunInfo object.
 
void set_options (const std::map< std::string, std::string > &options)
 Set options.
 
std::map< std::string, std::string > get_options () const
 Set options.
 

Protected Member Functions

void set_run_info (std::shared_ptr< GenRunInfo > run)
 Set the global GenRunInfo object.
 

Protected Attributes

std::map< std::string, std::string > m_options
 options
 

Private Attributes

Readerm_reader
 The actual reader.
 
void * dll_handle
 library handler
 
std::shared_ptr< GenRunInfom_run_info
 The global GenRunInfo object.
 

Constructor & Destructor Documentation

◆ ReaderPlugin() [1/2]

ReaderPlugin ( std::istream &  stream,
const std::string &  libname,
const std::string &  newreader 
)

Constructor to read from stream.

Definition at line 28 of file ReaderPlugin.cc.

References ReaderPlugin::dll_handle, and ReaderPlugin::m_reader.

◆ ReaderPlugin() [2/2]

ReaderPlugin ( const std::string &  filename,
const std::string &  libname,
const std::string &  newreader 
)

Constructor to read from file.

Constructor.

Definition at line 50 of file ReaderPlugin.cc.

References ReaderPlugin::dll_handle, and ReaderPlugin::m_reader.

◆ ~ReaderPlugin()

~ReaderPlugin ( )
override

Destructor.

Definition at line 71 of file ReaderPlugin.cc.

References Reader::close(), ReaderPlugin::dll_handle, and ReaderPlugin::m_reader.

Member Function Documentation

◆ close()

void close ( )
inlineoverridevirtual

Close.

Implements Reader.

Definition at line 33 of file ReaderPlugin.h.

References Reader::close(), and ReaderPlugin::m_reader.

◆ failed()

bool failed ( )
inlineoverridevirtual

State.

Implements Reader.

Definition at line 35 of file ReaderPlugin.h.

References Reader::failed(), and ReaderPlugin::m_reader.

◆ get_options()

std::map< std::string, std::string > get_options ( ) const
inlineinherited

Set options.

Definition at line 58 of file Reader.h.

References Reader::m_options.

◆ read_event()

bool read_event ( GenEvent ev)
inlineoverridevirtual

Reading event.

Implements Reader.

Definition at line 31 of file ReaderPlugin.h.

References ReaderPlugin::m_reader, and Reader::read_event().

◆ run_info()

std::shared_ptr< GenRunInfo > run_info ( ) const
inlineinherited

Get the global GenRunInfo object.

Examples
LHEF_example_cat.cc.

Definition at line 44 of file Reader.h.

References Reader::m_run_info.

◆ set_options()

void set_options ( const std::map< std::string, std::string > &  options)
inlineinherited

Set options.

Definition at line 53 of file Reader.h.

References Reader::m_options.

◆ set_run_info()

void set_run_info ( std::shared_ptr< GenRunInfo run)
inlineprotectedinherited

Set the global GenRunInfo object.

Definition at line 64 of file Reader.h.

References Reader::m_run_info.

◆ skip()

virtual bool skip ( const int  )
inlinevirtualinherited

skip or fast forward reading of some events

Reimplemented in ReaderGZ< T >, ReaderuprootTree, ReaderAscii, ReaderAsciiHepMC2, ReaderHEPEVT, ReaderLHEF, ReaderMT< T, m_number_of_threads >, ReaderRoot, and ReaderRootTree.

Definition at line 34 of file Reader.h.

References Reader::failed().

Field Documentation

◆ dll_handle

void* dll_handle
private

library handler

Definition at line 40 of file ReaderPlugin.h.

◆ m_options

std::map<std::string, std::string> m_options
protectedinherited

options

Definition at line 68 of file Reader.h.

◆ m_reader

Reader* m_reader
private

The actual reader.

Definition at line 39 of file ReaderPlugin.h.

◆ m_run_info

std::shared_ptr<GenRunInfo> m_run_info
privateinherited

The global GenRunInfo object.

Definition at line 71 of file Reader.h.


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