IFormula Interface
Used to create time series which have data based on calculation rather than explicit values.
public interface IFormula : System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.DateTimeOffset, string?>>, System.Collections.IEnumerable, System.IEquatable<HAKOM.TSM.Net.Api.Formulas.IFormula>Implements System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.DateTimeOffset,System.String>>, System.Collections.IEnumerable, System.IEquatable<IFormula>
Methods
Section titled “Methods”IFormula.GetFormula(DateTimeOffset) Method
Section titled “IFormula.GetFormula(DateTimeOffset) Method”Gets the formula which should be used for any time along the series at or following the given date/time.
string? GetFormula(System.DateTimeOffset at);Parameters
Section titled “Parameters”The date/time along the series at which this formula becomes effective.
Returns
Section titled “Returns”System.String
The formula
IFormula.SetFormula(DateTimeOffset, string) Method
Section titled “IFormula.SetFormula(DateTimeOffset, string) Method”Sets the formula which should be used for any time along the series at or following the given date/time.
void SetFormula(System.DateTimeOffset at, string? formula);Parameters
Section titled “Parameters”The date/time along the series at which this formula becomes effective.
formula System.String
The formula which should be used following the given date/time.
IFormula.TryRemove(DateTimeOffset, string) Method
Section titled “IFormula.TryRemove(DateTimeOffset, string) Method”Attempts to remove a formula.
bool TryRemove(System.DateTimeOffset at, out string? formula);Parameters
Section titled “Parameters”The System.DateTimeOffset at which the formula is valid.
formula System.String
The System.String formula that was removed.
Returns
Section titled “Returns”System.Boolean
True if the formula could be removed.