ITsTime Interface

Interface to the time information of a time series collection

Namespace: DHI.Mike1D.Generic.TimeSeries
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 16.0.0.0 (11.1.1.1111)

Syntax

public interface ITsTime

The ITsTime type exposes the following members.

Properties

	Name	Description
	DateTimes	DateTimes in file.
	EndTime	End time of time series. For a calendar axis IsCalendarAxis this is retrieved from the time series. For a relative time axis this is the StartTime plus the time series span. The StartTime must be set before this returns anything usefull.
	NumberOfTimes	Number of time steps.
	RelativeTimes	Times in seconds from the start of the time series.
	StartTime	Start time of time series. For a calendar axis IsCalendarAxis this is retrieved from the time series. For a relative time axis this must be set before any call to any of the GetValue calls with a DateTime argument, as e.g. GetValue(DateTime). It is not required to be set if using the GetValue(Double) version.
	TimeType	Type of time axis.

Methods

	Name	Description
	GetInterval(Double, Double)	Finds the interval in the time vector where the argument lays in between. If argument is below the first value, 0 is returned. If argument is above last value, the length of the vector is returned. The result is the interval number, one based, meaning that the arg fullfills: Copy (vector[res-1] < arg && arg <= vector[res]) Also the scale factor for interpolating is returned. For linear interpolation Copy arg = vector[res-1] + fraction(vector[res]-vector[res-1]) or Copy arg = (1-fraction)vector[res-1] + fraction*vector[res] If arg exists in vector, the result is such that Copy arg = vector[res] i.e., fraction is one (except when arg = vector[0], then res = 1 and fraction = 0).
	GetInterval(Double, Double, Int32)	Same as GetInterval(Double, Double), apart from that the lastInterval is searched first. This is an optimized version when successive calls returns interval that are nearby.
	GetTime	Returns the relative time at the given index
	IsCalendarAxis	Returns true if the time axis is a calendar axis
	IsEquidistantAxis	Returns true if the time axis is equidistant
	RelativeTime	Return the relative time value of the input time