Run Class Reference

#include <Run.hh>

Collaboration diagram for Run:

[legend]

List of all members.

Public Types
enum	FilterLevel { NOFILT = 0, DOCFILT = 1, UNSTABLEFILT = 2 }
	Enum to specify the level of event format filtering to apply NOFILT = no filtering; DOCFILT = filter unphysical particles with status other than 1, 2, or 4; UNSTABLEFILT = filter as for DOCFILT, but also exclude any unstable particles with status = 2. More...
Public Member Functions
	Run (Generator &gen)
	Make a generator run with a particular gen.
	Run (Generator &gen, const std::string &evtfile="-", int precision=16)
	Make a generator run with a particular gen and I/O target.
void	setFilter (FilterLevel filt=DOCFILT)
	Choose whether to filter out unphysical particles.
bool	makeEvent ()
	Generate an event and send it to the writer if it exists.
const HepMC::GenEvent &	event () const
	Get the current generated event.
std::string	eventSummary () const
	Return an event summary string.
Private Attributes
Generator *	_gen
	Generator used in this run.
FilterLevel	_filter
	Flag to decide whether or not to strip unphysical particles out of events.
HepMC::GenEvent	_evt
	Current HepMC event.
shared_ptr< std::ostream >	_ostr
	Output stream for HepMC writer.
shared_ptr< HepMC::IO_GenEvent >	_io
	HepMC I/O writer.

---

Detailed Description

Author:

Andy Buckley

Definition at line 14 of file Run.hh.

---

Member Enumeration Documentation

enum FilterLevel

Enum to specify the level of event format filtering to apply NOFILT = no filtering; DOCFILT = filter unphysical particles with status other than 1, 2, or 4; UNSTABLEFILT = filter as for DOCFILT, but also exclude any unstable particles with status = 2.

Enumerator:

NOFILT
DOCFILT
UNSTABLEFILT

Definition at line 21 of file Run.hh.

{ NOFILT=0, DOCFILT=1, UNSTABLEFILT=2 };

---

Constructor & Destructor Documentation

Run

(

Generator &

gen

)

Make a generator run with a particular gen.

Definition at line 8 of file Run.cc.

    : _gen(&gen), _filter(Run::DOCFILT)//, _ostr(0), _io(0)
  {
    //
  }

Run	(	Generator &	gen,
		const std::string &	evtfile = "-",
		int	precision = 16
	)

Make a generator run with a particular gen and I/O target.

---

Member Function Documentation

const HepMC::GenEvent& event

(

)

const [inline]

Get the current generated event.

Definition at line 41 of file Run.hh.

References Run::_evt.

                                       {
      return _evt;
    }

string eventSummary

(

)

const

Return an event summary string.

Definition at line 136 of file Run.cc.

References Run::_evt.

                                 {
    std::ostringstream ss;
    int Nfs = 0;
    for (HepMC::GenEvent::particle_const_iterator pi = _evt.particles_begin();
         pi != _evt.particles_end(); ++pi) {
      if ((*pi)->status() == 1) Nfs += 1;
    }
    ss << "HepMC::GenEvent { "
       << _evt.particles_size() << " particles "
       << "(" << Nfs << " in FS), "
       << _evt.vertices_size() << " vertices }";
    return ss.str();
  }

bool makeEvent

(

)

Generate an event and send it to the writer if it exists.

Definition at line 116 of file Run.cc.

References Run::_evt, Run::_filter, Run::_gen, Run::_io, AGILe::filterEvent(), and Generator::makeEvent().

                      {
    // Make and fill event
    _gen->makeEvent(_evt);

    // Filter unphysical bits of event (reduces storage/transport size, and ensures physicality)
    filterEvent(&_evt, _filter);

    // Do I/O streaming if required
    if (_io) {
      _io->write_event(&_evt);
      if (_io->rdstate() != 0) {
        return false;
      }
    }

    return true;
  }

void setFilter

(

FilterLevel

filt = DOCFILT

)

[inline]

Choose whether to filter out unphysical particles.

Definition at line 33 of file Run.hh.

References Run::_filter.

                                             {
      _filter = filt;
    }

---

Member Data Documentation

HepMC::GenEvent _evt [private]

Current HepMC event.

Definition at line 58 of file Run.hh.

Referenced by Run::event(), Run::eventSummary(), and Run::makeEvent().

FilterLevel _filter [private]

Flag to decide whether or not to strip unphysical particles out of events.

Definition at line 55 of file Run.hh.

Referenced by Run::makeEvent(), and Run::setFilter().

Generator* _gen [private]

Generator used in this run.

Definition at line 52 of file Run.hh.

Referenced by Run::makeEvent().

shared_ptr<HepMC::IO_GenEvent> _io [private]

HepMC I/O writer.

Definition at line 64 of file Run.hh.

Referenced by Run::makeEvent().

shared_ptr<std::ostream> _ostr [private]

Output stream for HepMC writer.

Definition at line 61 of file Run.hh.

---

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

• Run.hh
• Run.cc