Class RelativeTimeInterval

Represents a TimeSpan interval with bounded/unbounded and inclusive/exclusive end points.

Inheritance
System.Object
Interval<TimeSpan, TimeSpan, IntervalEndpoint<TimeSpan>, RelativeTimeInterval>
RelativeTimeInterval
Implements
IInterval<TimeSpan, TimeSpan, IntervalEndpoint<TimeSpan>, RelativeTimeInterval>
Inherited Members
Namespace: Microsoft.Psi
Assembly: Microsoft.Psi.dll
Syntax
public class RelativeTimeInterval : Interval<TimeSpan, TimeSpan, IntervalEndpoint<TimeSpan>, RelativeTimeInterval>, IInterval<TimeSpan, TimeSpan, IntervalEndpoint<TimeSpan>, RelativeTimeInterval>

Constructors

View Source

RelativeTimeInterval(IntervalEndpoint<TimeSpan>, IntervalEndpoint<TimeSpan>)

Initializes a new instance of the RelativeTimeInterval class.

Declaration
public RelativeTimeInterval(IntervalEndpoint<TimeSpan> leftEndpoint, IntervalEndpoint<TimeSpan> rightEndpoint)
Parameters
Type Name Description
IntervalEndpoint<TimeSpan> leftEndpoint

Left endpoint.
IntervalEndpoint<TimeSpan> rightEndpoint

Right endpoint.
View Source

RelativeTimeInterval(TimeSpan, Boolean, Boolean, TimeSpan, Boolean, Boolean)

Initializes a new instance of the RelativeTimeInterval class.

Declaration
public RelativeTimeInterval(TimeSpan leftPoint, bool leftInclusive, bool leftBounded, TimeSpan rightPoint, bool rightInclusive, bool rightBounded)
Parameters
Type Name Description
TimeSpan leftPoint

Left bound point (or min value if unbound).
System.Boolean leftInclusive

Whether left point is inclusive (always false if unbound).
System.Boolean leftBounded

Whether left point is bounded.
TimeSpan rightPoint

Right bound point (or min value if unbound).
System.Boolean rightInclusive

Whether right point is inclusive (always false if unbound).
System.Boolean rightBounded

Whether right point is bounded.
View Source

RelativeTimeInterval(TimeSpan, Boolean, TimeSpan, Boolean)

Initializes a new instance of the RelativeTimeInterval class.

Declaration
public RelativeTimeInterval(TimeSpan leftPoint, bool leftInclusive, TimeSpan rightPoint, bool rightInclusive)
Parameters
Type Name Description
TimeSpan leftPoint

Left bound point.
System.Boolean leftInclusive

Whether left point is inclusive.
TimeSpan rightPoint

Right bound point.
System.Boolean rightInclusive

Whether right point is inclusive.
View Source

RelativeTimeInterval(TimeSpan, TimeSpan)

Initializes a new instance of the RelativeTimeInterval class.

Declaration
public RelativeTimeInterval(TimeSpan leftPoint, TimeSpan rightPoint)
Parameters
Type Name Description
TimeSpan leftPoint

Left bound point.
TimeSpan rightPoint

Right bound point.
Remarks

Defaults to inclusive.

Fields

View Source

Empty

Canonical empty instance (bounded, non-inclusive, single point).

Declaration
public static readonly RelativeTimeInterval Empty
Field Value
Type Description
RelativeTimeInterval
View Source

Infinite

Canonical infinite interval (unbounded on both ends).

Declaration
public static readonly RelativeTimeInterval Infinite
Field Value
Type Description
RelativeTimeInterval
View Source

Zero

Zero interval (unbounded but inclusive, zero value).

Declaration
public static readonly RelativeTimeInterval Zero
Field Value
Type Description
RelativeTimeInterval

Properties

View Source

PointMaxValue

Gets the point maximum value.

Declaration
protected override TimeSpan PointMaxValue { get; }
Property Value
Type Description
TimeSpan
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.PointMaxValue
View Source

PointMinValue

Gets the point minimum value.

Declaration
protected override TimeSpan PointMinValue { get; }
Property Value
Type Description
TimeSpan
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.PointMinValue
View Source

SpanMaxValue

Gets the span maximum value.

Declaration
protected override TimeSpan SpanMaxValue { get; }
Property Value
Type Description
TimeSpan
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.SpanMaxValue
View Source

SpanMinValue

Gets the span minimum value.

Declaration
protected override TimeSpan SpanMinValue { get; }
Property Value
Type Description
TimeSpan
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.SpanMinValue
View Source

SpanZeroValue

