ITimeSeries Interface
Defines the structure of a named, interval-based sequence of time-stamped data points stored in a TSM repository.
public interface ITimeSeries : HAKOM.TSM.Net.Api.TimeSeries.IAssignableToTimeSeriesImplements IAssignableToTimeSeries
Remarks
Section titled “Remarks”A time series specifies what is being recorded and how the data is organised. The actual data points
are read and written separately through an ITimeSeriesDataStore, obtained from an
ITsmRepository.
The Interval defines the fixed time granularity — for example 15 minutes, 1 hour, or 1 day. Sub-hourly and hourly intervals have a fixed millisecond length; day, month, and year intervals are calendar-based and vary with daylight saving time and leap years. See IInterval.
The Function controls how each data point’s value applies along the time axis. StepRight() (the default) marks a value as valid from the data point’s timestamp onward — typical for instantaneous readings such as power (W, MW). StepLeft() marks a value as a quantity accumulated over the interval ending at the timestamp — typical for energy (Wh, MWh). See FunctionType.
The optional Unit property links the time series to a physical unit such as kWh or °C. Units are repository-scoped and identified by their symbol. See IUnitReference.
The optional IntervalTransformationMethod property controls how values are aggregated or distributed when data is read at a different granularity than the native interval — for example summing hourly values into a daily total, or repeating a daily average across quarter-hour slots. See IntervalTransformationMethod.
When Formula is non-null, the time series is derived: its values are calculated on demand from a formula expression rather than stored explicitly. A formula can have different expressions for different effective dates. See IFormula.
When Quotation is true, the time series supports an additional historization dimension: each data point carries a quotation date recording when the value was submitted. Multiple versions of the same time slot can coexist, and QuotationDefaultBehavior controls which version is returned when reading. See QuotationBehavior.
The CompressionMode property controls whether adjacent data points are packed into fixed-size binary blocks in the database, trading read/write overhead for reduced storage space. See CompressionMode.
PreserveAuditLog records every write operation for auditing. PreserveHistoricData retains overwritten values, enabling point-in-time reconstruction of any past data state.
Properties
Section titled “Properties”ITimeSeries.CompressionMode Property
Section titled “ITimeSeries.CompressionMode Property”Gets the CompressionMode.
HAKOM.TSM.Net.Api.Data.TimeSeries.Compression.CompressionMode CompressionMode { get; }Property Value
Section titled “Property Value”ITimeSeries.CompressionMultiplier Property
Section titled “ITimeSeries.CompressionMultiplier Property”Gets the compression multiplier of the time series.
System.Nullable<int> CompressionMultiplier { get; }Property Value
Section titled “Property Value”ITimeSeries.Cyclic Property
Section titled “ITimeSeries.Cyclic Property”Gets a System.Boolean indicating whether the values along the time axis are cyclic or not.
bool Cyclic { get; }Property Value
Section titled “Property Value”ITimeSeries.Description Property
Section titled “ITimeSeries.Description Property”Gets or sets the free-text description for additional info.
string? Description { get; set; }Property Value
Section titled “Property Value”ITimeSeries.Formula Property
Section titled “ITimeSeries.Formula Property”Gets the IFormula of the time series.
HAKOM.TSM.Net.Api.Formulas.IFormula? Formula { get; }Property Value
Section titled “Property Value”ITimeSeries.Function Property
Section titled “ITimeSeries.Function Property”Gets the FunctionType specifying how values are applied along the time axis.
HAKOM.TSM.Net.Api.TimeSeries.FunctionType Function { get; }Property Value
Section titled “Property Value”ITimeSeries.Interval Property
Section titled “ITimeSeries.Interval Property”Gets the IInterval of the time series.
HAKOM.TSM.Net.Api.Time.Intervals.IInterval Interval { get; }Property Value
Section titled “Property Value”ITimeSeries.IntervalTransformationMethod Property
Section titled “ITimeSeries.IntervalTransformationMethod Property”Gets or sets the IntervalTransformationMethod type of the time series.
System.Nullable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> IntervalTransformationMethod { get; set; }Property Value
Section titled “Property Value”System.Nullable<IntervalTransformationMethod>
ITimeSeries.Name Property
Section titled “ITimeSeries.Name Property”Gets or sets the name of the time series.
string Name { get; set; }Property Value
Section titled “Property Value”ITimeSeries.PreserveAuditLog Property
Section titled “ITimeSeries.PreserveAuditLog Property”Gets a System.Boolean value indicating whether changes made to the time series and its data should be recorded for auditing purposes.
bool PreserveAuditLog { get; }Property Value
Section titled “Property Value”ITimeSeries.PreserveDuplicatedValues Property
Section titled “ITimeSeries.PreserveDuplicatedValues Property”Gets or sets a System.Boolean indicating whether the duplicate data values should be reduced to one value, or whether they should continue to be stored in duplicate.
System.Nullable<bool> PreserveDuplicatedValues { get; set; }Property Value
Section titled “Property Value”System.Nullable<System.Boolean>
ITimeSeries.PreserveHistoricData Property
Section titled “ITimeSeries.PreserveHistoricData Property”Gets a System.Boolean indicating whether or not historic data is preserved.
bool PreserveHistoricData { get; }Property Value
Section titled “Property Value”ITimeSeries.Quotation Property
Section titled “ITimeSeries.Quotation Property”Gets a System.Boolean indicating whether the time series allows quotations (An additional dimension to historization).
bool Quotation { get; }Property Value
Section titled “Property Value”ITimeSeries.QuotationDefaultBehavior Property
Section titled “ITimeSeries.QuotationDefaultBehavior Property”Gets or sets the default QuotationBehavior.
System.Nullable<HAKOM.TSM.Net.Api.Quotations.QuotationBehavior> QuotationDefaultBehavior { get; set; }Property Value
Section titled “Property Value”System.Nullable<QuotationBehavior>
ITimeSeries.StartOfTime Property
Section titled “ITimeSeries.StartOfTime Property”Gets or sets the start time of the time series data mesh.
System.Nullable<System.DateTimeOffset> StartOfTime { get; }Property Value
Section titled “Property Value”System.Nullable<System.DateTimeOffset>
ITimeSeries.TimeZone Property
Section titled “ITimeSeries.TimeZone Property”Gets the ITimeZone of the time series.
HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone? TimeZone { get; }Property Value
Section titled “Property Value”ITimeSeries.Unit Property
Section titled “ITimeSeries.Unit Property”Gets the IUnitReference of the time series.
HAKOM.TSM.Net.Api.Units.Persistence.References.IUnitReference? Unit { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”ITimeSeries.GetCompressionMultiplierOrDefault() Method
Section titled “ITimeSeries.GetCompressionMultiplierOrDefault() Method”Gets the compression mode of the time series.
int GetCompressionMultiplierOrDefault();Returns
Section titled “Returns”System.Int32
The compression multiplier for this time series, or the default compression multiplier for the time series interval if none is configured.
ITimeSeries.GetPreserveDuplicatedValuesOrDefault() Method
Section titled “ITimeSeries.GetPreserveDuplicatedValuesOrDefault() Method”Gets or sets a System.Boolean indicating whether the duplicate data values should be reduced to one value, or whether they should continue to be stored in duplicate.
bool GetPreserveDuplicatedValuesOrDefault();Returns
Section titled “Returns”System.Boolean
System.Boolean indicating whether duplicate values should be reduced to one value.
ITimeSeries.GetStartOfTimeOrDefault() Method
Section titled “ITimeSeries.GetStartOfTimeOrDefault() Method”Gets the StartOfTime or its default. The default is 01.01.1970 00:00:00 in the TimeZone of the time series.
System.DateTimeOffset GetStartOfTimeOrDefault();Returns
Section titled “Returns”System.DateTimeOffset
System.DateTimeOffset representing the start of time of the time series.
ITimeSeries.GetTimeZoneOrDefault() Method
Section titled “ITimeSeries.GetTimeZoneOrDefault() Method”Gets the configured time zone for this time series, or the default time zone if none is configured.
HAKOM.TSM.Net.Api.Time.TimeZones.ITimeZone GetTimeZoneOrDefault();