Skip to content
Documentation

ICalculator Interface

Non-generic base interface used to access implementations for all types of calculations.

public interface ICalculator

ICalculator.AggregationTimeSeriesDataReadingOptions Property

Section titled “ICalculator.AggregationTimeSeriesDataReadingOptions Property”

A factory for creating the IAggregationTimeSeriesDataReadingOptions, which are used to aggregate data from multiple time series with different reading options.

HAKOM.TSM.Net.Api.Calculation.Aggregation.IAggregationTimeSeriesDataReadingOptionsFactory AggregationTimeSeriesDataReadingOptions { get; }

IAggregationTimeSeriesDataReadingOptionsFactory

A factory for creating the ICalculationOptions, which are used to read data from the time series specified in the calculation.

HAKOM.TSM.Net.Api.Calculation.ICalculationOptionsFactory CalculationOptions { get; }

ICalculationOptionsFactory

A factory for creating the ITimeSeriesDataReadingOptions which will determine, how the ITimeSeriesData<TValue> will be read after calculations are complete.

HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptionsFactory ReadingOptions { get; }

ITimeSeriesDataReadingOptionsFactory

ICalculator.Aggregate<TValue>(string, ITimeSeriesSearchParameters, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.Aggregate<TValue>(string, ITimeSeriesSearchParameters, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Aggregates multiple ITimeSeriesDataCollection<TValue> based on the provided timeSeriesSearchParameters, calculationOptions, and readingOptions.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Aggregate<TValue>(string searchRepository, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters timeSeriesSearchParameters, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

searchRepository System.String

The name of the repository where time series corresponding to the ITimeSeriesSearchParameters of timeSeriesSearchParameters are to be looked for.

timeSeriesSearchParameters ITimeSeriesSearchParameters

ITimeSeriesSearchParameters used for searching ITimeSeries that should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
A System.Threading.Tasks.Task<> containing the aggregated ITimeSeriesDataCollection<TValue>.

ICalculator.Aggregate<TValue>(string, ITimeSeriesSearchParameters, IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.Aggregate<TValue>(string, ITimeSeriesSearchParameters, IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Aggregates multiple ITimeSeriesDataCollection<TValue>from the provided timeSeriesReferences and based on the provided timeSeriesSearchParameters, calculationOptions and readingOptions.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Aggregate<TValue>(string searchRepository, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters timeSeriesSearchParameters, System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> timeSeriesReferences, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

searchRepository System.String

The name of the repository where time series corresponding to the ITimeSeriesSearchParameters of timeSeriesSearchParameters are to be looked for.

timeSeriesSearchParameters ITimeSeriesSearchParameters

ITimeSeriesSearchParameters used for searching ITimeSeries that should be aggregated.

timeSeriesReferences System.Collections.Generic.IAsyncEnumerable<ITimeSeriesReference>

A list of ITimeSeriesReference that define which ITimeSeries should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
A System.Threading.Tasks.Task<> containing the aggregated ITimeSeriesDataCollection<TValue>.

ICalculator.Aggregate<TValue>(IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.Aggregate<TValue>(IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Aggregates multiple ITimeSeriesDataCollection<TValue> based on the provided timeSeriesReferences, calculationOptions, and readingOptions.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Aggregate<TValue>(System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> timeSeriesReferences, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

timeSeriesReferences System.Collections.Generic.IAsyncEnumerable<ITimeSeriesReference>

A list of ITimeSeriesReference that defines which ITimeSeries should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
A System.Threading.Tasks.Task<> containing the aggregated ITimeSeriesDataCollection<TValue>.

ICalculator.Aggregate<TValue>(IEnumerable<IAggregationTimeSeriesDataReadingOptions>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.Aggregate<TValue>(IEnumerable<IAggregationTimeSeriesDataReadingOptions>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Aggregates multiple ITimeSeriesDataCollection<TValue> based on the provided aggregationTimeSeriesDataReadingOptions, calculationOptions, and readingOptions.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Aggregate<TValue>(System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Calculation.Aggregation.IAggregationTimeSeriesDataReadingOptions> aggregationTimeSeriesDataReadingOptions, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

aggregationTimeSeriesDataReadingOptions System.Collections.Generic.IEnumerable<IAggregationTimeSeriesDataReadingOptions>

A list of IAggregationTimeSeriesDataReadingOptions that define which ITimeSeries should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
A System.Threading.Tasks.Task<> containing the aggregated ITimeSeriesDataCollection<TValue>.

This method is similar to Aggregate<TValue>(IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) but allows to define ITimeSeriesDataReadingOptions for each ITimeSeriesReference separately.

ICalculator.Calculate<TValue>(IFormula, ICalculationOptions, ITimeSeriesDataReadingOptions, string, CancellationToken) Method

Section titled “ICalculator.Calculate<TValue>(IFormula, ICalculationOptions, ITimeSeriesDataReadingOptions, string, CancellationToken) Method”

Parses the formula, obtains the data and calculates values based on the provided options.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Calculate<TValue>(HAKOM.TSM.Net.Api.Formulas.IFormula formula, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions timeSeriesReadingOptions, string defaultRepositoryName, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

formula IFormula

An IFormula object containing the unparsed formula string.

calculationOptions ICalculationOptions

Holds default settings for reading in the data used in the calculation of the IFormula object.

timeSeriesReadingOptions ITimeSeriesDataReadingOptions

An ITimeSeriesDataReadingOptions object describing the desired properties of the return value.

defaultRepositoryName System.String

Repository which is used if the formula string does not reference a repository.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
An ITimeSeriesDataCollection<TValue> holding the resulting time series data upon calculation.

ICalculator.Calculate<TValue>(ITimeSeriesReference, ITimeSeriesDataReadingOptions, string, CancellationToken) Method

Section titled “ICalculator.Calculate<TValue>(ITimeSeriesReference, ITimeSeriesDataReadingOptions, string, CancellationToken) Method”

Parses the formula, obtains the data and calculates values based on the provided options.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>> Calculate<TValue>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions timeSeriesReadingOptions, string? defaultRepositoryName, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

timeSeriesReference ITimeSeriesReference

An ITimeSeriesReference object containing the unparsed formula as a property.

timeSeriesReadingOptions ITimeSeriesDataReadingOptions

An ITimeSeriesDataReadingOptions object describing the desired properties of the return value.

defaultRepositoryName System.String

Repository which is used if the formula string does not reference a repository.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>
An ITimeSeriesDataCollection<TValue> holding the resulting time series data upon calculation.

ICalculator.TryAggregate<TValue>(string, ITimeSeriesSearchParameters, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.TryAggregate<TValue>(string, ITimeSeriesSearchParameters, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Tries to aggregate multiple ITimeSeriesDataCollection<TValue> based on the provided timeSeriesSearchParameters, calculationOptions, and readingOptions.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryAggregate<TValue>(string searchRepository, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters timeSeriesSearchParameters, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

searchRepository System.String

The name of the repository where time series corresponding to the ITimeSeriesSearchParameters of timeSeriesSearchParameters are to be looked for.

timeSeriesSearchParameters ITimeSeriesSearchParameters

ITimeSeriesSearchParameters used for searching ITimeSeries that should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the aggregated ITimeSeriesDataCollection<TValue>.

The Result will provide additional information about success or failure of the operation.

ICalculator.TryAggregate<TValue>(string, ITimeSeriesSearchParameters, IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.TryAggregate<TValue>(string, ITimeSeriesSearchParameters, IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Tries to aggregate multiple ITimeSeriesDataCollection<TValue>from the provided timeSeriesReferences and based on the provided timeSeriesSearchParameters, calculationOptions and readingOptions.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryAggregate<TValue>(string searchRepository, HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesSearchParameters timeSeriesSearchParameters, System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> timeSeriesReferences, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

searchRepository System.String

The name of the repository where time series corresponding to the ITimeSeriesSearchParameters of timeSeriesSearchParameters are to be looked for.

timeSeriesSearchParameters ITimeSeriesSearchParameters

ITimeSeriesSearchParameters used for searching ITimeSeries that should be aggregated.

timeSeriesReferences System.Collections.Generic.IAsyncEnumerable<ITimeSeriesReference>

A list of ITimeSeriesReference that define which ITimeSeries should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the aggregated ITimeSeriesDataCollection<TValue>.

The Result will provide additional information about success or failure of the operation.

ICalculator.TryAggregate<TValue>(IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.TryAggregate<TValue>(IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Tries to aggregate multiple ITimeSeriesDataCollection<TValue> based on the provided timeSeriesReferences, calculationOptions, and readingOptions.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryAggregate<TValue>(System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference> timeSeriesReferences, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

timeSeriesReferences System.Collections.Generic.IAsyncEnumerable<ITimeSeriesReference>

A list of ITimeSeriesReference that define which ITimeSeries should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the aggregated ITimeSeriesDataCollection<TValue>.

The Result will provide additional information about success or failure of the operation.

ICalculator.TryAggregate<TValue>(IEnumerable<IAggregationTimeSeriesDataReadingOptions>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method

Section titled “ICalculator.TryAggregate<TValue>(IEnumerable<IAggregationTimeSeriesDataReadingOptions>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) Method”

Tries to aggregate multiple ITimeSeriesDataCollection<TValue> based on the provided aggregationTimeSeriesDataReadingOptions, calculationOptions, and readingOptions.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryAggregate<TValue>(System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Calculation.Aggregation.IAggregationTimeSeriesDataReadingOptions> aggregationTimeSeriesDataReadingOptions, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions readingOptions, string unitRepositoryName, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Flags.Flag>? aggregationFlagsWhiteList=null, HAKOM.TSM.Net.Api.Flags.FlagHandling flagHandling=HAKOM.TSM.Net.Api.Flags.FlagHandling.UseHighestPriority, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

aggregationTimeSeriesDataReadingOptions System.Collections.Generic.IEnumerable<IAggregationTimeSeriesDataReadingOptions>

A list of IAggregationTimeSeriesDataReadingOptions that define which ITimeSeries should be aggregated.

calculationOptions ICalculationOptions

The ICalculationOptions to apply during aggregation.

readingOptions ITimeSeriesDataReadingOptions

The ITimeSeriesDataReadingOptions, which specify the form in which the data is to be returned.

unitRepositoryName System.String

The repository name for loading units for converting the result into a specific unit.

aggregationFlagsWhiteList System.Collections.Generic.IEnumerable<Flag>

Defines which data points should be accounted for the aggregation based on their Flag. Uses all when null.

flagHandling FlagHandling

Indicates which Flag is to be used for the result when aggregating values with different Flags. By default, the Flag with the highest priority is used.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to abort the procedure.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the aggregated ITimeSeriesDataCollection<TValue>.

This method is similar to TryAggregate<TValue>(IAsyncEnumerable<ITimeSeriesReference>, ICalculationOptions, ITimeSeriesDataReadingOptions, string, IEnumerable<Flag>, FlagHandling, CancellationToken) but allows to define ITimeSeriesDataReadingOptions for each ITimeSeriesReference separately.

The Result will provide additional information about success or failure of the operation.

ICalculator.TryCalculate<TValue>(IFormula, ICalculationOptions, ITimeSeriesDataReadingOptions, string, CancellationToken) Method

Section titled “ICalculator.TryCalculate<TValue>(IFormula, ICalculationOptions, ITimeSeriesDataReadingOptions, string, CancellationToken) Method”

Parses the formula, obtains the data and calculates values based on the provided options.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryCalculate<TValue>(HAKOM.TSM.Net.Api.Formulas.IFormula formula, HAKOM.TSM.Net.Api.Calculation.ICalculationOptions calculationOptions, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions timeSeriesReadingOptions, string defaultRepositoryName, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

formula IFormula

An IFormula object containing the unparsed formula string.

calculationOptions ICalculationOptions

Holds default settings for reading in the data used in the calculation of the IFormula object.

timeSeriesReadingOptions ITimeSeriesDataReadingOptions

An ITimeSeriesDataReadingOptions object describing the desired properties of the return value.

defaultRepositoryName System.String

Repository which is used if the formula string does not reference a repository.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a ITimeSeriesDataCollection<TValue> which holds the resulting time series data upon calculation.

ICalculator.TryCalculate<TValue>(ITimeSeriesReference, ITimeSeriesDataReadingOptions, string, CancellationToken) Method

Section titled “ICalculator.TryCalculate<TValue>(ITimeSeriesReference, ITimeSeriesDataReadingOptions, string, CancellationToken) Method”

Parses the formula, obtains the data and calculates values based on the provided options.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>> TryCalculate<TValue>(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, HAKOM.TSM.Net.Api.Data.Persistence.TimeSeries.ITimeSeriesDataReadingOptions timeSeriesReadingOptions, string? defaultRepositoryName, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IComparable<TValue>, System.IEquatable<TValue>;

TValue

timeSeriesReference ITimeSeriesReference

An ITimeSeriesReference object containing the unparsed formula as a property.

timeSeriesReadingOptions ITimeSeriesDataReadingOptions

An ITimeSeriesDataReadingOptions object describing the desired properties of the return value.

defaultRepositoryName System.String

Repository which is used if the formula string does not reference a repository.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing a ITimeSeriesDataCollection<TValue> which holds the resulting time series data upon calculation.

© 2026 Volue.Version v0.6.38017 November 2026