Gets the span zero value.

Declaration
protected override TimeSpan SpanZeroValue { get; }
Property Value
Type Description
TimeSpan
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.SpanZeroValue

Methods

View Source

ComparePoints(TimeSpan, TimeSpan)

Compare points.

Declaration
protected override int ComparePoints(TimeSpan a, TimeSpan b)
Parameters
Type Name Description
TimeSpan a

First point.
TimeSpan b

Second point.
Returns
Type Description
System.Int32

Less (-1), greater (+1) or equal (0).
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.ComparePoints(TimeSpan, TimeSpan)
View Source

Coverage(IEnumerable<RelativeTimeInterval>)

Determine coverage from minimum left to maximum right for a set of given intervals.

Declaration
public static RelativeTimeInterval Coverage(IEnumerable<RelativeTimeInterval> intervals)
Parameters
Type Name Description
IEnumerable<RelativeTimeInterval> intervals

The set of intervals.
Returns
Type Description
RelativeTimeInterval

Interval from minimum left to maximum right value.
Remarks

Returns empty interval when sequence is empty or contains only empty intervals.

View Source

Difference(TimeSpan, TimeSpan)

Determine span between two given points.

Declaration
protected override TimeSpan Difference(TimeSpan x, TimeSpan y)
Parameters
Type Name Description
TimeSpan x

First point.
TimeSpan y

Second point.
Returns
Type Description
TimeSpan

Span between points.
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.Difference(TimeSpan, TimeSpan)
View Source

Equals(RelativeTimeInterval)

Declaration
public bool Equals(RelativeTimeInterval other)
Parameters
Type Name Description
RelativeTimeInterval other
Returns
Type Description
System.Boolean
View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
View Source

Future()

Returns a relative time interval describing the future. The returned interval includes the present moment.

Declaration
public static RelativeTimeInterval Future()
Returns
Type Description
RelativeTimeInterval

A relative time interval describing the future.
View Source

Future(TimeSpan, Boolean)

Returns a relative time interval of a specified duration in the future. The returned interval includes the present moment.

Declaration
public static RelativeTimeInterval Future(TimeSpan duration, bool inclusive = true)
Parameters
Type Name Description
TimeSpan duration

The duration of the time interval.
System.Boolean inclusive

Indicates if the interval should be inclusive of the right endpoint.
Returns
Type Description
RelativeTimeInterval

A relative time interval of a specified duration in the future.
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
View Source

LeftBounded(TimeSpan)

Constructor helper for left-bound instances.

Declaration
public static RelativeTimeInterval LeftBounded(TimeSpan left)
Parameters
Type Name Description
TimeSpan left

Left bound point.
Returns
Type Description
RelativeTimeInterval

A left-bound instance of the RelativeTimeInterval class.
Remarks

Defaults to inclusive.

View Source

LeftBounded(TimeSpan, Boolean)

Constructor helper for left-bound instances.

Declaration
public static RelativeTimeInterval LeftBounded(TimeSpan left, bool inclusive)
Parameters
Type Name Description
TimeSpan left

Left bound point.
System.Boolean inclusive

Whether left point is inclusive.
Returns
Type Description
RelativeTimeInterval

A left-bound instance of the RelativeTimeInterval class.
View Source

Merge(IEnumerable<RelativeTimeInterval>)

Merges a specified set of relative time intervals into a set of non-overlapping relative time intervals that cover the specified intervals.

Declaration
public static IEnumerable<RelativeTimeInterval> Merge(IEnumerable<RelativeTimeInterval> intervals)
Parameters
Type Name Description
IEnumerable<RelativeTimeInterval> intervals

A set of relative time intervals to cover.
Returns
Type Description
IEnumerable<RelativeTimeInterval>

Set of non-overlapping time intervals that cover the given time intervals.
View Source

NegateSpan(TimeSpan)

Negate span.

Declaration
protected override TimeSpan NegateSpan(TimeSpan span)
Parameters
Type Name Description
TimeSpan span

Span to be negated.
Returns
Type Description
TimeSpan

Negated span.
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.NegateSpan(TimeSpan)
View Source

Past()

Returns a relative time interval describing the past. The returned interval includes the present moment.

Declaration
public static RelativeTimeInterval Past()
Returns
Type Description
RelativeTimeInterval

A relative time interval describing the past.
View Source

Past(TimeSpan, Boolean)

Returns a relative time interval of a specified duration in the past. The returned interval includes the present moment.

Declaration
public static RelativeTimeInterval Past(TimeSpan duration, bool inclusive = true)
Parameters
Type Name Description
TimeSpan duration

