ITimeDependentUnitConversionStore Interface
A store to find conversion time series. Should only be instantiated by an ITimeDependentUnitConversionStoreFactory.
public interface ITimeDependentUnitConversionStore : HAKOM.Persistence.Core.Net.Api.Storage.IStore<HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider>Implements HAKOM.Persistence.Core.Net.Api.Storage.IStore<IStorageProvider>
Methods
Section titled “Methods”ITimeDependentUnitConversionStore.Configure(IStorageProvider, IUnitStore, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.Configure(IStorageProvider, IUnitStore, CancellationToken) Method”Configures the dependent unit conversion store with the given parameters.
System.Threading.Tasks.Task Configure(HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider storageProvider, HAKOM.TSM.Net.Api.Units.Persistence.IUnitStore unitStore, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”storageProvider IStorageProvider
The IStorageProvider used for read and write operations on the storage.
unitStore IUnitStore
The IUnitStore used for creating unit references.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task representing the asynchronous operation.
ITimeDependentUnitConversionStore.Delete(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.Delete(ITimeSeriesReference, CancellationToken) Method”Removes a given timeSeriesReference from default conversion time series.
System.Threading.Tasks.Task Delete(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to to be removed from default conversion time series. The time series itself will not be deleted.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A task that finishes when the timeSeriesReference is removed from default conversion time series.
ITimeDependentUnitConversionStore.Find(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.Find(ITimeSeriesReference, CancellationToken) Method”Gets conversion time series of a given timeSeriesReference.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion> Find(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to load the assigned conversion time series from.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<ITimeDependentUnitConversion>
A System.Collections.Generic.IAsyncEnumerable<> with all conversion time series of timeSeriesReference.
ITimeDependentUnitConversionStore.Find(CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.Find(CancellationToken) Method”Gets default conversion time series which are configured to be used without assignment to a time series.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion> Find(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<ITimeDependentUnitConversion>
A System.Collections.Generic.IAsyncEnumerable<> with all default conversion time series.
ITimeDependentUnitConversionStore.FindAll(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.FindAll(ITimeSeriesReference, CancellationToken) Method”Gets all conversion time series which can be used for a conversion. This includes conversion time series of a given timeSeriesReference and the default conversion time series.
System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion> FindAll(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to load the assigned conversion time series from.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<ITimeDependentUnitConversion>
A System.Collections.Generic.IAsyncEnumerable<> with all conversion time series of timeSeriesReference
and default conversion time series.
ITimeDependentUnitConversionStore.Save(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.Save(ITimeSeriesReference, CancellationToken) Method”Sets a given timeSeriesReference to a default conversion time series and saves the configuration.
System.Threading.Tasks.Task Save(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to to be set as default conversion time series. The time series must already be saved.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A task that finishes when the timeSeriesReference is saved as default conversion time series.
ITimeDependentUnitConversionStore.TryDelete(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.TryDelete(ITimeSeriesReference, CancellationToken) Method”Removes a given timeSeriesReference from default conversion time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to to be removed from default conversion time series. The time series itself will not be deleted.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
An awaitable System.Threading.Tasks.Task<> of Result that finishes when the
timeSeriesReference is removed from default conversion time series.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeDependentUnitConversionStore.TryFind(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.TryFind(ITimeSeriesReference, CancellationToken) Method”Gets conversion time series of a given timeSeriesReference.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion>> TryFind(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to load the assigned conversion time series from.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeDependentUnitConversion>>
An System.Collections.Generic.IAsyncEnumerable<> with all conversion time series of timeSeriesReference in the form of Result<TValue>.
ITimeDependentUnitConversionStore.TryFind(CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.TryFind(CancellationToken) Method”Gets default conversion time series which are configured to be used without assignment to a time series.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion>> TryFind(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeDependentUnitConversion>>
An System.Collections.Generic.IAsyncEnumerable<> with all default conversion time series in the form of Result<TValue>.
ITimeDependentUnitConversionStore.TryFindAll(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.TryFindAll(ITimeSeriesReference, CancellationToken) Method”Gets all conversion time series which can be used for a conversion. This includes conversion time series of a given timeSeriesReference and the default conversion time series.
System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion>> TryFindAll(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to load the assigned conversion time series from.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeDependentUnitConversion>>
An System.Collections.Generic.IAsyncEnumerable<> with all conversion time series of timeSeriesReference
and default conversion time series represented as Result<TValue>.
ITimeDependentUnitConversionStore.TrySave(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionStore.TrySave(ITimeSeriesReference, CancellationToken) Method”Sets a given timeSeriesReference to a default conversion time series and saves the configuration.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TrySave(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The ITimeSeriesReference to to be set as default conversion time series. The time series must already be saved.
cancellationToken System.Threading.CancellationToken
Propagates a notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
An awaitable System.Threading.Tasks.Task<> of Result that finishes when the
timeSeriesReference is saved as default conversion time series.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.