Click or drag to resize

TimeGeneratorRegularSamplingFromInterval Method (TimeInterval, JulianDate, Duration)

Generates times at regular steps within an interval (not including the end time).

Namespace:  AGI.Foundation.Time
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 21.2.409.0 (21.2.409.0)
Syntax
public static IList<JulianDate> RegularSamplingFromInterval(
	TimeInterval interval,
	JulianDate startOfSampling,
	Duration step
)

Parameters

interval
Type: AGI.Foundation.TimeTimeInterval
The interval in which to generate times.
startOfSampling
Type: AGI.Foundation.TimeJulianDate
The time at which to start sampling. If this time is prior to the given sampling interval, samples will begin inside the interval.
step
Type: AGI.Foundation.TimeDuration
The step between times.

Return Value

Type: IListJulianDate
A collection of times within the interval.
Remarks

Times in the collection are generated as they are requested, so the returned collection uses a negligible amount of memory even when representing times over a large interval with a small step.

If the start date of the interval is included in the interval (IsStartIncluded) and lies at a whole number of steps from the startOfSampling, the first date in the collection will be the start date of the interval. If it is not included, the first date in the collection will be sometime later. If the stop date of the interval is included in the interval (IsStopIncluded), it will be included as the last time in the list only if it lies exactly at a sample time. If it is not included, the last date in the collection will be up to step seconds before the stop date. If neither the start nor stop date are included, and the interval does not have any samples falling inside it, the returned collection is empty.

See Also