IncomingBeams Class Reference

Beam/primary particle's kinematics. More...

#include <CepGen/Physics/IncomingBeams.h>

Inheritance diagram for IncomingBeams:

Collaboration diagram for IncomingBeams:

Public Member Functions
	IncomingBeams (const ParametersList &)
void	setParameters (const ParametersList &) override
	Set module parameters.
const ParametersList &	parameters () const override
	List containing all parameters handled.
mode::Kinematics	mode () const
	Type of kinematics to consider for the phase space.
const Beam &	positive () const
	Reference to the positive-z beam information.
Beam &	positive ()
	Reference to the positive-z beam information.
const Beam &	negative () const
	Reference to the negative-z beam information.
Beam &	negative ()
	Reference to the negative-z beam information.
const ParametersList &	structureFunctions () const
	Structure functions parameters.
void	setStructureFunctions (int, int)
	Set the integer-type of structure functions evaluator to build.
void	setSqrtS (double)
	Set the incoming beams centre of mass energy (in GeV)
double	s () const
	Incoming beams squared centre of mass energy (in GeV^2)
double	sqrtS () const
	Incoming beams centre of mass energy (in GeV)
bool	operator== (const SteeredObject &oth) const
	Equality operator.
bool	operator!= (const SteeredObject &oth) const
	Inequality operator.
void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()
static mode::Kinematics	modeFromBeams (const Beam &, const Beam &)
	Extract kinematics type from both beams.

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.

Detailed Description

Definition at line 27 of file IncomingBeams.h.

Constructor & Destructor Documentation

IncomingBeams()

IncomingBeams ( const ParametersList &  params )

explicit

Definition at line 34 of file IncomingBeams.cpp.

Member Function Documentation

description()

ParametersDescription description ( )

static

Definition at line 258 of file IncomingBeams.cpp.

mode()

mode::Kinematics mode

(

)

const

Definition at line 204 of file IncomingBeams.cpp.

modeFromBeams()

mode::Kinematics modeFromBeams ( const Beam &  pos, const Beam &  neg  )

static

Definition at line 210 of file IncomingBeams.cpp.

negative() [1/2]

Beam & negative

(

)

Definition at line 41 of file IncomingBeams.h.

negative() [2/2]

const Beam & negative

(

)

const

Definition at line 40 of file IncomingBeams.h.

operator!=()

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

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

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

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

const ParametersList & parameters ( ) const

overridevirtual

Reimplemented from Steerable.

Definition at line 240 of file IncomingBeams.cpp.

positive() [1/2]

Beam & positive

(

)

Definition at line 39 of file IncomingBeams.h.

positive() [2/2]

const Beam & positive

(

)

const

Definition at line 38 of file IncomingBeams.h.

s()

double s

(

)

const

Definition at line 193 of file IncomingBeams.cpp.

setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setParameters()

void setParameters ( const ParametersList &  params )

overridevirtual

Reimplemented from SteeredObject< IncomingBeams >.

Definition at line 38 of file IncomingBeams.cpp.

setSqrtS()

void setSqrtS

(

double

sqrts

)

Definition at line 182 of file IncomingBeams.cpp.

setStructureFunctions()

void setStructureFunctions	(	int	sf_model,
		int	sr_model
	)

Definition at line 223 of file IncomingBeams.cpp.

sqrtS()

double sqrtS

(

)

const

Definition at line 202 of file IncomingBeams.cpp.

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.

structureFunctions()

const ParametersList & structureFunctions

(

)

const

Definition at line 43 of file IncomingBeams.h.

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.