ITimeDependentUnitConversionFactory Interface
A factory for creating time dependent unit conversions.
public interface ITimeDependentUnitConversionFactoryMethods
Section titled “Methods”ITimeDependentUnitConversionFactory.Create(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionFactory.Create(ITimeSeriesReference, CancellationToken) Method”Creates an instance of an ITimeDependentUnitConversion for the specified timeSeriesReference.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion> Create(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The time series from which the new ITimeDependentUnitConversion object will be created.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<ITimeDependentUnitConversion>
A new ITimeDependentUnitConversion object created from the time series or null if the given time series is not a conversion time series.
ITimeDependentUnitConversionFactory.TryCreate(ITimeSeriesReference, CancellationToken) Method
Section titled “ITimeDependentUnitConversionFactory.TryCreate(ITimeSeriesReference, CancellationToken) Method”Tries to create an instance of an ITimeDependentUnitConversion for the specified timeSeriesReference.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Units.ITimeDependentUnitConversion>> TryCreate(HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference timeSeriesReference, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”timeSeriesReference ITimeSeriesReference
The time series from which the new ITimeDependentUnitConversion object will be created.
cancellationToken System.Threading.CancellationToken
A token that may be used to cancel the operation.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<ITimeDependentUnitConversion>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created ITimeDependentUnitConversion
from the time series when it is a conversion time series.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.