ICustomFunctionContext<TValue> Interface
HAKOM.TSM.Net.Api.Calculation.Formulas.CustomFunctions
Section titled “HAKOM.TSM.Net.Api.Calculation.Formulas.CustomFunctions”Facility for providing formula and computation properties necessary for the calculation of a custom function.
public interface ICustomFunctionContext<TValue> where TValue : System.IEquatable<TValue>, System.IComparable<TValue>Type parameters
Section titled “Type parameters”TValue
The type of the value of the data.
Properties
Section titled “Properties”ICustomFunctionContext<TValue>.ArithmeticOperations Property
Section titled “ICustomFunctionContext<TValue>.ArithmeticOperations Property”Facility for executing arithmetic operations.
HAKOM.TSM.Net.Api.Data.TimeSeries.Math.IArithmeticOperations<TValue> ArithmeticOperations { get; }Property Value
Section titled “Property Value”HAKOM.TSM.Net.Api.Data.TimeSeries.Math.IArithmeticOperations<TValue>
ICustomFunctionContext<TValue>.CalculationOptions Property
Section titled “ICustomFunctionContext<TValue>.CalculationOptions Property”Settings for reading in the data used in the calculation of the IFormula object. Applied to the time series that are referenced from the formula string an not to the root time series.
HAKOM.TSM.Net.Api.Calculation.ICalculationOptions CalculationOptions { get; }Property Value
Section titled “Property Value”ICustomFunctionContext<TValue>.ReadingOptions Property
Section titled “ICustomFunctionContext<TValue>.ReadingOptions Property”AnITimeSeriesDataReadingOptions object describing the desired properties of the return value.
HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions ReadingOptions { get; }Property Value
Section titled “Property Value”ICustomFunctionContext<TValue>.RootTimeSeriesReference Property
Section titled “ICustomFunctionContext<TValue>.RootTimeSeriesReference Property”Time series to which the IFormula object was assigned as a property.
HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference? RootTimeSeriesReference { get; }Property Value
Section titled “Property Value”ICustomFunctionContext<TValue>.SourceTimeSeries Property
Section titled “ICustomFunctionContext<TValue>.SourceTimeSeries Property”Contains all time series referenced in the IFormula object. Time series appear in the order in which they are found in the formula string.
System.Collections.Generic.IDictionary<int,HAKOM.TSM.Net.Api.Calculation.ITimeSeriesReferenceWithData<TValue>> SourceTimeSeries { get; }Property Value
Section titled “Property Value”System.Collections.Generic.IDictionary<System.Int32,HAKOM.TSM.Net.Api.Calculation.ITimeSeriesReferenceWithData<TValue>>
ICustomFunctionContext<TValue>.TimeSeriesDataFactory Property
Section titled “ICustomFunctionContext<TValue>.TimeSeriesDataFactory Property”Facility for creating objects representing time series data.
HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataFactory TimeSeriesDataFactory { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”ICustomFunctionContext<TValue>.CreateResult(DateTimeOffset, ITimeSeriesData<TValue>) Method
Section titled “ICustomFunctionContext<TValue>.CreateResult(DateTimeOffset, ITimeSeriesData<TValue>) Method”Converts the given data to the return type to ITimeSeriesData<TValue>.
HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue> CreateResult(System.DateTimeOffset calculationTime, HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue> data);Parameters
Section titled “Parameters”calculationTime System.DateTimeOffset
The time of the ITimeSeriesData<TValue>.
data HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>
The value of the ITimeSeriesData<TValue>.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>
An ITimeSeriesData<TValue>.
ICustomFunctionContext<TValue>.CreateResult(DateTimeOffset, TValue) Method
Section titled “ICustomFunctionContext<TValue>.CreateResult(DateTimeOffset, TValue) Method”Converts the given data to the return type to ITimeSeriesData<TValue>.
HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue> CreateResult(System.DateTimeOffset calculationTime, TValue data);Parameters
Section titled “Parameters”calculationTime System.DateTimeOffset
The time of the ITimeSeriesData<TValue>.
data TValue
The value of the ITimeSeriesData<TValue>.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesData<TValue>
An ITimeSeriesData<TValue>.
ICustomFunctionContext<TValue>.GetService<TService>() Method
Section titled “ICustomFunctionContext<TValue>.GetService<TService>() Method”Gets an instance of the given TService from the IActivatedContainer.
TService GetService<TService>() where TService : notnull;Type parameters
Section titled “Type parameters”TService
Signifies which service to get.
Returns
Section titled “Returns”TService
An instance of the desired service.
ICustomFunctionContext<TValue>.TryGetService<TService>() Method
Section titled “ICustomFunctionContext<TValue>.TryGetService<TService>() Method”Attempts to get an instance of the given TService from the IActivatedContainer.
HAKOM.ErrorHandling.Core.Net.Api.Result<TService> TryGetService<TService>() where TService : notnull;Type parameters
Section titled “Type parameters”TService
Signifies which service to get.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<TService>
A Result<TValue> containing the desired service, if successful and an exception, if not.