PolarisationState Class Reference

#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 }
typedef std::vector< int >	Polarisation
typedef std::pair< Polarisation, Polarisation >	Polarisations

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

Detailed Description

Definition at line 25 of file PolarisationState.h.

Member Typedef Documentation

Polarisation

typedef std::vector<int> Polarisation

Definition at line 33 of file PolarisationState.h.

Polarisations

typedef std::pair<Polarisation, Polarisation> Polarisations

Definition at line 34 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 &  params )

explicit

Definition at line 23 of file PolarisationState.cpp.

Member Function Documentation

description()

ParametersDescription description ( )

static

Definition at line 47 of file PolarisationState.cpp.

mode()

const Mode & mode

(

)

const

Definition at line 36 of file PolarisationState.h.

operator!=()

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

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

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

polarisations()

const Polarisations & polarisations

(

)

const

Definition at line 37 of file PolarisationState.h.

setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.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 Mode &  mode  )

friend

Definition at line 55 of file PolarisationState.cpp.

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.