Struct InterpolationResult<T>
Result of interpolation.
Namespace: Microsoft.Psi
Assembly: Microsoft.Psi.dll
Syntax
public struct InterpolationResult<T>
Type Parameters
Name | Description |
---|---|
T | Type of values being interpolated. |
Fields
View SourceObsoleteTime
Time prior to which messages on the interpolation stream are obsolete and can safely be discarded.
Declaration
public readonly DateTime ObsoleteTime
Field Value
Type | Description |
---|---|
DateTime |
Type
Type of interpolation result.
Declaration
public readonly InterpolationResultType Type
Field Value
Type | Description |
---|---|
InterpolationResultType |
Value
Interpolated value (if any).
Declaration
public readonly T Value
Field Value
Type | Description |
---|---|
T |
Methods
View SourceCreate(T, DateTime)
Construct interpolation result indicating an interpolation was created based on the data.
Declaration
public static InterpolationResult<T> Create(T value, DateTime obsoleteTime)
Parameters
Type | Name | Description |
---|---|---|
T | value | Resulting interpolation value. |
DateTime | obsoleteTime | Time prior to which messages on the interpolation stream are obsolete and can safely be discarded. |
Returns
Type | Description |
---|---|
InterpolationResult<T> | Interpolation result indicating an interpolation was created based on the data. |
DoesNotExist(DateTime)
Construct interpolation result indicating no interpolation can be constructed based on the data.
Declaration
public static InterpolationResult<T> DoesNotExist(DateTime obsoleteTime)
Parameters
Type | Name | Description |
---|---|---|
DateTime | obsoleteTime | Time prior to which messages on the interpolation stream are obsolete and can safely be discarded. |
Returns
Type | Description |
---|---|
InterpolationResult<T> | Interpolation result indicating no interpolation can be constructed based on the data. |
Equals(Object)
Equality comparison.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | interpolation result to which to compare. |
Returns
Type | Description |
---|---|
System.Boolean | A value indicating equality. |
GetHashCode()
Generate a hashcode for the instance.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | The hashcode for the instance. |
InsufficientData()
Construct interpolation result indicating insufficient data.
Declaration
public static InterpolationResult<T> InsufficientData()
Returns
Type | Description |
---|---|
InterpolationResult<T> | Interpolation result indicating insufficient data. |
Operators
View SourceEquality(InterpolationResult<T>, InterpolationResult<T>)
Equality comparison.
Declaration
public static bool operator ==(InterpolationResult<T> first, InterpolationResult<T> second)
Parameters
Type | Name | Description |
---|---|---|
InterpolationResult<T> | first | First interpolation result. |
InterpolationResult<T> | second | Second interpolation result. |
Returns
Type | Description |
---|---|
System.Boolean | A value indicating whether the interpolation results are equal. |
Inequality(InterpolationResult<T>, InterpolationResult<T>)
Non-equality comparison.
Declaration
public static bool operator !=(InterpolationResult<T> first, InterpolationResult<T> second)
Parameters
Type | Name | Description |
---|---|---|
InterpolationResult<T> | first | First interpolation result. |
InterpolationResult<T> | second | Second interpolation result. |
Returns
Type | Description |
---|---|
System.Boolean | A value indicating whether the interpolation results are non-equal. |