Kinematics Class Reference

List of kinematic constraints to apply on the process phase space. More...

#include <CepGen/Physics/Kinematics.h>

Inheritance diagram for Kinematics:

Collaboration diagram for Kinematics:

Public Member Functions
	Kinematics (const ParametersList &)
void	setParameters (const ParametersList &) override
	Set module parameters.
const ParametersList &	parameters () const override
	List containing all parameters handled.
IncomingBeams &	incomingBeams ()
	Beam/primary particle kinematics.
const IncomingBeams &	incomingBeams () const
	Beam/primary particle kinematics.
const pdgids_t &	minimumFinalState () const
	Minimum central particles.
CutsList &	cuts ()
	Phase space cuts.
const CutsList &	cuts () const
	Phase space cuts.
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 ()

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 Kinematics.h.

Constructor & Destructor Documentation

Kinematics()

Kinematics ( const ParametersList &  params )

explicit

Definition at line 24 of file Kinematics.cpp.

Member Function Documentation

cuts() [1/2]

CutsList & cuts

(

)

Definition at line 41 of file Kinematics.h.

cuts() [2/2]

const CutsList & cuts

(

)

const

Definition at line 42 of file Kinematics.h.

description()

ParametersDescription description ( )

static

Definition at line 51 of file Kinematics.cpp.

incomingBeams() [1/2]

IncomingBeams & incomingBeams

(

)

Definition at line 36 of file Kinematics.h.

incomingBeams() [2/2]

const IncomingBeams & incomingBeams

(

)

const

Definition at line 37 of file Kinematics.h.

minimumFinalState()

const pdgids_t & minimumFinalState

(

)

const

Definition at line 39 of file Kinematics.h.

operator!=()

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

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

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

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

const ParametersList & parameters ( ) const

overridevirtual

Reimplemented from Steerable.

Definition at line 41 of file Kinematics.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< Kinematics >.

Definition at line 26 of file Kinematics.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.

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.