ICalculationOptions Interface
Holds properties for the calculation of IFormulas. These properties will influence the calculation and how the referenced ITimeSeries will be read for the calculation.
public interface ICalculationOptionsProperties
Section titled “Properties”ICalculationOptions.Cyclic Property
Section titled “ICalculationOptions.Cyclic Property”Gets a System.Boolean indicating whether calculation of the values is performed cyclic along the time axis or not.
bool Cyclic { get; }Property Value
Section titled “Property Value”ICalculationOptions.Function Property
Section titled “ICalculationOptions.Function Property”Gets the FunctionType specifying how values are applied along the time axis.
HAKOM.TSM.Net.Api.TimeSeries.FunctionType Function { get; }Property Value
Section titled “Property Value”ICalculationOptions.Interval Property
Section titled “ICalculationOptions.Interval Property”Gets the interval determining how the referenced data should be read and the calculation should be performed.
HAKOM.TSM.Net.Api.Time.Intervals.IInterval Interval { get; }Property Value
Section titled “Property Value”ICalculationOptions.IntervalTransformationMethod Property
Section titled “ICalculationOptions.IntervalTransformationMethod Property”Gets the interval transformation method that is used to transform the calculated data to the specified IInterval.
System.Nullable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> IntervalTransformationMethod { get; }Property Value
Section titled “Property Value”System.Nullable<IntervalTransformationMethod>
ICalculationOptions.StartOfTime Property
Section titled “ICalculationOptions.StartOfTime Property”Gets the System.DateTimeOffset representing the start time of the calculation data mesh.
System.DateTimeOffset StartOfTime { get; }Property Value
Section titled “Property Value”ICalculationOptions.TimeZone Property
Section titled “ICalculationOptions.TimeZone Property”Gets the ITimeZone in which the calculation should take place.
HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone TimeZone { get; }Property Value
Section titled “Property Value”ICalculationOptions.Unit Property
Section titled “ICalculationOptions.Unit Property”Gets a reference to the unit determining how the referenced data should be read.
HAKOM.TSM.Net.Api.Units.Persistence.References.IUnitReference? Unit { get; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”This can be overwritten by suppling a unit with the referenced ITimeSeries in the IFormula.