ICalculationOptionsFactory Interface
Options for reading in time series data used in the calculation.
public interface ICalculationOptionsFactoryMethods
Section titled “Methods”ICalculationOptionsFactory.Create(bool, FunctionType, IInterval, Nullable<IntervalTransformationMethod>, IUnitReference, ITimeZone, Nullable<DateTimeOffset>) Method
Section titled “ICalculationOptionsFactory.Create(bool, FunctionType, IInterval, Nullable<IntervalTransformationMethod>, IUnitReference, ITimeZone, Nullable<DateTimeOffset>) Method”Contains options for calculations with time series data.
HAKOM.TSM.Net.Api.Calculation.ICalculationOptions Create(bool cyclic, HAKOM.TSM.Net.Api.TimeSeries.FunctionType function, HAKOM.TSM.Net.Api.Time.Intervals.IInterval interval, System.Nullable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> intervalTransformationMethod=null, HAKOM.TSM.Net.Api.Units.Persistence.References.IUnitReference? unit=null, HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone? timeZone=null, System.Nullable<System.DateTimeOffset> startOfTime=null);Parameters
Section titled “Parameters”cyclic System.Boolean
Gets or sets a System.Boolean indicating whether the values along the time axis are cyclic or not.
function FunctionType
Gets or sets the FunctionType specifying how values are applied along the time axis.
interval IInterval
IInterval of the data in the computed result.
intervalTransformationMethod System.Nullable<IntervalTransformationMethod>
IntervalTransformationMethod that is used to transform the data to the specified IInterval.
unit IUnitReference
Reference to the unit of the data in the computed result.
timeZone ITimeZone
Sets the ITimeZone property of the resulting ICalculationOptions object. If the given timeZone is null, the default value will be used.
startOfTime System.Nullable<System.DateTimeOffset>
Sets the startOfTime of the resulting ICalculationOptions object. If the given startOfTime is null, the default value will be used.
Returns
Section titled “Returns”ICalculationOptions
An ICalculationOptions object.