Wiener Class Reference

Properties for all Wiener processes. More...

Inheritance diagram for Wiener:

Public Member Functions
virtual void	init ()
	Initialise time-dependent values.
virtual void	prepareNextState ()
	Calculate next value (preparing next step). More...
virtual string	getParameter (const string &) const
	Get parameter. More...
virtual void	setParameter (const string &, const string &)
	Set parameter. More...
Public Member Functions inherited from RandN
	RandN ()
	Construct.
	~RandN ()
	Destruct.
double	dRandN ()
	Retrieve random variable. More...
double	dRandE ()
	Retrieve random variable. More...
Public Member Functions inherited from StochasticVariable
	StochasticVariable (class Time *time, const string &name="", const string &type="Stochastic Variable")
	Create.
double	operator() ()
	Returns the value at the current time step. More...
double	d ()
	Returns the increment at the current time step. More...
Public Member Functions inherited from StochasticProcess
	StochasticProcess (class Time *time, const string &name="", const string &type="Stochastic")
	Create.
virtual	~StochasticProcess ()
	Destroy.
virtual void	proceedToNextState ()
	Proceed one time step. More...
bool	isNextStatePrepared ()
	Whether.
virtual double	getIncrement ()
	Returns the increment. More...
virtual double	getCurrentValue ()
	Returns the value of the process. More...
virtual double	getNextValue ()
	Returns the next value of the process. More...
virtual void	setNextValue (double d)
	Set the next value of the process. More...
virtual void	setCurrentValue (double d)
	Set the current value of the process. More...
void	setDescription (string s)
	Set stochastic description.
string	getDescription ()
	Get the name. More...
Public Member Functions inherited from Parametric
string	getType () const
	Type of object.
string	getName () const
	Name of object.
void	setName (const string &name)
	Name of object.
string	getConfiguration () const
	Returns the configuration of the object. More...
string	getAllParameters () const
	String with all parameter settings.
void	addParameter (const string &name)
	Add a parameter. More...
void	rmParameter (const string &name)
	Remove a parameter. More...
Public Member Functions inherited from TimeDependent
	TimeDependent (class Time *time)
	Construct. More...
virtual class Time *	getTime () const
	Return pointer to the time object.
Public Member Functions inherited from Physical
	Physical ()
	Construct.
	Physical (const Physical &)
	Copy.
	Physical (string name)
	Construct.
	Physical (string name, string unitPrefix, string unitSymbol)
	Construct.
	Physical (string name, Unit unit)
	Construct.
virtual string	getPhysicalDescription ()
	Returns the physical description. More...
virtual string	getUnitName ()
	Returns the unit name.
virtual string	getUnitSymbol ()
	Returns the unit name.
virtual void	setPhysicalDescription (string name)
	Set the name. Same as setDescription(). More...
virtual void	setUnit (Unit u)
	Set the unit.
virtual void	setUnitPrefix (int n)
	Set unit prefix. More...
virtual Unit	getUnit () const
	Retrieve the unit.

Additional Inherited Members
Protected Member Functions inherited from Parametric
	Parametric (const string &name, const string &type)
	Create object of type and name.
virtual	~Parametric ()
	Destroy object.
Protected Attributes inherited from StochasticProcess
double	stochCurrentValue
	the current value
double	stochNextValue
	the next value (direct future)
bool	stochNextStateIsPrepared
	whether prepareNextState() was successful
string	stochDescription
	the name of the quantity

Detailed Description

Properties for all Wiener processes.

Standard Functions of Wiener processes. This class implements a Wiener processes. The process can have a time-proportional mean and variance .

Member Function Documentation

virtual string Wiener::getParameter ( const string &  name ) const

virtual

Get parameter.

In a derived class, override this to handle every parameter you implement. If a parameter is described using multiple strings separated by space, this indicates a parameter of a parameter.

Reimplemented from Parametric.

Reimplemented in WienerCpp.

virtual void Wiener::prepareNextState ( )

virtual

Calculate next value (preparing next step).

This method should be overridden to implement the calculation of the next value, using information wich is available at the current time. The method must set the protected member stochNextStateIsPrepared to true if successful.

Reimplemented from StochasticProcess.

virtual void Wiener::setParameter ( const string &  name, const string &  value  )

virtual

Set parameter.

Sets the value of a parameter using strings. If a parameter is described using multiple strings separated by space, this indicates a parameter of a parameter (not implemented yet).

Reimplemented from Parametric.

Reimplemented in WienerCpp.