Beam Class Reference

#include <Beam.hh>

Inheritance diagram for Beam:

[legend]Collaboration diagram for Beam:

[legend]List of all members.

---

Detailed Description

Project out the incoming beams.

Definition at line 13 of file Beam.hh.

Public Member Functions
	Beam ()
	The default constructor.
	~Beam ()
	The default destructor.
string	getName () const
	Return the name of the projection.
const ParticlePair &	getBeams () const
	The pair of beam particles in the current collision in GenEvent.
bool	before (const Projection &p) const
virtual const Cuts	getCuts () const
virtual const set< BeamPair >	getBeamPairs () const
set< Projection * >	getProjections () const
	Get the contained projections, including recursion.
Protected Member Functions
virtual void	project (const Event &e)
	Project on to the Event.
virtual int	compare (const Projection &p) const
	Compare with other projections.
Projection &	addProjection (Projection &proj)
	Add a projection dependency to the projection list.
Projection &	addBeamPair (const ParticleName &beam1, const ParticleName &beam2)
	Add a colliding beam pair.
Projection &	addCut (const string &quantity, const Comparison &comparison, const double value)
	Add a cut.
Log &	getLog ()
	Get a Log object based on the getName() property of the calling projection object.
Protected Attributes
Cuts	_cuts
	Parameter constraints.
set< BeamPair >	_beamPairs
	Beam-type constraint.
set< Projection * >	_projections
	Collection of pointers to projections, for automatically combining constraints.
Friends
class	Event
	Event is a friend.
class	Cmp<Projection>
	The Cmp specialization for Projection is a friend.

---

Constructor & Destructor Documentation

Beam (   )  [inline]

The default constructor. Definition at line 18 of file Beam.hh.

~Beam (   )  [inline]

The default destructor. Definition at line 21 of file Beam.hh.

---

Member Function Documentation

Projection& addBeamPair (  const ParticleName &  beam1, const ParticleName &  beam2 )  [inline, protected, inherited]

Add a colliding beam pair. Definition at line 145 of file Projection.hh. References Rivet::BeamPair.

Projection& addCut (  const string &  quantity, const Comparison &  comparison, const double  value )  [inline, protected, inherited]

Add a cut. Definition at line 151 of file Projection.hh.

Projection& addProjection (  Projection &  proj  )  [inline, protected, inherited]

Add a projection dependency to the projection list. Definition at line 139 of file Projection.hh.

bool before (  const Projection &  p  )  const [inline, inherited]

Determine whether this object should be ordered before the object p given as argument. If p is of a different class than this, the before() function of the corresponding type_info objects is used. Otherwise, if the objects are of the same class, the virtual compare(const Projection &) will be returned. Definition at line 88 of file Projection.hh. Referenced by less< const Rivet::Projection * >::operator()().

virtual int compare (  const Projection &  p  )  const [inline, protected, virtual]

Compare with other projections. Implements Projection. Definition at line 39 of file Beam.hh.

virtual const set<BeamPair> getBeamPairs (   )  const [inline, virtual, inherited]

Return the BeamConstraints for this projection. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work. Definition at line 114 of file Projection.hh. References Cuts::end(), and Rivet::intersection().

const ParticlePair& getBeams (   )  const [inline]

The pair of beam particles in the current collision in GenEvent. Definition at line 29 of file Beam.hh. References Rivet::ParticlePair.

virtual const Cuts getCuts (   )  const [inline, virtual, inherited]

Return the Cuts objects for this projection. Derived classes should ensure that all contained projections are registered in the _projections set for the cut chaining to work. Definition at line 102 of file Projection.hh. References Cuts::addCuts().

Log & getLog (   )  [protected, inherited]

Get a Log object based on the getName() property of the calling projection object. Definition at line 7 of file Projection.cc. References Log::getLog(), and Projection::getName(). Referenced by VetoedFinalState::project(), TrackJet::project(), TotalVisibleMomentum::project(), Sphericity::project(), Multiplicity::project(), ChargedLeptons::project(), ChargedFinalState::project(), and Beam::project().

string getName (   )  const [inline, virtual]

Return the name of the projection. Reimplemented from Projection. Definition at line 24 of file Beam.hh.

set<Projection*> getProjections (   )  const [inline, inherited]

Get the contained projections, including recursion. Definition at line 128 of file Projection.hh. References Cuts::end().

void project (  const Event &  e  )  [protected, virtual]

Project on to the Event. Todo: This is not a robust assumption! HepMC should support directly accessing the beams. Implements Projection. Definition at line 10 of file Beam.cc. References Event::genEvent(), and Projection::getLog().

---

Friends And Related Function Documentation

friend class Cmp<Projection> [friend, inherited]

The Cmp specialization for Projection is a friend. Definition at line 31 of file Projection.hh.

friend class Event [friend, inherited]

Event is a friend. Definition at line 28 of file Projection.hh.

---

Member Data Documentation

set<BeamPair> _beamPairs [protected, inherited]

Beam-type constraint. Definition at line 164 of file Projection.hh.

Cuts _cuts [protected, inherited]

Parameter constraints. Definition at line 161 of file Projection.hh.

set<Projection*> _projections [protected, inherited]

Collection of pointers to projections, for automatically combining constraints. Definition at line 167 of file Projection.hh.

---

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

• Beam.hh
• Beam.cc