| IDfsEqCalendarAxis Methods |
The IDfsEqCalendarAxis type exposes the following members.
Extension Methods| Name | Description | |
|---|---|---|
 | EndDateTime |
Get the end date time for an equidistant calendar axis.
(Defined by DfsExtensions.) |
| GetDateTimes | Overloaded.
Return an array of DateTimes which are the times for each timestep.
(Defined by DfsExtensions.)For non-equidistant axis, only the first and the last time are populated correctly. The rest are populated with MinValue. For time type axis, first time is StartTimeOffsetInSeconds(IDfsTemporalAxis) after MinValue. |
| GetDateTimes | Overloaded.
Return an array of DateTimes which are the times for each timestep
(Defined by DfsExtensions.) |
| GetRelativeSeconds |
Return an array of doubles which are the the number of seconds since the start time
for each timestep.
(Defined by DfsExtensions.)For non-equidistant axis, only the first and the last time are populated correctly. The rest are populated with -1 For time type axis, first time is StartTimeOffsetInSeconds(IDfsTemporalAxis) |
| IsCalendar |
Returns true if the temporal axis is a calendar axis
(Defined by DfsExtensions.) |
| IsEquidistant |
Returns true if the temporal axis is equidistant.
(Defined by DfsExtensions.) |
| StartTimeOffsetInSeconds |
Return the start time offset in seconds
(Defined by DfsExtensions.) |
| TimeSpan |
Time span of all data in file, in unit described by TimeUnit.
(Defined by DfsExtensions.)The StartTimeOffset is not included in the span. The span starts at the time of the StartTimeOffset Convenience method that returns/calculates the time span consistently for all types of time axes, |
| TimeSpanAsTimeSpan |
Calculate the time span as a System.TimeSpan
(Defined by DfsExtensions.) |
| TimeSpanInSeconds |
Calculate the time span in seconds
(Defined by DfsExtensions.) |
| TimeStepInSeconds | Overloaded.
Calculate the time step in seconds for an equidistant temporal axis.
(Defined by DfsExtensions.)If the time axis is not equidistant, zero is returned. If the time axis unit can not be converted to seconds, an exception is thrown |
| TimeStepInSeconds | Overloaded.
Calculate the time step in seconds for an equidistant calendar axis
(Defined by DfsExtensions.)If the time axis unit can not be converted to seconds, an exception is thrown |
| ToDateTime |
Returns the relativeTime as a DateTime.
The time axis must be a calendar type axis.
(Defined by DfsExtensions.) |
| ToRelativeSeconds |
Returns the dateTime in relative seconds from the
start time of the time axis, in the unit used by the file.
The time axis must be a calendar type axis.
(Defined by DfsExtensions.)Note that for the equidistant axes, the first time step may be offset (see StartTimeOffset), however the time returned here is relative to the start time and not the first time step. This is matching the time returned by the read methods (Time). |
| ToRelativeTime(Double) | Overloaded.
Converts a time value in seconds to a time value in the unit
of the temporal axis.
(Defined by DfsExtensions.) |
| ToRelativeTime(DateTime) | Overloaded.
Returns the dateTime in relative time from the
start time of the time axis, in the unit used by the file.
The time axis must be a calendar type
axis.
(Defined by DfsExtensions.)Note that for the equidistant axes, the first time step may be offset (see StartTimeOffset), however the time returned here is relative to the start time and not the first time step. This is matching the time returned by the read methods (Time). |
| ToSeconds |
Converts a time value in the unit of the temporal axis
(TimeUnit) to
a time value in seconds.
(Defined by DfsExtensions.) |
| ToSecondsFactor |
Returns a factor for converting from a time value in the
specified time unit to a time value in seconds.
(Defined by DfsExtensions.)For month and year time units, the factor is not uniquely defined, and may not return the value you want to use. |
See Also