ITimeSeriesFactory Interface
For creating time series and associated data.
public interface ITimeSeriesFactoryProperties
Section titled “Properties”ITimeSeriesFactory.Defaults Property
Section titled “ITimeSeriesFactory.Defaults Property”Gets default values for some properties of the time series.
HAKOM.TSM.Net.Api.TimeSeries.ITimeSeriesDefaults Defaults { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”ITimeSeriesFactory.Create(string, IInterval, bool, FunctionType, IUnitReference, string, IFormula, ITimeZone, Nullable<IntervalTransformationMethod>, Nullable<DateTimeOffset>, Nullable<bool>, bool, bool, bool, Nullable<QuotationBehavior>, CompressionMode, Nullable<int>, bool) Method
Section titled “ITimeSeriesFactory.Create(string, IInterval, bool, FunctionType, IUnitReference, string, IFormula, ITimeZone, Nullable<IntervalTransformationMethod>, Nullable<DateTimeOffset>, Nullable<bool>, bool, bool, bool, Nullable<QuotationBehavior>, CompressionMode, Nullable<int>, bool) Method”Creates a new time series.
HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries Create(string name, 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=null, string? description=null, HAKOM.TSM.Net.Api.Formulas.IFormula? formula=null, HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone? timeZone=null, System.Nullable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> intervalTransformationMethod=null, System.Nullable<System.DateTimeOffset> startOfTime=null, System.Nullable<bool> preserveDuplicatedValues=false, bool preserveHistoricData=false, bool preserveAuditLog=false, bool quotation=false, System.Nullable<HAKOM.TSM.Net.Api.Quotations.QuotationBehavior> quotationDefaultBehavior=null, HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.CompressionMode compressionMode=default(HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.CompressionMode), System.Nullable<int> compressionMultiplier=null, bool validate=true);Parameters
Section titled “Parameters”name System.String
The name of the time series
interval IInterval
The IInterval of the time series.
cyclic System.Boolean
A System.Boolean indicating whether the values along the time axis are cyclic or not.
function FunctionType
The FunctionType.
unit IUnitReference
The IUnitReference of the time series.
description System.String
The description of the time series
formula IFormula
The IFormula attached to the time series.
timeZone ITimeZone
The System.TimeZone of the time series.
intervalTransformationMethod System.Nullable<IntervalTransformationMethod>
The IntervalTransformationMethod of the time series.
startOfTime System.Nullable<System.DateTimeOffset>
The start time of the time series data mesh.
preserveDuplicatedValues System.Nullable<System.Boolean>
A System.Boolean indicating if duplicate value types should be preserved.
preserveHistoricData System.Boolean
A System.Boolean indicating if historic data for this time series should be preserved.
preserveAuditLog System.Boolean
A System.Boolean value indicating whether changes made to the time series and its data should be recorded for auditing purposes.
quotation System.Boolean
A System.Boolean indicating if the time series should allow quotation.
quotationDefaultBehavior System.Nullable<QuotationBehavior>
The QuotationBehavior.
compressionMode CompressionMode
The CompressionMode.
compressionMultiplier System.Nullable<System.Int32>
An System.Int32representing compression multiplier of the time series.
validate System.Boolean
A System.Boolean indicating whether the time series should be validated. There should be no reason to set this to false unless one deliberately attempts to create a corrupt time series.
Returns
Section titled “Returns”ITimeSeries
A new ITimeSeries object.
ITimeSeriesFactory.TryCreate(string, IInterval, bool, FunctionType, IUnitReference, string, IFormula, ITimeZone, Nullable<IntervalTransformationMethod>, Nullable<DateTimeOffset>, Nullable<bool>, bool, bool, bool, Nullable<QuotationBehavior>, CompressionMode, Nullable<int>, bool) Method
Section titled “ITimeSeriesFactory.TryCreate(string, IInterval, bool, FunctionType, IUnitReference, string, IFormula, ITimeZone, Nullable<IntervalTransformationMethod>, Nullable<DateTimeOffset>, Nullable<bool>, bool, bool, bool, Nullable<QuotationBehavior>, CompressionMode, Nullable<int>, bool) Method”Creates a new time series.
HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries> TryCreate(string name, 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=null, string? description=null, HAKOM.TSM.Net.Api.Formulas.IFormula? formula=null, HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone? timeZone=null, System.Nullable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> intervalTransformationMethod=null, System.Nullable<System.DateTimeOffset> startOfTime=null, System.Nullable<bool> preserveDuplicatedValues=false, bool preserveHistoricData=false, bool preserveAuditLog=false, bool quotation=false, System.Nullable<HAKOM.TSM.Net.Api.Quotations.QuotationBehavior> quotationDefaultBehavior=null, HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.CompressionMode compressionMode=default(HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.CompressionMode), System.Nullable<int> compressionMultiplier=null, bool validate=true);Parameters
Section titled “Parameters”name System.String
The name of the time series
interval IInterval
The IInterval of the time series.
cyclic System.Boolean
A System.Boolean indicating whether the values along the time axis are cyclic or not.
function FunctionType
The FunctionType.
unit IUnitReference
The IUnitReference of the time series.
description System.String
The description of the time series
formula IFormula
The IFormula attached to the time series.
timeZone ITimeZone
The System.TimeZone of the time series.
intervalTransformationMethod System.Nullable<IntervalTransformationMethod>
The IntervalTransformationMethod of the time series.
startOfTime System.Nullable<System.DateTimeOffset>
The start time of the time series data mesh.
preserveDuplicatedValues System.Nullable<System.Boolean>
A System.Boolean indicating if duplicate value types should be preserved.
preserveHistoricData System.Boolean
A System.Boolean indicating if historic data for this time series should be preserved.
preserveAuditLog System.Boolean
A System.Boolean value indicating whether changes made to the time series and its data should be recorded for auditing purposes.
quotation System.Boolean
A System.Boolean indicating if the time series should allow quotation.
quotationDefaultBehavior System.Nullable<QuotationBehavior>
The QuotationBehavior.
compressionMode CompressionMode
The CompressionMode.
compressionMultiplier System.Nullable<System.Int32>
An System.Int32representing compression multiplier of the time series.
validate System.Boolean
A System.Boolean indicating whether the time series should be validated. There should be no reason to set this to false unless one deliberately attempts to create a corrupt time series.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeSeries>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created ITimeSeries.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.