CutsList Struct Reference

A collection of cuts to apply on the physical phase space. More...

#include <include/CepGen/Physics/CutsList.h>

Inheritance diagram for CutsList:

Collaboration diagram for CutsList:

Public Member Functions
	CutsList (const ParametersList &)
void	setParameters (const ParametersList &) override
	Set module parameters.
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.
void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()

Public Attributes
cuts::Initial	initial
	Cuts on the initial particles kinematics.
cuts::Central	central
	Cuts on the central system produced.
PerIdCuts	central_particles
	Cuts on the central individual particles.
cuts::Remnants	remnants
	Cuts on the beam remnants system.

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 recast 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 CutsList &)

Detailed Description

Definition at line 28 of file CutsList.h.

Constructor & Destructor Documentation

CutsList()

CutsList ( const ParametersList & )

explicit

Member Function Documentation

description()

static ParametersDescription description ( )

static

operator!=()

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

inherited

Definition at line 50 of file SteeredObject.h.

operator==()

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

inherited

Definition at line 48 of file SteeredObject.h.

parameters()

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 53 of file SteeredObject.h.

setDescribedParameters()

void setDescribedParameters ( const ParametersList & params_orig )

inherited

Definition at line 72 of file SteeredObject.h.

setParameters()

void setParameters ( const ParametersList & )

overridevirtual

Reimplemented from Steerable.

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

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & , const CutsList &  )

friend

Member Data Documentation

central

cuts::Central central

Definition at line 38 of file CutsList.h.

central_particles

PerIdCuts central_particles

Definition at line 39 of file CutsList.h.

initial

cuts::Initial initial

Definition at line 37 of file CutsList.h.

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.

remnants

cuts::Remnants remnants

Definition at line 40 of file CutsList.h.