HepMC Reference Documentation HepMC

HepMC::IO_BaseClass Class Reference

all input/output classes inherit from IO_BaseClass More...

#include <IO_BaseClass.h>

Inheritance diagram for HepMC::IO_BaseClass:

List of all members.

Public Member Functions
virtual	~IO_BaseClass ()
virtual void	write_event (const GenEvent *)=0
	write this GenEvent
virtual bool	fill_next_event (GenEvent *)=0
	fill this GenEvent
virtual void	print (std::ostream &ostr=std::cout) const
	write output to ostr
GenEvent *	read_next_event ()
	do not over-ride
virtual GenEvent *&	operator>> (GenEvent *&)
	the same as read_next_event
virtual const GenEvent *&	operator<< (const GenEvent *&)
	the same as write_event
virtual GenEvent *&	operator<< (GenEvent *&)
	the same as write_event

---

Detailed Description

all input/output classes inherit from IO_BaseClass

If you want to write a new IO class, then inherit from this class and re-define read_event() and write_event()

Definition at line 34 of file IO_BaseClass.h.

---

Constructor & Destructor Documentation

virtual HepMC::IO_BaseClass::~IO_BaseClass

(

)

[inline, virtual]

Definition at line 36 of file IO_BaseClass.h.

---

Member Function Documentation

virtual bool HepMC::IO_BaseClass::fill_next_event

(

GenEvent *

)

[pure virtual]

fill this GenEvent

Implemented in HepMC::IO_AsciiParticles, HepMC::IO_GenEvent, HepMC::IO_HEPEVT, and HepMC::IO_HERWIG.

Referenced by read_next_event().

GenEvent *& HepMC::IO_BaseClass::operator<<

(

GenEvent *&

)

[inline, virtual]

the same as write_event

Definition at line 105 of file IO_BaseClass.h.

References write_event().

const GenEvent *& HepMC::IO_BaseClass::operator<<

(

const GenEvent *&

)

[inline, virtual]

the same as write_event

Definition at line 99 of file IO_BaseClass.h.

References write_event().

GenEvent *& HepMC::IO_BaseClass::operator>>

(

GenEvent *&

)

[inline, virtual]

the same as read_next_event

Definition at line 94 of file IO_BaseClass.h.

References read_next_event().

void HepMC::IO_BaseClass::print

(

std::ostream &

ostr = std::cout

)

const [inline, virtual]

write output to ostr

Reimplemented in HepMC::IO_AsciiParticles, HepMC::IO_GenEvent, HepMC::IO_HEPEVT, and HepMC::IO_HERWIG.

Definition at line 90 of file IO_BaseClass.h.

GenEvent * HepMC::IO_BaseClass::read_next_event

(

)

[inline]

do not over-ride

creates a new event and fills it by calling the sister method read_next_event( GenEvent* )

Examples:

example_MyPythiaOnlyToHepMC.cc, fio/example_MyHerwig.cc, fio/example_MyPythia.cc, fio/example_PythiaStreamIO.cc, fio/testHerwigCopies.cc, fio/testPythiaCopies.cc, and testMultipleCopies.cc.in.

Definition at line 74 of file IO_BaseClass.h.

References fill_next_event().

Referenced by event_selection(), main(), operator>>(), pythia_in(), pythia_in_out(), pythia_out(), pythia_particle_out(), and writePythiaStreamIO().

virtual void HepMC::IO_BaseClass::write_event

(

const GenEvent *

)

[pure virtual]

write this GenEvent

Implemented in HepMC::IO_AsciiParticles, HepMC::IO_GenEvent, and HepMC::IO_HEPEVT.

Referenced by operator<<().

---

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

• IO_BaseClass.h

---