Scalar Class Reference
returns a scalar More...
Inheritance diagram for Scalar:
Public Member Functions | |
| Scalar (double scalar, const string &name, const string &type="Scalar") | |
| Construct. More... | |
| Scalar (double scalar, string unitPrefix, string unitSymbol, const string &name, const string &type="Scalar") | |
| Construct. More... | |
| virtual | ~Scalar () |
| Destroy. | |
| virtual string | getParameter (const string &name) const |
| Get parameter. More... | |
| virtual void | setParameter (const string &name, const string &value) |
| Set parameter. More... | |
| virtual double | calculateCurrentValue () |
| Calculates the current value based on the current input. | |
| virtual double | calculateNextValue () |
| Calculates the next value based on the current input. | |
 Public Member Functions inherited from StochasticFunction | |
| StochasticFunction (class Time *time, const string &name="", const string &type="Stochastic Function") | |
| Create. | |
| double | operator() (double x) |
| Returns the value at the current time step. More... | |
| double | d (double x) |
| Returns the increment at the current time step. More... | |
| virtual double | getCurrentValue (double x) |
| Returns the value at the next time step. More... | |
| virtual double | getNextValue (double x) |
| Returns the value at the next time step. More... | |
| virtual double | getIncrement (double xt) |
| 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... | |
| virtual void | prepareNextState () |
| Calculate next value (preparing next 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. | |
| 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. | |
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
returns a scalar
Constructor & Destructor Documentation
| Scalar::Scalar | ( | double | scalar, |
| const string & | name, | ||
| const string & | type = "Scalar" |
||
| ) |
Construct.
Construct a scalar with a description.
| Scalar::Scalar | ( | double | scalar, |
| string | unitPrefix, | ||
| string | unitSymbol, | ||
| const string & | name, | ||
| const string & | type = "Scalar" |
||
| ) |
Construct.
Construcr a scalar with a description and a physical unit.
Member Function Documentation
|
virtual |
|
virtual |
