WienerNoise Class Reference
A Wiener process (white) noise source. More...
Inheritance diagram for WienerNoise:
Protected Member Functions | |
| WienerNoise (class NoiseSource *parent, int index, const string &name="", const string &type="Correlated Wiener Process") | |
| Construct. More... | |
| WienerNoise (const WienerNoise &) | |
| Construct. More... | |
| virtual void | setNext (double indicator) |
| Set the next values. More... | |
 Protected Member Functions inherited from Noise | |
| Noise (class NoiseSource *parent, int index, const string &name="", const string &type="Correlated Noise") | |
| Construct. More... | |
| Noise (const Noise &) | |
| Construct. More... | |
| Protected Member Functions inherited from Parametric | |
| Parametric (const string &name, const string &type) | |
| Create object of type and name. | |
| virtual | ~Parametric () |
| Destroy object. | |
Friends | |
| class | NoiseSource |
Additional Inherited Members | |
| Public Member Functions inherited from Noise | |
| virtual void | proceedToNextState () |
| Make next value current value. | |
| virtual void | prepareNextState () |
| Compute next value. | |
| virtual Noise & | setWeight (double w) |
| Set the weight. | |
| double | getWeight () |
| Get the weight. | |
| virtual Noise & | setRate (double r) |
| Set the rate. | |
| double | getRate () |
| Get the rate. | |
| virtual Noise & | setMean (double m) |
| Set the mean. | |
| double | getMean () |
| Get the mean. | |
| virtual Noise & | setStdDev (double s) |
| Set the standard deviation coefficient. | |
| double | getStdDev () |
| Set the standard deviation coefficient. | |
| virtual void | setParameter (const string &name, const string &value) |
| Set parameter. More... | |
| virtual string | getParameter (const string &name) const |
| Get parameter. 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. | |
| 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. | |
| virtual void | init () |
| Initialise time-dependent values. | |
| 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. | |
| 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
A Wiener process (white) noise source.
Internal class: You never need to acces this class directly, since all public members are defined in Noise. This special derivation of Noise is only important internally, for the NoiseSource class.
Constructor & Destructor Documentation
|
protected |
Construct.
This constructor is protected, because this class can only be instantiated by calls from the NoiseSource class.
|
protected |
Construct.
This class mustn't be copied.
Member Function Documentation
|
protectedvirtual |
Set the next values.
- Parameters
-
indicator The stochastic indicator. This is the main method. The NoiseSource class uses this to set the indicator values. If the indicator is above the current threshold, the value is set to w (the weight of the process), otherwise to 0.0.
Implements Noise.
