In This Package:

IRndmGen Class Reference

Definition of a interface for a generic random number generators. More...

Inheritance diagram for IRndmGen:

[legend]Collaboration diagram for IRndmGen:[legend]List of all members.


Public Types
	SUCCESS = 1
	Normal successful completion.
	NO_INTERFACE
	Requested interface is not available.
	VERSMISMATCH
	Requested interface version is incompatible.
	LAST_ERROR
	Last error.
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
Public Member Functions
virtual StatusCode	initialize (const IRndmGen::Param &par)=0
	Initialize the generator.
virtual StatusCode	finalize ()=0
	Initialize the generator.
virtual const InterfaceID &	type () const =0
	Random number generator type.
virtual long	ID () const =0
	Random generator ID.
virtual const IRndmGen::Param *	parameters () const =0
	Access to random number generator parameters.
virtual double	shoot () const =0
	Single shot returning single random number according to specified distribution.
virtual StatusCode	shootArray (std::vector< double > &array, long howmany, long start=0) const =0
	Multiple shots returning vector with random number according to specified distribution.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)=0
	Query interfaces of Interface.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID.
Classes
class	Param

Definition of a interface for a generic random number generators.

Definition at line 37 of file IRndmGen.h.

enum IInterface::Status [inherited]

Return status.

Enumerator:

SUCCESS	Normal successful completion.
NO_INTERFACE	Requested interface is not available.
VERSMISMATCH	Requested interface version is incompatible.
LAST_ERROR	Last error.

Definition at line 113 of file IInterface.h.

00113                 {
00115     SUCCESS = 1,
00117     NO_INTERFACE,
00119     VERSMISMATCH,
00121     LAST_ERROR
00122   };

static const InterfaceID& IRndmGen::interfaceID ( ) [inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Definition at line 60 of file IRndmGen.h.

00060 { return IID_IRndmGen; }

virtual StatusCode IRndmGen::initialize ( const IRndmGen::Param & par ) [pure virtual]

Initialize the generator.

virtual StatusCode IRndmGen::finalize ( ) [pure virtual]

Initialize the generator.

virtual const InterfaceID& IRndmGen::type ( ) const [pure virtual]

Random number generator type.

virtual long IRndmGen::ID ( ) const [pure virtual]

Random generator ID.

virtual const IRndmGen::Param* IRndmGen::parameters ( ) const [pure virtual]

Access to random number generator parameters.

virtual double IRndmGen::shoot ( ) const [pure virtual]

Single shot returning single random number according to specified distribution.

virtual StatusCode IRndmGen::shootArray	(	std::vector< double > &	array,
		long	howmany,
		long	start = `0`
	)			const `[pure 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
	Statuscode	indicating success or failure