IAttributeDataStore Interface
HAKOM.TSM.Net.Api.Data.Persistence.Attributes
Section titled “HAKOM.TSM.Net.Api.Data.Persistence.Attributes”Used to read and write attribute data.
public interface IAttributeDataStoreMethods
Section titled “Methods”IAttributeDataStore.Configure(IStorageProvider, ITimeSeriesAssignmentReference<IAttribute>, CancellationToken) Method
Section titled “IAttributeDataStore.Configure(IStorageProvider, ITimeSeriesAssignmentReference<IAttribute>, CancellationToken) Method”Configures the data store with the given parameters.
System.Threading.Tasks.Task Configure(HAKOM.Persistence.Core.Net.Api.Storage.IStorageProvider storageProvider, HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<HAKOM.TSM.Net.Api.Attributes.IAttribute> assignedAttribute, 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.
assignedAttribute HAKOM.TSM.Net.Api.TimeSeries.Persistence.Assignment.References.ITimeSeriesAssignmentReference<IAttribute>
The ITimeSeriesAssignmentReference<TAssigned> which contains the IAttribute whose data will be read or written.
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 indicating the configuration is complete.
IAttributeDataStore.Delete(CancellationToken) Method
Section titled “IAttributeDataStore.Delete(CancellationToken) Method”Deletes all attribute data of the configured time series attribute assignment.
System.Threading.Tasks.Task Delete(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
Propagates notification if the operation should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.
IAttributeDataStore.Read(Period, CancellationToken) Method
Section titled “IAttributeDataStore.Read(Period, CancellationToken) Method”Reads attribute data from the configured time series within the given period.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<string?>> Read(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”period Period
The time Period from which to read the data.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<System.String>>
An ITimeSeriesDataCollection<TValue> representing the read data.
IAttributeDataStore.ReadNodeAssignment(Period, CancellationToken) Method
Section titled “IAttributeDataStore.ReadNodeAssignment(Period, CancellationToken) Method”Reads node data from the configured attribute and time series within the given period.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference?>> ReadNodeAssignment(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”period Period
The time Period from which to read the data.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<INodeReference>>
An ITimeSeriesDataCollection<TValue> representing the read data.
IAttributeDataStore.ReadSlices(Period, CancellationToken) Method
Section titled “IAttributeDataStore.ReadSlices(Period, CancellationToken) Method”Reads attribute data from the configured time series within the given period as an ordered map of timestamps to values.
System.Threading.Tasks.Task<HAKOM.TSM.Net.Api.Data.Attributes.IAttributeDataCollection> ReadSlices(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”period Period
The time Period from which to read the data.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<IAttributeDataCollection>
An IAttributeDataCollection representing the read data.
IAttributeDataStore.TryDelete(CancellationToken) Method
Section titled “IAttributeDataStore.TryDelete(CancellationToken) Method”Attempts to delete all attribute data of the configured time series attribute assignment.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryDelete(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryRead(Period, CancellationToken) Method
Section titled “IAttributeDataStore.TryRead(Period, CancellationToken) Method”Attempts to read attribute data from the configured time series within the given period.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<string?>>> TryRead(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”period Period
The time Period from which to read the data.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<System.String>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created
ITimeSeriesDataCollection<TValue>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryReadNodeAssignment(Period, CancellationToken) Method
Section titled “IAttributeDataStore.TryReadNodeAssignment(Period, CancellationToken) Method”Attempts to read node data from the configured attribute and time series within the given period.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference?>>> TryReadNodeAssignment(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”period Period
The time Period from which to read the data.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<INodeReference>>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created
ITimeSeriesDataCollection<TValue>.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryReadSlices(Period, CancellationToken) Method
Section titled “IAttributeDataStore.TryReadSlices(Period, CancellationToken) Method”Attempts to read attribute data from the configured time series within the given period as an ordered map of timestamps to values.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.Attributes.IAttributeDataCollection>> TryReadSlices(HAKOM.TSM.Net.Api.Time.Periods.Period period, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”period Period
The time Period from which to read the data.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result<IAttributeDataCollection>>
A System.Threading.Tasks.Task<> of Result<TValue> containing the created
IAttributeDataCollection, or an error.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryWrite(ITimeSeriesDataCollection<string>, CancellationToken) Method
Section titled “IAttributeDataStore.TryWrite(ITimeSeriesDataCollection<string>, CancellationToken) Method”Attempts to write attribute data to the configured time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWrite(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<string?> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”data HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<System.String>
The attribute data which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryWrite(string, CancellationToken) Method
Section titled “IAttributeDataStore.TryWrite(string, CancellationToken) Method”Attempts to write attribute data to the configured time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWrite(string? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”value System.String
The attribute which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operation should be cancelled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”It will write to the configured StartOfTime.
The Result will provide additional information about success or failure.
IAttributeDataStore.TryWrite(DateTimeOffset, string, CancellationToken) Method
Section titled “IAttributeDataStore.TryWrite(DateTimeOffset, string, CancellationToken) Method”Attempts to write attribute data to the configured time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWrite(System.DateTimeOffset time, string? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”The point of time the attribute will be written to.
value System.String
The attribute which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operation should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryWriteNodeAssignment(INodeReference, CancellationToken) Method
Section titled “IAttributeDataStore.TryWriteNodeAssignment(INodeReference, CancellationToken) Method”Attempts to write node data to the configured attribute and time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWriteNodeAssignment(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”value INodeReference
The node which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operation should be cancelled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”It will write to the configured StartOfTime.
The Result will provide additional information about success or failure.
IAttributeDataStore.TryWriteNodeAssignment(ITimeSeriesDataCollection<INodeReference>, CancellationToken) Method
Section titled “IAttributeDataStore.TryWriteNodeAssignment(ITimeSeriesDataCollection<INodeReference>, CancellationToken) Method”Attempts to write node data to the configured attribute and time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWriteNodeAssignment(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference?> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”data HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<INodeReference>
The node data which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryWriteNodeAssignment(DateTimeOffset, INodeReference, CancellationToken) Method
Section titled “IAttributeDataStore.TryWriteNodeAssignment(DateTimeOffset, INodeReference, CancellationToken) Method”Attempts to write node data to the configured attribute and time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWriteNodeAssignment(System.DateTimeOffset time, HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”The point of time the attribute will be written to.
value INodeReference
The node which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operation should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.TryWriteSlices(IAttributeDataCollection, CancellationToken) Method
Section titled “IAttributeDataStore.TryWriteSlices(IAttributeDataCollection, CancellationToken) Method”Attempts to write attribute data to the configured time series.
System.Threading.Tasks.Task<HAKOM.ErrorHandling.Core.Net.Api.Result> TryWriteSlices(HAKOM.TSM.Net.Api.Data.Attributes.IAttributeDataCollection data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”The attribute data which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task<Result>
A System.Threading.Tasks.Task<> indicating the operation was completed.
Remarks
Section titled “Remarks”The Result will provide additional information about success or failure.
IAttributeDataStore.Write(ITimeSeriesDataCollection<string>, CancellationToken) Method
Section titled “IAttributeDataStore.Write(ITimeSeriesDataCollection<string>, CancellationToken) Method”Writes attribute data to the configured time series.
System.Threading.Tasks.Task Write(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<string?> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”data HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<System.String>
The attribute data which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.
IAttributeDataStore.Write(string, CancellationToken) Method
Section titled “IAttributeDataStore.Write(string, CancellationToken) Method”Writes attribute data to the configured time series.
System.Threading.Tasks.Task Write(string? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”value System.String
The attribute which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operation should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.
Remarks
Section titled “Remarks”It will write to the configured StartOfTime.
IAttributeDataStore.Write(DateTimeOffset, string, CancellationToken) Method
Section titled “IAttributeDataStore.Write(DateTimeOffset, string, CancellationToken) Method”Writes attribute data to the configured time series.
System.Threading.Tasks.Task Write(System.DateTimeOffset time, string? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”The point of time the attribute will be written to.
value System.String
The attribute which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.
IAttributeDataStore.WriteNodeAssignment(INodeReference, CancellationToken) Method
Section titled “IAttributeDataStore.WriteNodeAssignment(INodeReference, CancellationToken) Method”Writes node data to the configured attribute and time series.
System.Threading.Tasks.Task WriteNodeAssignment(HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”value INodeReference
The node which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operation should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.
Remarks
Section titled “Remarks”It will write to the configured StartOfTime.
IAttributeDataStore.WriteNodeAssignment(ITimeSeriesDataCollection<INodeReference>, CancellationToken) Method
Section titled “IAttributeDataStore.WriteNodeAssignment(ITimeSeriesDataCollection<INodeReference>, CancellationToken) Method”Writes node data to the configured attribute and time series.
System.Threading.Tasks.Task WriteNodeAssignment(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference?> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”data HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<INodeReference>
The node data which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.
IAttributeDataStore.WriteNodeAssignment(DateTimeOffset, INodeReference, CancellationToken) Method
Section titled “IAttributeDataStore.WriteNodeAssignment(DateTimeOffset, INodeReference, CancellationToken) Method”Writes node data to the configured attribute and time series.
System.Threading.Tasks.Task WriteNodeAssignment(System.DateTimeOffset time, HAKOM.TSM.Net.Api.Attributes.Nodes.Persistence.References.INodeReference? value, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”The point of time the attribute will be written to.
value INodeReference
The node which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.
IAttributeDataStore.WriteSlices(IAttributeDataCollection, CancellationToken) Method
Section titled “IAttributeDataStore.WriteSlices(IAttributeDataCollection, CancellationToken) Method”Writes attribute data to the configured time series.
System.Threading.Tasks.Task WriteSlices(HAKOM.TSM.Net.Api.Data.Attributes.IAttributeDataCollection data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));Parameters
Section titled “Parameters”The attribute data which will be written.
cancellationToken System.Threading.CancellationToken
Propagates notification if the operations should be canceled.
Returns
Section titled “Returns”System.Threading.Tasks.Task
A System.Threading.Tasks.Task indicating the operation was completed.