SIM_RandomTwister Class Reference

#include <SIM_RandomTwister.h>

Inheritance diagram for SIM_RandomTwister:

SIM_Random SIM_Data

List of all members.

Protected Member Functions

 SIM_RandomTwister (const SIM_DataFactory *factory)
virtual ~SIM_RandomTwister ()
virtual void initializeSubclass ()
virtual void makeEqualSubclass (const SIM_Data *source)
virtual void saveSubclass (ostream &os) const
virtual bool loadSubclass (UT_IStream &is)
virtual uint urandomSubclass ()
 Override this function to implement a new random number generator.
virtual void setSeedSubclass (uint seed)
 Override this function to initialize the random number generator.


Detailed Description

This class defines a bunch of useful tools for random number generation. It is designed to be attached as subdata to objects or solvers that need a stream of random numbers.
Examples:

SIM/SNOW_Solver.C.

Definition at line 25 of file SIM_RandomTwister.h.


Constructor & Destructor Documentation

SIM_RandomTwister::SIM_RandomTwister ( const SIM_DataFactory factory  )  [explicit, protected]

virtual SIM_RandomTwister::~SIM_RandomTwister (  )  [protected, virtual]


Member Function Documentation

virtual void SIM_RandomTwister::initializeSubclass (  )  [protected, virtual]

Override this method to set this data to its default empty state. Remember to call the base class implementation. The default implementation clears all subdata, and if the data is a subclass of SIM_OptionsUser, calls initializeFromParmDefaults().

Reimplemented from SIM_Data.

virtual bool SIM_RandomTwister::loadSubclass ( UT_IStream is  )  [protected, virtual]

Override this method to read in subclass-specific data. Remember to call the base class implementation.

Reimplemented from SIM_Data.

virtual void SIM_RandomTwister::makeEqualSubclass ( const SIM_Data source  )  [protected, virtual]

Override this method to set subclass data equal to the source data. The source parameter at this level is guaranteed to be non-null. Remember to call the base class implementation.

Reimplemented from SIM_Data.

virtual void SIM_RandomTwister::saveSubclass ( ostream &  os  )  const [protected, virtual]

Override this method to write out subclass-specific data. Remember to call the base class implementation.

Reimplemented from SIM_Data.

virtual void SIM_RandomTwister::setSeedSubclass ( uint  seed  )  [protected, virtual]

Override this function to initialize the random number generator.

Implements SIM_Random.

virtual uint SIM_RandomTwister::urandomSubclass (  )  [protected, virtual]

Override this function to implement a new random number generator.

Implements SIM_Random.


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

Generated on Mon Jan 28 00:48:53 2013 for HDK by  doxygen 1.5.9