TsTime Class

Class handling non-equidistant calendar time time series.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.Generic.TimeSeriesTsTime

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

Syntax

Copy

public class TsTime : ITsTime

The TsTime type exposes the following members.

Constructors

	Name	Description
	TsTime	Initializes a new instance of the TsTime class

Top

Properties

	Name	Description
	DateTimes	DateTimes in the time series. For a calendar time axis this is retrieved from the time series. For a relative time axis this is calculated relative to the time series StartTime that must be set before this is called.
	Dt	Time step in seconds. Only valid when IsEquidistantAxis
	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	Returns the number of times/values in the time series
	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.
	TimeSpan	Time span in seconds of data in file.
	TimeType	Type of time axis.

Top

Methods

	Name	Description
	CreateNonEqCalendarAxis
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	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
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsCalendarAxis	Returns true if the time axis is a calendar time axis. It returns false for an Undefined_Time and any of the relative time axis.
	IsCalendarAxis(TsTimeType)	Returns true if the time axis is a calendar time axis. It returns false for an Undefined_Time and any of the relative time axis.
	IsEquidistantAxis	Returns true if the time axis is an equidistant time axis.
	IsEquidistantAxis(TsTimeType)	Returns true if the time axis is an equidistant time axis.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RelativeTime(DateTime)	Return the relative time value of the input time
	RelativeTime(DateTime, DateTime)	Return the relative time value of the input time, having startTime as zero for the relative axis
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

DHI.Mike1D.Generic.TimeSeries Namespace