Beam Class Reference

Incoming beams characteristics. More...

#include <CepGen/Physics/Beam.h>

Inheritance diagram for Beam:

Collaboration diagram for Beam:

Public Member Functions
	Beam (const ParametersList &)
	Default constructor.
void	initialise ()
	Initialise the fluxes evaluator object.
bool	elastic () const
	Does the beam remain on-shell after parton emission? Specify if the beam remains on-shell after parton emission.
Beam &	setElastic (bool el)
spdgid_t	integerPdgId () const
	Beam particle PDG id Set the beam particle PDG id.
Beam &	setIntegerPdgId (spdgid_t pdg)
const Momentum &	momentum () const
	Beam particle 4-momentum Set the beam particle 4-momentum.
Beam &	setMomentum (const Momentum &mom)
const ParametersList &	formFactors () const
	Form factors parameters.
const ParametersList &	partonFluxParameters () const
	Parton flux modelling.
bool	operator== (const SteeredObject &oth) const
	Equality operator.
bool	operator!= (const SteeredObject &oth) const
	Inequality operator.
const ParametersList &	parameters () const override
	Module user-defined parameters.
virtual void	setParameters (const ParametersList &params) override
	Set module parameters.
void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()

Protected Member Functions
template<typename T >
T	steer (const std::string &key) const
	Retrieve a parameters as previously steered.
template<typename T , typename U >
U	steerAs (const std::string &key) const
	Retrieve a recasted parameters as previously steered.
std::string	steerName () const
	Retrieve module name from parameters.
std::string	steerPath (const std::string &key) const
	Retrieve a path from common search paths.

Protected Attributes
ParametersList	params_
	Module parameters.

Friends
std::ostream &	operator<< (std::ostream &, const Beam &)
	Human-readable description of beam system.

Detailed Description

Definition at line 30 of file Beam.h.

Constructor & Destructor Documentation

Beam()

Beam ( const ParametersList &  params )

explicit

Definition at line 28 of file Beam.cpp.

Member Function Documentation

description()

ParametersDescription description ( )

static

Definition at line 35 of file Beam.cpp.

elastic()

bool elastic

(

)

const

Definition at line 40 of file Beam.h.

formFactors()

const ParametersList & formFactors

(

)

const

Definition at line 61 of file Beam.h.

initialise()

void initialise

(

)

integerPdgId()

spdgid_t integerPdgId

(

)

const

Definition at line 47 of file Beam.h.

momentum()

const Momentum & momentum

(

)

const

Definition at line 54 of file Beam.h.

operator!=()

bool operator!= ( const SteeredObject< Beam > &  oth ) const

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

bool operator== ( const SteeredObject< Beam > &  oth ) const

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

partonFluxParameters()

const ParametersList & partonFluxParameters

(

)

const

Definition at line 62 of file Beam.h.

setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setElastic()

Beam & setElastic

(

bool

el

)

Definition at line 42 of file Beam.h.

setIntegerPdgId()

Beam & setIntegerPdgId

(

spdgid_t

pdg

)

Definition at line 49 of file Beam.h.

setMomentum()

Beam & setMomentum

(

const Momentum &

mom

)

Definition at line 56 of file Beam.h.

setParameters()

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 62 of file SteeredObject.h.

steer()

template<typename T >

T steer ( const std::string &  key ) const

protectedinherited

Definition at line 39 of file Steerable.h.

steerAs()

template<typename T , typename U >

U steerAs ( const std::string &  key ) const

protectedinherited

Definition at line 44 of file Steerable.h.

steerName()

std::string steerName ( ) const

protectedinherited

Definition at line 48 of file Steerable.h.

steerPath()

std::string steerPath ( const std::string &  key ) const

protectedinherited

Definition at line 30 of file Steerable.cpp.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const Beam &  beam  )

friend

Definition at line 42 of file Beam.cpp.

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.