EngineTime Methods |
The EngineTime type exposes the following members.
Name | Description | |
---|---|---|
Accepts |
List of data types that is accepted and can be used in SetValue
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NextTimeStep |
Returns the size of the next time step. In case of adaptive time stepping
this is a guess of the size of the next time step, and may not equal
the actual size of the time step.
| |
Offers |
List of data types that is offered and can be used in GetValue
| |
Prepare | ||
ResetInitialTimeStep |
Resets values for EngineTimeStep and sets DtSpan to initialTimeStep.
| |
SetTime |
Adjusts the current timestep by setting both DtSpan and TimeNp1
Unit: [sec]. Rounded to nearest millisecond
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TryDecreaseTimeStep |
Returns false if the time step should be decreased but cannot be decreased further.
Throws an exception if adaptive time stepping is not enabled.
| |
Update |
Steps time one time steps forward
| |
ValueFractionGetter | ||
ValueGetter |
Get value setter for the specified data quantity
| |
ValueSetter |
Get value setter for the specified data type
|
Name | Description | |
---|---|---|
Getter | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. | |
Getters |
Returns a set of FuncTResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) | |
GettersFraction |
Returns a set of FuncT, TResult for the quantity.
We can return several quantities with the same id (usually they will differ in their description).
If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions.) | |
GetterUnboxed | From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. | |
Setter | From the proxy, return an IDoubleGetSet for the specified quantity. It returns the first quantity of that type that is accepted, and null if the quantity is not accepted. |