The duration of the time interval.
System.Boolean inclusive

Indicates if the interval should be inclusive of the left endpoint.
Returns
Type Description
RelativeTimeInterval

A relative time interval of a specified duration in the past.
View Source

RightBounded(TimeSpan)

Constructor helper for right-bound instances.

Declaration
public static RelativeTimeInterval RightBounded(TimeSpan right)
Parameters
Type Name Description
TimeSpan right

Right bound point.
Returns
Type Description
RelativeTimeInterval

A right-bound instance of the RelativeTimeInterval class.
Remarks

Defaults to inclusive.

View Source

RightBounded(TimeSpan, Boolean)

Constructor helper for right-bound instances.

Declaration
public static RelativeTimeInterval RightBounded(TimeSpan right, bool inclusive)
Parameters
Type Name Description
TimeSpan right

Right bound point.
System.Boolean inclusive

Whether right point is inclusive.
Returns
Type Description
RelativeTimeInterval

A right-bound instance of the RelativeTimeInterval class.
View Source

Scale(Single, Single)

Scale endpoints by factors.

Declaration
public override RelativeTimeInterval Scale(float left, float right)
Parameters
Type Name Description
System.Single left

Factor by which to scale left.
System.Single right

Factor by which to scale right.
Returns
Type Description
RelativeTimeInterval

Scaled interval.
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.Scale(System.Single, System.Single)
View Source

Scale(TimeSpan, TimeSpan)

Scale endpoints by span distances.

Declaration
public override RelativeTimeInterval Scale(TimeSpan left, TimeSpan right)
Parameters
Type Name Description
TimeSpan left

Span by which to scale left.
TimeSpan right

Span by which to scale right.
Returns
Type Description
RelativeTimeInterval

Scaled interval.
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.Scale(TimeSpan, TimeSpan)
View Source

ScaleSpan(TimeSpan, Double)

Scale a span by a given factor.

Declaration
protected override TimeSpan ScaleSpan(TimeSpan span, double factor)
Parameters
Type Name Description
TimeSpan span

Span value.
System.Double factor

Factor by which to scale.
Returns
Type Description
TimeSpan

Scaled span.
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.ScaleSpan(TimeSpan, System.Double)
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
View Source

Translate(TimeSpan)

Translate by a span distance.

Declaration
public override RelativeTimeInterval Translate(TimeSpan span)
Parameters
Type Name Description
TimeSpan span

Span by which to translate.
Returns
Type Description
RelativeTimeInterval

Translated interval.
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.Translate(TimeSpan)
Remarks

Unbound points do not change.

View Source

TranslatePoint(TimeSpan, TimeSpan)

Translate point by given span.

Declaration
protected override TimeSpan TranslatePoint(TimeSpan point, TimeSpan span)
Parameters
Type Name Description
TimeSpan point

Point value.
TimeSpan span

Span by which to translate.
Returns
Type Description
TimeSpan

Translated point.
Overrides
Microsoft.Psi.Interval<TimeSpan, TimeSpan, Microsoft.Psi.IntervalEndpoint<TimeSpan>, Microsoft.Psi.RelativeTimeInterval>.TranslatePoint(TimeSpan, TimeSpan)

Operators

View Source

Addition(DateTime, RelativeTimeInterval)

Construct TimeInterval relative to an origin (DateTime).

Declaration
public static TimeInterval operator +(DateTime origin, RelativeTimeInterval relative)
Parameters
Type Name Description
DateTime origin

Origin time point.
RelativeTimeInterval relative

Relative endpoints.
Returns
Type Description
TimeInterval

Translated interval.
View Source

Equality(RelativeTimeInterval, RelativeTimeInterval)

Equality operator that returns true if the operands are equal, false otherwise.

Declaration
public static bool operator ==(RelativeTimeInterval x, RelativeTimeInterval y)
Parameters
Type Name Description
RelativeTimeInterval x

The first operand.
RelativeTimeInterval y

The second operand.
Returns
Type Description
System.Boolean

A value indicating whether the operands are equal.
View Source

Inequality(RelativeTimeInterval, RelativeTimeInterval)

Inequality operator that returns true if the operands are not equal, false otherwise.

Declaration
public static bool operator !=(RelativeTimeInterval x, RelativeTimeInterval y)
Parameters
Type Name Description
RelativeTimeInterval x

The first operand.
RelativeTimeInterval y

The second operand.
Returns
Type Description
System.Boolean

A value indicating whether the operands are not equal.

Implements

IEquatable<>

Extension Methods