| # Gaudi Framework, version v23r0 |

Home |  | Generated: Mon Jan 30 2012

Public Member Functions | Protected Member Functions | Protected Attributes

# RndmGen Class Reference

Random Generator definition. More...

`#include <RndmGen.h>`

Inheritance diagram for RndmGen:
[legend]
Collaboration diagram for RndmGen:
[legend]

List of all members.

## Public Member Functions
virtual StatusCode | initialize (const IRndmGen::Param &par)
| IRndmGen implementation.
virtual StatusCode | finalize ()
| Initialize the generator.
virtual const InterfaceID & | type () const
| Random number generator type.
virtual long | ID () const
| Random number generator ID.
virtual const IRndmGen::Param * | parameters () const
| Access to random number generator parameters.
virtual double | shoot () const
| Single shot returning single random number according to specified distribution.
virtual StatusCode | shootArray (std::vector< double > &array, long howmany, long start) const
| Multiple shots returning vector with random number according to specified distribution.
## Protected Member Functions
| RndmGen (IInterface *engine)
| Standard Constructor.
virtual | ~RndmGen ()
| Standard Destructor.
## Protected Attributes
IRndmGen::Param * | m_params
| Generation parameters.
IRndmEngine * | m_engine
| Hosting service: Access must always be possible.

## Detailed Description

Random Generator definition.

Description: Definition of a interface for a generic random number generators.

Dependencies:

- Generic Service interface: Gaudi/Interfaces/IInterface.h

History :

        +---------+----------------------------------------------+--------+
        |    Date |                 Comment                      | Who    |
        +---------+----------------------------------------------+--------+
        | 21/11/99| Initial version.                             | MF     |
        +---------+----------------------------------------------+--------+

Author: M.Frank Version: 1.0

Definition at line 39 of file RndmGen.h.

## Constructor & Destructor Documentation

RndmGen::RndmGen | ( | IInterface * | engine ) | `[protected]`

Standard Constructor.

Definition at line 22 of file RndmGen.cpp.

                                       : m_params(0), m_engine(0)   {
      if ( 0 != engine )  {
        engine->queryInterface(IRndmEngine::interfaceID(), pp_cast<void>(&m_engine)).ignore();
      }
    }

RndmGen::~RndmGen | ( | ) | `[protected, virtual]`

Standard Destructor.

Definition at line 29 of file RndmGen.cpp.

                        {
      if ( m_engine ) m_engine->release();
      m_engine = 0;
      if ( m_params ) delete m_params;
      m_params = 0;
    }

## Member Function Documentation

StatusCode RndmGen::finalize | ( | ) | `[virtual]`

Initialize the generator.

Initialize the RndmGen.

Implements IRndmGen.

Reimplemented in HepRndm::Generator< Rndm::DefinedPdf >.

Definition at line 43 of file RndmGen.cpp.

                                   {
      return StatusCode::SUCCESS;
    }

virtual long RndmGen::ID | ( | ) | const`[inline, virtual]`

Random number generator ID.

Implements IRndmGen.

Definition at line 64 of file RndmGen.h.

                                 {
        return long(this);
      }

StatusCode RndmGen::initialize | ( | const IRndmGen::Param & | par ) | `[virtual]`

IRndmGen implementation.

Initialize the generator.

Initialize the generator

Implements IRndmGen.

Reimplemented in HepRndm::Generator< TYPE >, and HepRndm::Generator< Rndm::DefinedPdf >.

Definition at line 37 of file RndmGen.cpp.

                                                             {
      m_params = par.clone();
      return (0==m_engine) ? StatusCode::FAILURE : StatusCode::SUCCESS;
    }

virtual const IRndmGen::Param* RndmGen::parameters | ( | ) | const`[inline, virtual]`

Access to random number generator parameters.

Implements IRndmGen.

Definition at line 68 of file RndmGen.h.

                                                         {
        return m_params;
      }

double RndmGen::shoot | ( | ) | const`[virtual]`

Single shot returning single random number according to specified distribution.

Implements IRndmGen.

Reimplemented in HepRndm::Generator< TYPE >, HepRndm::Generator< Rndm::DefinedPdf >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, HepRndm::Generator< TYPE >, and HepRndm::Generator< TYPE >.

Definition at line 48 of file RndmGen.cpp.

                                  {
      return DBL_MAX;
    }

StatusCode RndmGen::shootArray | ( | std::vector< double > & | array,
|  | long | howmany,
|  | long | start
| ) |  | const`[virtual]`

Multiple shots returning vector with random number according to specified distribution.

Parameters:

  array | Array containing random numbers
  howmany | fill 'howmany' random numbers into array
  start | ... starting at position start

Implements IRndmGen.

Definition at line 53 of file RndmGen.cpp.

                                                                                            {
      if ( 0 != m_engine )    {
        long cnt = start;
        array.resize(start+howmany);
        for ( long i = start, num = start+howmany; i < num; i++ )     {
          array[cnt++] = shoot();
        }
        return StatusCode::SUCCESS;
      }
      return StatusCode::FAILURE;
    }

virtual const InterfaceID& RndmGen::type | ( | ) | const`[inline, virtual]`

Random number generator type.

Implements IRndmGen.

Definition at line 60 of file RndmGen.h.

                                                 {
        return (m_params != 0) ? m_params->type() : IID_IRndmFlat;
      }

## Member Data Documentation

IRndmEngine* RndmGen::m_engine`[protected]`

Hosting service: Access must always be possible.

Definition at line 45 of file RndmGen.h.

IRndmGen::Param* RndmGen::m_params`[protected]`

Generation parameters.

Definition at line 43 of file RndmGen.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiSvc/src/RndmGenSvc/RndmGen.h
- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiSvc/src/RndmGenSvc/RndmGen.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines