IFormulaFactory Interface
Used to create formulas that dynamically calculate time series data.
public interface IFormulaFactoryRemarks
Section titled “Remarks”Formulas are one or more expressions that define the data along a time series.
Each expression within the formula is applied to the time series starting from a specific date/time and is valid until it is succeeded by another expression.
Expressions along with their date/time of when they are applied are referred to as formula slices.
Methods
Section titled “Methods”IFormulaFactory.Create((DateTimeOffset ValidFrom,string Formula)[]) Method
Section titled “IFormulaFactory.Create((DateTimeOffset ValidFrom,string Formula)[]) Method”HAKOM.TSM.Net.Api.Formulas.IFormula Create(params (System.DateTimeOffset ValidFrom,string Formula)[] slices);Parameters
Section titled “Parameters”slices <System.DateTimeOffset,System.String>[]
Returns
Section titled “Returns”IFormulaFactory.Create(string) Method
Section titled “IFormulaFactory.Create(string) Method”Creates a formula with a single expression that is valid starting on January 1st 1972 at 00:00h UTC+1 along the time series.
HAKOM.TSM.Net.Api.Formulas.IFormula Create(string formula);Parameters
Section titled “Parameters”formula System.String
The expression to use for calculation
Returns
Section titled “Returns”IFormula
The formula
IFormulaFactory.Create(IEnumerable<(DateTimeOffset ValidFrom,string Formula)>) Method
Section titled “IFormulaFactory.Create(IEnumerable<(DateTimeOffset ValidFrom,string Formula)>) Method”HAKOM.TSM.Net.Api.Formulas.IFormula Create(System.Collections.Generic.IEnumerable<(System.DateTimeOffset ValidFrom,string Formula)> slices);Parameters
Section titled “Parameters”slices System.Collections.Generic.IEnumerable<<System.DateTimeOffset,System.String>>
Returns
Section titled “Returns”IFormulaFactory.Create(IEnumerable<KeyValuePair<DateTimeOffset,string>>) Method
Section titled “IFormulaFactory.Create(IEnumerable<KeyValuePair<DateTimeOffset,string>>) Method”Creates a formula with multiple expressions valid starting on the date given for each one along the time series.
HAKOM.TSM.Net.Api.Formulas.IFormula Create(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.DateTimeOffset,string?>> slices);Parameters
Section titled “Parameters”slices System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.DateTimeOffset,System.String>>
The expressions to use for calculation along with a date/time specifying their validity along the time series
Returns
Section titled “Returns”IFormula
The formula
IFormulaFactory.Create(KeyValuePair<DateTimeOffset,string>[]) Method
Section titled “IFormulaFactory.Create(KeyValuePair<DateTimeOffset,string>[]) Method”Creates a formula with multiple expressions valid starting on the date given for each one along the time series.
HAKOM.TSM.Net.Api.Formulas.IFormula Create(params System.Collections.Generic.KeyValuePair<System.DateTimeOffset,string?>[] slices);Parameters
Section titled “Parameters”slices System.Collections.Generic.KeyValuePair<System.DateTimeOffset,System.String>[]
The expressions to use for calculation along with a date/time specifying their validity along the time series
Returns
Section titled “Returns”IFormula
The formula
IFormulaFactory.Create(DateTimeOffset, string) Method
Section titled “IFormulaFactory.Create(DateTimeOffset, string) Method”Creates a formula that is valid starting on the given date along the time series.
HAKOM.TSM.Net.Api.Formulas.IFormula Create(System.DateTimeOffset validFrom, string formula);Parameters
Section titled “Parameters”validFrom System.DateTimeOffset
Time along the series from which the formula should be used
formula System.String
The expression to use for calculation
Returns
Section titled “Returns”IFormula
The formula