Gaudi Framework, version v21r9

Home   Generated: 3 May 2010

Rndm::BreitWignerCutOff Class Reference

Parameters for the BreitWigner distributed random number generation with cut off;. More...

#include <RndmGenerators.h>

Inheritance diagram for Rndm::BreitWignerCutOff:

Inheritance graph
[legend]
Collaboration diagram for Rndm::BreitWignerCutOff:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BreitWignerCutOff (double m, double g, double c)
 Standard Constructor.
virtual ~BreitWignerCutOff ()
 Standard Destructor.
double mean () const
 Access mean value of the distribution.
double gamma () const
 Access width of the distribution.
double cutOff () const
 Access width of the distribution.
virtual IRndmGen::Paramclone () const
 Clone parameters.

Static Public Member Functions

static const InterfaceIDtypeID ()
 Identifier for factory.

Protected Attributes

double m_mean
 Mean, Gamma and cut off parameter of the Breit-Wigner distribution.
double m_gamma
double m_cut

Friends

class Generator< BreitWignerCutOff >


Detailed Description

Parameters for the BreitWigner distributed random number generation with cut off;.

Definition at line 141 of file RndmGenerators.h.


Constructor & Destructor Documentation

Rndm::BreitWignerCutOff::BreitWignerCutOff ( double  m,
double  g,
double  c 
) [inline]

Standard Constructor.

Definition at line 148 of file RndmGenerators.h.

00149     : IRndmGen::Param(IID_IRndmBreitWignerCutOff),
00150       m_mean(m),
00151       m_gamma(g),
00152       m_cut(c) {  }

virtual Rndm::BreitWignerCutOff::~BreitWignerCutOff (  )  [inline, virtual]

Standard Destructor.

Definition at line 154 of file RndmGenerators.h.

00154 { }


Member Function Documentation

double Rndm::BreitWignerCutOff::mean (  )  const [inline]

Access mean value of the distribution.

Definition at line 156 of file RndmGenerators.h.

00156 { return m_mean; }

double Rndm::BreitWignerCutOff::gamma (  )  const [inline]

Access width of the distribution.

Definition at line 158 of file RndmGenerators.h.

00158 { return m_gamma; }

double Rndm::BreitWignerCutOff::cutOff (  )  const [inline]

Access width of the distribution.

Definition at line 160 of file RndmGenerators.h.

00160 { return m_cut; }

static const InterfaceID& Rndm::BreitWignerCutOff::typeID (  )  [inline, static]

Identifier for factory.

Definition at line 162 of file RndmGenerators.h.

00162 { return IID_IRndmBreitWignerCutOff;}

virtual IRndmGen::Param* Rndm::BreitWignerCutOff::clone (  )  const [inline, virtual]

Clone parameters.

Implements IRndmGen::Param.

Definition at line 164 of file RndmGenerators.h.

00164                                          {
00165       return new BreitWignerCutOff(m_mean, m_gamma, m_cut);
00166     }


Friends And Related Function Documentation

friend class Generator< BreitWignerCutOff > [friend]

Definition at line 142 of file RndmGenerators.h.


Member Data Documentation

double Rndm::BreitWignerCutOff::m_mean [protected]

Mean, Gamma and cut off parameter of the Breit-Wigner distribution.

Definition at line 145 of file RndmGenerators.h.

Definition at line 145 of file RndmGenerators.h.

double Rndm::BreitWignerCutOff::m_cut [protected]

Definition at line 145 of file RndmGenerators.h.


The documentation for this class was generated from the following file:

Generated at Mon May 3 12:29:42 2010 for Gaudi Framework, version v21r9 by Doxygen version 1.5.6 written by Dimitri van Heesch, © 1997-2004