Click or drag to resize

EngineTime Methods

The EngineTime type exposes the following members.

Methods
  NameDescription
Public methodAccepts
List of data types that is accepted and can be used in SetValue
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNextTimeStep
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.
Public methodOffers
List of data types that is offered and can be used in GetValue
Public methodPrepare
Public methodResetInitialTimeStep
Resets values for EngineTimeStep and sets DtSpan to initialTimeStep.
Public methodSetTime
Adjusts the current timestep by setting both DtSpan and TimeNp1 Unit: [sec]. Rounded to nearest millisecond
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryDecreaseTimeStep
Returns false if the time step should be decreased but cannot be decreased further. Throws an exception if adaptive time stepping is not enabled.
Public methodUpdate
Steps time one time steps forward
Public methodValueFractionGetter
Public methodValueGetter
Get value setter for the specified data quantity
Public methodValueSetter
Get value setter for the specified data type
Top
Extension Methods
  NameDescription
Public Extension MethodGetter

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.

(Defined by ProxyExtensions.)
Public Extension MethodGetters
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.)
Public Extension MethodGettersFraction
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.)
Public Extension MethodGetterUnboxed

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.

(Defined by ProxyExtensions.)
Public Extension MethodSetter

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.

(Defined by ProxyExtensions.)
Top
See Also