PolarisationState Class Reference

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

Inheritance diagram for PolarisationState:

Collaboration diagram for PolarisationState:

Public Types
enum class	Mode {   invalid = -1 , full = 0 , LL = 1 , LT = 2 ,   TL = 3 , TT = 4 }
using	Polarisation = std::vector<int>
	list of polarisation states
using	Polarisations = std::pair<Polarisation, Polarisation>
	polarisation for a pair of particles

Public Member Functions
	PolarisationState (const ParametersList &)
const Mode &	mode () const
	polarisation mode
const Polarisations &	polarisations () const
	list of polarisation states
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	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 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 Mode &)

Detailed Description

Definition at line 25 of file PolarisationState.h.

Member Typedef Documentation

Polarisation

using Polarisation = std::vector<int>

Definition at line 34 of file PolarisationState.h.

Polarisations

using Polarisations = std::pair<Polarisation, Polarisation>

Definition at line 35 of file PolarisationState.h.

Member Enumeration Documentation

Mode

enum class Mode

strong

Enumerator
invalid
full
LL
LT
TL
TT

Definition at line 31 of file PolarisationState.h.

Constructor & Destructor Documentation

PolarisationState()

PolarisationState ( const ParametersList & )

explicit

Member Function Documentation

description()

static ParametersDescription description ( )

static

mode()

const Mode & mode

(

)

const

Definition at line 37 of file PolarisationState.h.

operator!=()

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

inherited

Definition at line 50 of file SteeredObject.h.

operator==()

bool operator== ( const SteeredObject< PolarisationState > & 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.

polarisations()

const Polarisations & polarisations

(

)

const

Definition at line 38 of file PolarisationState.h.

setDescribedParameters()

void setDescribedParameters ( const ParametersList & params_orig )

inherited

Definition at line 72 of file SteeredObject.h.

setParameters()

void setParameters ( const ParametersList & params )

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 61 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

Friends And Related Symbol Documentation

operator<<

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

friend

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.