Reader Class Reference

Detailed Description

Base class for all I/O readers.

Examples

convert_example.cc.

Definition at line 25 of file Reader.h.

#include <Reader.h>

Inheritance diagram for Reader:

Collaboration diagram for Reader:

Public Member Functions
virtual	~Reader ()
	Virtual destructor.
virtual bool	read_event (GenEvent &evt)=0
	Fill next event from input into evt.
virtual bool	failed ()=0
	Get file and/or stream error state.
virtual void	close ()=0
	Close file and/or stream.
shared_ptr< GenRunInfo >	run_info () const
	Get the global GenRunInfo object.

Protected Member Functions
void	set_run_info (shared_ptr< GenRunInfo > run)
	Set the global GenRunInfo object.

Private Attributes
shared_ptr< GenRunInfo >	m_run_info
	The global GenRunInfo object.

Constructor & Destructor Documentation

~Reader()

virtual ~Reader ( )

inlinevirtual

Virtual destructor.

Definition at line 29 of file Reader.h.

Member Function Documentation

close()

virtual void close ( )

pure virtual

Close file and/or stream.

Implemented in ReaderGZ, ReaderAscii, ReaderAsciiHepMC2, ReaderHEPEVT, ReaderLHEF, ReaderRoot, and ReaderRootTree.

Examples

convert_example.cc.

failed()

virtual bool failed ( )

pure virtual

Get file and/or stream error state.

Implemented in ReaderGZ, ReaderAscii, ReaderAsciiHepMC2, ReaderHEPEVT, ReaderLHEF, ReaderRoot, and ReaderRootTree.

Examples

convert_example.cc.

read_event()

virtual bool read_event ( GenEvent &  evt )

pure virtual

Fill next event from input into evt.

Implemented in ReaderLHEF, ReaderGZ, ReaderAscii, ReaderAsciiHepMC2, ReaderHEPEVT, ReaderRoot, and ReaderRootTree.

Examples

convert_example.cc.

run_info()

shared_ptr< GenRunInfo > run_info ( ) const

inline

Get the global GenRunInfo object.

Examples

LHEF_example_cat.cc, and convert_example.cc.

Definition at line 39 of file Reader.h.

References Reader::m_run_info.

set_run_info()

void set_run_info ( shared_ptr< GenRunInfo >  run )

inlineprotected

Set the global GenRunInfo object.

Definition at line 46 of file Reader.h.

References Reader::m_run_info.

Field Documentation

m_run_info

shared_ptr<GenRunInfo> m_run_info

private

The global GenRunInfo object.

Definition at line 53 of file Reader.h.

---

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

• Reader.h