TimeIntervalCollection Class

A collection of time intervals. The intervals are sorted by their start date and no two intervals in the list overlap each other.

Inheritance Hierarchy

SystemObject
AGI.Foundation.TimeTimeIntervalCollection

Namespace: AGI.Foundation.Time
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public sealed class TimeIntervalCollection : IList<TimeInterval>, 
	ICollection<TimeInterval>, IEnumerable<TimeInterval>, IEnumerable, 
	IList, ICollection, IEquatable<TimeIntervalCollection>, IEquatableEpsilon<TimeIntervalCollection>, 
	IFreezable

Public NotInheritable Class TimeIntervalCollection
	Implements IList(Of TimeInterval), ICollection(Of TimeInterval), 
	IEnumerable(Of TimeInterval), IEnumerable, IList, ICollection, 
	IEquatable(Of TimeIntervalCollection), IEquatableEpsilon(Of TimeIntervalCollection), IFreezable

public ref class TimeIntervalCollection sealed : IList<TimeInterval^>, 
	ICollection<TimeInterval^>, IEnumerable<TimeInterval^>, IEnumerable, 
	IList, ICollection, IEquatable<TimeIntervalCollection^>, IEquatableEpsilon<TimeIntervalCollection^>, 
	IFreezable

[<SealedAttribute>]
type TimeIntervalCollection =  
    class
        interface IList<TimeInterval>
        interface ICollection<TimeInterval>
        interface IEnumerable<TimeInterval>
        interface IEnumerable
        interface IList
        interface ICollection
        interface IEquatable<TimeIntervalCollection>
        interface IEquatableEpsilon<TimeIntervalCollection>
        interface IFreezable
    end

The TimeIntervalCollection type exposes the following members.

Constructors

	Name	Description
	TimeIntervalCollection	Initializes a new, empty interval collection.
	TimeIntervalCollection(TimeInterval)	Initializes a new instance from a single interval.
	TimeIntervalCollection(TimeIntervalCollection)	Initializes a new interval collection by copying an existing one.

Top

Properties

	Name	Description
	Count	Gets the number of intervals in this interval collection.
	Empty	Gets an empty, read-only TimeIntervalCollection.
	Infinite	Gets an unbounded, infinite, read-only TimeIntervalCollection.
	IsEmpty	Gets a value indicating whether this interval collection is empty, where emptiness is defined as the count of intervals being equal to zero. To determine if the amount of time contained in this interval collection is zero, convert to a duration using ToDuration and check for equality with Zero.
	IsFrozen	Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
	IsInfinite	Gets a value indicating whether the interval collection is infinite. An infinite interval collection contains all possible times.
	Item	Gets the interval at the specified index.
	Start	Gets the start date of the first interval in the collection.
	Stop	Gets the stop date of the last interval in the collection

Top

Methods

	Name	Description
	Add(TimeInterval)	Adds an interval to the interval collection.
	Add(TimeIntervalCollection)	Adds another interval collection to this interval collection. This interval collection will contain all intervals that were previously in either collection.
	AddDataT	Converts this collection to a TimeIntervalCollectionT by filling in the Data property for all intervals.
	Clear	Removes all intervals from the interval collection.
	Complement	Computes the complement of this time interval collection.
	Contains(JulianDate)	Determines if the collection contains a specified date.
	Contains(TimeInterval)	Determines if this collection contains all of a specified interval.
	CopyTo	Copies the intervals in this collection to an array.
	Equals(Object)	Indicates whether another object is exactly equal to this instance. (Overrides ObjectEquals(Object).)
	Equals(TimeIntervalCollection)	Indicates whether another instance of this type is exactly equal to this instance.
	EqualsEpsilon	Determines if this TimeIntervalCollection is equal to another by comparing each of the TimeInterval elements in the two collections with EqualsEpsilon(TimeInterval, Double).
	FindIntervalContainingDate	Finds the TimeInterval in this collection that contains a specified date.
	Freeze	Freezes this object. Further attempts to modify this object will result in an ObjectFrozenException.
	GetEnumerator	Gets an enumerator for this interval list.
	GetHashCode	Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf(JulianDate)	Finds the index of the TimeInterval in this collection that contains the specified date.
	IndexOf(TimeInterval)	Finds the index of a given TimeInterval in the collection. This method requires that the given interval exactly match an interval in the collection. Intervals with different time standards or even slightly different values due to floating point noise will be considered to be different.
	Intersect(TimeInterval)	Computes the intersection of this interval collection with an interval.
	Intersect(TimeIntervalCollection)	Computes the intersection of this interval collection with another.
	Remove(TimeInterval)	Removes the specified interval from this interval list, creating a hole over the specified interval.
	Remove(TimeIntervalCollection)	Removes the specified intervals from this interval list, creating a hole over the specified intervals.
	RemoveAt	Removes the interval at a specified index in the collection.
	RemoveLeavingEndpoints(TimeInterval)	Removes the specified interval from this interval list, creating a hole over the specified interval. The end points of the removed interval are NOT removed.
	RemoveLeavingEndpoints(TimeIntervalCollection)	Removes the specified intervals from this interval list, creating a hole over the specified intervals. The end points of the removed intervals are NOT removed.
	ToDuration	Returns a Duration representing the span of time represented by the sum of the individual time intervals in the collection.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	ToTimeStandard	Converts all times in this time interval collection to be the specified time standard.

Top

Operators

	Name	Description
	Equality	Returns if the two instances are exactly equal.
	Inequality	Returns if the two instances are not exactly equal.

Top

Reference

AGI.Foundation.Time Namespace