ITimeSeriesDataFactory Interface
Creates objects representing time series data.
public interface ITimeSeriesDataFactoryMethods
Section titled “Methods”ITimeSeriesDataFactory.BuildCollection<TValue>(Period, IInterval, bool, FunctionType, ITimeZone) Method
Section titled “ITimeSeriesDataFactory.BuildCollection<TValue>(Period, IInterval, bool, FunctionType, ITimeZone) Method”Builds a collection of time series data.
The Time property of its items is determined from the given parameters.
The Flag and the Value properties are set to their defaults.
System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>> BuildCollection<TValue>(HAKOM.TSM.Net.Api.Time.Periods.Period period, HAKOM.TSM.Net.Api.Time.Intervals.IInterval interval, bool cyclic, HAKOM.TSM.Net.Api.TimeSeries.FunctionType function, HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone timeZone) where TValue : System.IComparable<TValue>?, System.IEquatable<TValue>?;Type parameters
Section titled “Type parameters”TValue
The type of value these data points have.
Parameters
Section titled “Parameters”period Period
The period of time of the data point.
interval IInterval
The IInterval of this data point.
cyclic System.Boolean
A System.Boolean indicating whether the collection is cyclic or not.
function FunctionType
The FunctionType of this data point.
timeZone ITimeZone
The ITimeZone used to create the data points.
Returns
Section titled “Returns”System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>>
A collection of ITimeSeriesData<TValue> object.
ITimeSeriesDataFactory.Create<TValue>(DateTimeOffset, TValue, Flag) Method
Section titled “ITimeSeriesDataFactory.Create<TValue>(DateTimeOffset, TValue, Flag) Method”Creates an instance of ITimeSeriesData<TValue> with the given time, value and flag.
HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue> Create<TValue>(System.DateTimeOffset time, TValue value, HAKOM.TSM.Net.Api.Flags.Flag flag) where TValue : System.IComparable<TValue>?, System.IEquatable<TValue>?;Type parameters
Section titled “Type parameters”TValue
The type of value this data point has.
Parameters
Section titled “Parameters”The time of the data point.
value TValue
The value of this data point.
flag Flag
The Flag of this data point.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>
An ITimeSeriesData<TValue> object.
ITimeSeriesDataFactory.CreateCollection<TValue>(IInterval, bool, FunctionType, IUnitReference, ITimeZone, IAsyncEnumerable<ITimeSeriesData<TValue>>, bool) Method
Section titled “ITimeSeriesDataFactory.CreateCollection<TValue>(IInterval, bool, FunctionType, IUnitReference, ITimeZone, IAsyncEnumerable<ITimeSeriesData<TValue>>, bool) Method”Creates a time series data collection with additional information.
HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> CreateCollection<TValue>(HAKOM.TSM.Net.Api.Time.Intervals.IInterval interval, bool cyclic, HAKOM.TSM.Net.Api.TimeSeries.FunctionType function, HAKOM.TSM.Net.Api.Units.Persistence.References.IUnitReference? unit, HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone timeZone, System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>> data, bool allowUnorderedPoints=false) where TValue : System.IComparable<TValue>?, System.IEquatable<TValue>?;Type parameters
Section titled “Type parameters”TValue
The type of the values of the data points in the collection.
Parameters
Section titled “Parameters”interval IInterval
The IInterval of the data collection.
cyclic System.Boolean
A System.Boolean indicating whether the collection is cyclic or not.
function FunctionType
The FunctionType of the data collection.
unit IUnitReference
The IUnitReference to the unit of the data collection.
timeZone ITimeZone
The ITimeZone of the data collection.
data System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>>
The list of time series data points.
allowUnorderedPoints System.Boolean
A System.Boolean indicating whether the collection allows data points that are not ordered in chronologically ascending order. If set to false (default) an exception (TimeSeriesDataElementsNotInChronologicalOrderException) will be thrown when the collection is enumerated. Note that this should only be set to true in very specific cases.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>
The time series data collection.
ITimeSeriesDataFactory.CreateCollection<TValue>(IInterval, bool, FunctionType, IUnitReference, ITimeZone, IEnumerable<ITimeSeriesData<TValue>>, bool) Method
Section titled “ITimeSeriesDataFactory.CreateCollection<TValue>(IInterval, bool, FunctionType, IUnitReference, ITimeZone, IEnumerable<ITimeSeriesData<TValue>>, bool) Method”Creates a time series data collection with additional information.
HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> CreateCollection<TValue>(HAKOM.TSM.Net.Api.Time.Intervals.IInterval interval, bool cyclic, HAKOM.TSM.Net.Api.TimeSeries.FunctionType function, HAKOM.TSM.Net.Api.Units.Persistence.References.IUnitReference? unit, HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone timeZone, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>> data, bool allowUnorderedPoints=false) where TValue : System.IComparable<TValue>?, System.IEquatable<TValue>?;Type parameters
Section titled “Type parameters”TValue
The type of the values of the data points in the collection.
Parameters
Section titled “Parameters”interval IInterval
The IInterval of the data collection.
cyclic System.Boolean
A System.Boolean indicating whether the collection is cyclic or not.
function FunctionType
The FunctionType of the data collection.
unit IUnitReference
The IUnitReference to the unit of the data collection.
timeZone ITimeZone
The ITimeZone of the data collection.
data System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>>
The list of time series data points.
allowUnorderedPoints System.Boolean
A System.Boolean indicating whether the collection allows data points that are not ordered in chronologically ascending order. If set to false (default) an exception (TimeSeriesDataElementsNotInChronologicalOrderException) will be thrown when the collection is enumerated. Note that this should only be set to true in very specific cases.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>
A time series data collection.