Skip to content
Documentation

IBlockCompressor Interface

Packs and unpacks the data of ITimeSeriesDataCollection<TValue> into blocks of ITimeSeriesBlockData<TValue> where the block size depends on the CompressionMultiplier of the given ITimeSeries.

public interface IBlockCompressor

IBlockCompressor.Compress<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method

Section titled “IBlockCompressor.Compress<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method”

Packs the data of ITimeSeriesDataCollection<TValue> into blocks of ITimeSeriesBlockData<TValue>.

System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ITimeSeriesBlockData<TValue>> Compress<TValue>(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IEquatable<TValue>, System.IComparable<TValue>;

TValue

The type of the value of the time series data.

data HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>

The data to be packed to System.Collections.Generic.IAsyncEnumerable<>.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ITimeSeriesBlockData<TValue>>
An System.Collections.Generic.IAsyncEnumerable<> of ITimeSeriesBlockData<TValue> containing data with an interval using the CompressionMultiplier. One block contains values and flags in the interval of the configured time series.

IBlockCompressor.Configure(ITimeSeries) Method

Section titled “IBlockCompressor.Configure(ITimeSeries) Method”

Configures the IBlockCompressor with the time series for which data the blocks should be created.

void Configure(HAKOM.TSM.Net.Api.TimeSeries.ITimeSeries timeSeries);

timeSeries ITimeSeries

IBlockCompressor.Decompress<TValue>(IAsyncEnumerable<ITimeSeriesBlockData<TValue>>, CancellationToken) Method

Section titled “IBlockCompressor.Decompress<TValue>(IAsyncEnumerable<ITimeSeriesBlockData<TValue>>, CancellationToken) Method”

Unpacks the data of an System.Collections.Generic.IAsyncEnumerable<> of ITimeSeriesBlockData<TValue> to an ITimeSeriesDataCollection<TValue>.

HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> Decompress<TValue>(System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ITimeSeriesBlockData<TValue>> blockData, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IEquatable<TValue>, System.IComparable<TValue>;

TValue

The type of the value of the time series data.

blockData System.Collections.Generic.IAsyncEnumerable<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ITimeSeriesBlockData<TValue>>

The data to be unpacked to ITimeSeriesDataCollection<TValue>.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>
An ITimeSeriesDataCollection<TValue> containing the unpacked data from an System.Collections.Generic.IAsyncEnumerable<> of ITimeSeriesBlockData<TValue>

IBlockCompressor.TryCompress<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method

Section titled “IBlockCompressor.TryCompress<TValue>(ITimeSeriesDataCollection<TValue>, CancellationToken) Method”

Packs the data of ITimeSeriesDataCollection<TValue> into blocks of ITimeSeriesBlockData<TValue>.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ITimeSeriesBlockData<TValue>>> TryCompress<TValue>(HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue> data, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
where TValue : System.IEquatable<TValue>, System.IComparable<TValue>;

TValue

The type of the value of the time series data.

data HAKOM.TSM.Net.Api.Data.TimeSeries.ITimeSeriesDataCollection<TValue>

The data to be packed to System.Collections.Generic.IAsyncEnumerable<>.

cancellationToken System.Threading.CancellationToken

A token that may be used to cancel the operation.

System.Collections.Generic.IAsyncEnumerable<HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.ITimeSeriesBlockData<TValue>>>
An System.Collections.Generic.IAsyncEnumerable<> of Result<TValue> containing data with an interval using the CompressionMultiplier. One block contains values and flags in the interval of the configured time series.

© 2026 Volue.Version v0.6.38017 November 2026