ITimeSeriesReferenceFactory<TIdentifier> Interface
HAKOM.TSM.Net.Api.TimeSeries.Persistence.References
Section titled “HAKOM.TSM.Net.Api.TimeSeries.Persistence.References”A factory for creating ITimeSeriesReference<TIdentifier>.
public interface ITimeSeriesReferenceFactory<TIdentifier> where TIdentifier : System.IEquatable<TIdentifier>Type parameters
Section titled “Type parameters”TIdentifier
The type of the identifier for the ITimeSeriesReference<TIdentifier>.
Methods
Section titled “Methods”ITimeSeriesReferenceFactory<TIdentifier>.Configure(ITimeSeriesStore<TIdentifier>) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.Configure(ITimeSeriesStore<TIdentifier>) Method”Configures the ITimeSeriesReferenceFactory<TIdentifier> for usage.
void Configure(HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesStore<TIdentifier> timeSeriesStore);Parameters
Section titled “Parameters”timeSeriesStore HAKOM.TSM.Net.Api.TimeSeries.Persistence.ITimeSeriesStore<TIdentifier>
The ITimeSeriesStore<TIdentifier> for loading the references.
ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier) Method”Creates a ITimeSeriesReference<TIdentifier> with the specified identifier.
HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier> Create(TIdentifier identifier);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>
The created ITimeSeriesReference<TIdentifier>.
ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier, ITimeSeries) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier, ITimeSeries) Method”Creates a ITimeSeriesReference<TIdentifier> with the specified identifier.
HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier> Create(TIdentifier identifier, HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
timeSeries ITimeSeries
The ITimeSeries associated with the reference.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>
The created ITimeSeriesReference<TIdentifier>.
ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier, ITimeSeries, IStorageInformation) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier, ITimeSeries, IStorageInformation) Method”Creates a ITimeSeriesReference<TIdentifier> with the specified identifier.
HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier> Create(TIdentifier identifier, HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
timeSeries ITimeSeries
The ITimeSeries associated with the reference.
dataStorageInformation IStorageInformation
The IStorageInformation associated with the data storage.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>
The created ITimeSeriesReference<TIdentifier>.
ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier, ITimeSeries, IStorageInformation, IEnumerable<IAssignedAttributeData>) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.Create(TIdentifier, ITimeSeries, IStorageInformation, IEnumerable<IAssignedAttributeData>) Method”Creates an ITimeSeriesReference<TIdentifier> with the specified identifier, storage information and assigned attribute data.
HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier> Create(TIdentifier identifier, HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.IAssignedAttributeData> assignedAttributeData);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
timeSeries ITimeSeries
The ITimeSeries associated with the reference.
dataStorageInformation IStorageInformation
The IStorageInformation associated with the data storage.
assignedAttributeData System.Collections.Generic.IEnumerable<IAssignedAttributeData>
The System.Collections.Generic.IEnumerable<> containing the assigned attributes and their related data.
Returns
Section titled “Returns”HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>
The created ITimeSeriesReference<TIdentifier> including assigned attribute data.
ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier) Method”Tries to create a ITimeSeriesReference<TIdentifier> with the specified identifier.
HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>> TryCreate(TIdentifier identifier);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>>
A Result<TValue> of the created ITimeSeriesReference<TIdentifier>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier, ITimeSeries) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier, ITimeSeries) Method”Tries to create a ITimeSeriesReference<TIdentifier> with the specified identifier.
HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>> TryCreate(TIdentifier identifier, HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
timeSeries ITimeSeries
The ITimeSeries associated with the reference.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>>
A Result<TValue> of the created ITimeSeriesReference<TIdentifier>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier, ITimeSeries, IStorageInformation) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier, ITimeSeries, IStorageInformation) Method”Tries to create a ITimeSeriesReference<TIdentifier> with the specified identifier.
HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>> TryCreate(TIdentifier identifier, HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
timeSeries ITimeSeries
The ITimeSeries associated with the reference.
dataStorageInformation IStorageInformation
The IStorageInformation associated with the data storage.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>>
A Result<TValue> of the created ITimeSeriesReference<TIdentifier>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier, ITimeSeries, IStorageInformation, IEnumerable<IAssignedAttributeData>) Method
Section titled “ITimeSeriesReferenceFactory<TIdentifier>.TryCreate(TIdentifier, ITimeSeries, IStorageInformation, IEnumerable<IAssignedAttributeData>) Method”Attempts to create an ITimeSeriesReference<TIdentifier> with the specified identifier, storage information and assigned attribute data.
HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>> TryCreate(TIdentifier identifier, HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries, HAKOM.Persistence.Core.Net.Api.Storage.IStorageInformation dataStorageInformation, System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.IAssignedAttributeData> assignedAttributeData);Parameters
Section titled “Parameters”identifier TIdentifier
The identifier for the ITimeSeriesReference<TIdentifier>.
timeSeries ITimeSeries
The ITimeSeries associated with the reference.
dataStorageInformation IStorageInformation
The IStorageInformation associated with the data storage.
assignedAttributeData System.Collections.Generic.IEnumerable<IAssignedAttributeData>
The System.Collections.Generic.IEnumerable<> containing the assigned attributes and their related data.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.TimeSeries.Persistence.References.ITimeSeriesReference<TIdentifier>>
A Result<TValue> of the created ITimeSeriesReference<TIdentifier>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.