thepeg is hosted by Hepforge, IPPP Durham
ThePEG 2.3.0
ThePEG::SelectorBase Class Reference

Classes derived from the SelectorBase class are used to extract particles from an Event with Event::select() method. More...

#include <SelectorBase.h>

Inheritance diagram for ThePEG::SelectorBase:

Public Member Functions

virtual ~SelectorBase ()
 Virtual destructor.
 
virtual bool check (const Particle &p) const
 Return true if the particle should be extracted.
 
virtual bool finalState () const
 Return true if final state particles are to be considered.
 
virtual bool intermediate () const
 Return true if intermediate particles should be considered.
 
virtual bool allSteps () const
 Return true if all steps should be considered.
 
virtual bool allCollisions () const
 Return ture if all collisions should be considered.
 

Static Public Member Functions

static bool Check (const Particle &)
 Static method corresponding to the virtual check() method.
 
static bool Intermediate ()
 Static method corresponding to the virtual intermediate() method.
 
static bool FinalState ()
 Static method corresponding to the virtual finalState() method.
 
static bool AllSteps ()
 Static method corresponding to the virtual allSteps() method.
 
static bool AllCollisions ()
 Static method corresponding to the virtual allCollisions() method.
 

Detailed Description

Classes derived from the SelectorBase class are used to extract particles from an Event with Event::select() method.

There are five different kinds of checks done by a selector object in the Event::select method. If the allCollisions() method returns false, only particles which belongs to the primary collision in an event will be considered for extraction. Furthermore if the allSteps() method returns false, only particles present in the final step of each collision will be considered. If finalState() returns false, final state particles will not be considered and if intermediate() returns false, intermediate particles will not be considered. Finally among all considered particles, only the ones for which the check(const Particle &) returns true will be extracted.

See also
StandardSelectors
Event
Collision
Step
Particle

Definition at line 45 of file SelectorBase.h.

Constructor & Destructor Documentation

◆ ~SelectorBase()

virtual ThePEG::SelectorBase::~SelectorBase ( )
inlinevirtual

Virtual destructor.

Definition at line 52 of file SelectorBase.h.

Member Function Documentation

◆ AllCollisions()

static bool ThePEG::SelectorBase::AllCollisions ( )
inlinestatic

Static method corresponding to the virtual allCollisions() method.

Definition at line 77 of file SelectorBase.h.

Referenced by allCollisions().

◆ allCollisions()

virtual bool ThePEG::SelectorBase::allCollisions ( ) const
inlinevirtual

Return ture if all collisions should be considered.

Otherwise only the primary collision will be considered.

Reimplemented in ThePEG::ParticleSelector< T >, ThePEG::SelectIfNot, ThePEG::SelectIfBoth, and ThePEG::SelectIfEither.

Definition at line 104 of file SelectorBase.h.

References AllCollisions().

Referenced by ThePEG::SelectIfNot::allCollisions(), ThePEG::SelectIfBoth::allCollisions(), and ThePEG::SelectIfEither::allCollisions().

◆ AllSteps()

static bool ThePEG::SelectorBase::AllSteps ( )
inlinestatic

Static method corresponding to the virtual allSteps() method.

Definition at line 72 of file SelectorBase.h.

Referenced by allSteps().

◆ allSteps()

virtual bool ThePEG::SelectorBase::allSteps ( ) const
inlinevirtual

Return true if all steps should be considered.

Otherwise only the last step in each collision is considered.

Reimplemented in ThePEG::ParticleSelector< T >, ThePEG::SelectIfNot, ThePEG::SelectIfBoth, and ThePEG::SelectIfEither.

Definition at line 98 of file SelectorBase.h.

References AllSteps().

Referenced by ThePEG::SelectIfNot::allSteps(), ThePEG::SelectIfBoth::allSteps(), and ThePEG::SelectIfEither::allSteps().

◆ Check()

static bool ThePEG::SelectorBase::Check ( const Particle )
inlinestatic

Static method corresponding to the virtual check() method.

Definition at line 57 of file SelectorBase.h.

Referenced by check().

◆ check()

virtual bool ThePEG::SelectorBase::check ( const Particle p) const
inlinevirtual

Return true if the particle should be extracted.

Reimplemented in ThePEG::ParticleSelector< T >, ThePEG::SelectIfNot, ThePEG::SelectIfBoth, and ThePEG::SelectIfEither.

Definition at line 82 of file SelectorBase.h.

References Check().

Referenced by ThePEG::SelectIfNot::check(), ThePEG::SelectIfBoth::check(), and ThePEG::SelectIfEither::check().

◆ FinalState()

static bool ThePEG::SelectorBase::FinalState ( )
inlinestatic

Static method corresponding to the virtual finalState() method.

Definition at line 67 of file SelectorBase.h.

Referenced by finalState().

◆ finalState()

virtual bool ThePEG::SelectorBase::finalState ( ) const
inlinevirtual

Return true if final state particles are to be considered.

Reimplemented in ThePEG::ParticleSelector< T >, ThePEG::SelectIfNot, ThePEG::SelectIfBoth, and ThePEG::SelectIfEither.

Definition at line 87 of file SelectorBase.h.

References FinalState().

Referenced by ThePEG::SelectIfNot::finalState(), ThePEG::SelectIfBoth::finalState(), and ThePEG::SelectIfEither::finalState().

◆ Intermediate()

static bool ThePEG::SelectorBase::Intermediate ( )
inlinestatic

Static method corresponding to the virtual intermediate() method.

Definition at line 62 of file SelectorBase.h.

Referenced by intermediate().

◆ intermediate()

virtual bool ThePEG::SelectorBase::intermediate ( ) const
inlinevirtual

Return true if intermediate particles should be considered.

Reimplemented in ThePEG::ParticleSelector< T >, ThePEG::SelectIfNot, ThePEG::SelectIfBoth, and ThePEG::SelectIfEither.

Definition at line 92 of file SelectorBase.h.

References Intermediate().

Referenced by ThePEG::SelectIfNot::intermediate(), ThePEG::SelectIfBoth::intermediate(), and ThePEG::SelectIfEither::intermediate().


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