IntervalTransformationMethod Struct
A struct representing the interval transformation method. It is used to determine how data is transformed along the time axis, for example when changing the interval in which data is read from or written to a time series.
public readonly struct IntervalTransformationMethod : System.IEquatable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod>, HAKOM.TSM.Net.Api.IEnumeration<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod, int>, HAKOM.TSM.Net.Api.IEnumeration<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod>Implements System.IEquatable<IntervalTransformationMethod>, HAKOM.TSM.Net.Api.IEnumeration<IntervalTransformationMethod,System.Int32>, HAKOM.TSM.Net.Api.IEnumeration<IntervalTransformationMethod>
Properties
Section titled “Properties”IntervalTransformationMethod.Value Property
Section titled “IntervalTransformationMethod.Value Property”Gets the System.Int32 representing the type of interval transformation method.
public int Value { get; init; }Implements Value
Property Value
Section titled “Property Value”Methods
Section titled “Methods”IntervalTransformationMethod.AbsMax() Method
Section titled “IntervalTransformationMethod.AbsMax() Method”Creates a new instance of IntervalTransformationMethod representing an ‘AbsMax’ interval transformation method. The AbsMax rule determines the absolute (modulus of a real number) maximum of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod AbsMax();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing an ‘AbsMax’ interval transformation method (Value=8).
IntervalTransformationMethod.AbsMin() Method
Section titled “IntervalTransformationMethod.AbsMin() Method”Creates a new instance of IntervalTransformationMethod representing an ‘AbsMin’ interval transformation method. The AbsMin rule determines the absolute (modulus of a real number) minimum of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod AbsMin();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing an ‘AbsMin’ interval transformation method (Value=7).
IntervalTransformationMethod.Average() Method
Section titled “IntervalTransformationMethod.Average() Method”Creates a new instance of IntervalTransformationMethod representing an ‘Average’ interval transformation method. The Average rule determines the average of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod Average();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing an ‘Average’ interval transformation method (Value=2).
IntervalTransformationMethod.Create(int) Method
Section titled “IntervalTransformationMethod.Create(int) Method”Creates a new instance of IntervalTransformationMethod with a custom value.
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod Create(int value);Parameters
Section titled “Parameters”value System.Int32
The System.Int32 id of the interval transformation method.
Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod.
Exceptions
Section titled “Exceptions”System.ArgumentOutOfRangeException
Thrown when value is outside the allowed range (1-10).
Remarks
Section titled “Remarks”Sometimes input (or output) data interval might differ from the interval of the target (or source) time series. In such cases interval transformation methods become active to transform across different intervals.
IntervalTransformationMethod.Create(string) Method
Section titled “IntervalTransformationMethod.Create(string) Method”Creates a new instance of IntervalTransformationMethod based on its name.
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod Create(string name);Parameters
Section titled “Parameters”name System.String
The name id of the interval transformation method.
Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod.
Exceptions
Section titled “Exceptions”System.ArgumentOutOfRangeException
Thrown when name is not one of the known interval transformation methods.
Remarks
Section titled “Remarks”Sometimes input (or output) data interval might differ from the interval of the target (or source) time series. In such cases interval transformation methods become active to transform across different intervals.
IntervalTransformationMethod.Default() Method
Section titled “IntervalTransformationMethod.Default() Method”Creates a new default instance of IntervalTransformationMethod. The default instance is an average transformation method.
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod Default();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of the default IntervalTransformationMethod (Value=default).
IntervalTransformationMethod.Equals(IntervalTransformationMethod) Method
Section titled “IntervalTransformationMethod.Equals(IntervalTransformationMethod) Method”Compares the value of this interval transformation method to another interval transformation method returning a boolean.
public bool Equals(HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod other);Parameters
Section titled “Parameters”other IntervalTransformationMethod
The IntervalTransformationMethod, which is used for comparison
Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the values of the interval transformation methods are equal (true) or not equal(false).
IntervalTransformationMethod.Equals(object) Method
Section titled “IntervalTransformationMethod.Equals(object) Method”Compares the value of this interval transformation method to another interval transformation method returning a boolean.
public override bool Equals(object? obj);Parameters
Section titled “Parameters”obj System.Object
The IntervalTransformationMethod, which is used for comparison
Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the values of the interval transformation methods are equal (true) or not equal(false).
IntervalTransformationMethod.FirstValue() Method
Section titled “IntervalTransformationMethod.FirstValue() Method”Creates a new instance of IntervalTransformationMethod representing a ‘FirstValue’ interval transformation method. The FirstValue rule determines the first value out of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod FirstValue();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing a ‘FirstValue’ interval transformation method (Value=9).
IntervalTransformationMethod.GetAll() Method
Section titled “IntervalTransformationMethod.GetAll() Method”Returns all available IntervalTransformationMethod.
public static System.Collections.Generic.IEnumerable<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> GetAll();Returns
Section titled “Returns”System.Collections.Generic.IEnumerable<IntervalTransformationMethod>
A collection of interval transformation methods.
IntervalTransformationMethod.GetHashCode() Method
Section titled “IntervalTransformationMethod.GetHashCode() Method”Creates the hash code for this interval transformation method, using its value.
public override int GetHashCode();Returns
Section titled “Returns”System.Int32
A hash code for this interval transformation method.
IntervalTransformationMethod.IsAbsMax() Method
Section titled “IntervalTransformationMethod.IsAbsMax() Method”Checks if the current interval transformation method is ‘AbsMax’ (value: 8).
public bool IsAbsMax();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘AbsMax’.
IntervalTransformationMethod.IsAbsMin() Method
Section titled “IntervalTransformationMethod.IsAbsMin() Method”Checks if the current interval transformation method is ‘AbsMin’ (value: 7).
public bool IsAbsMin();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘AbsMin’.
IntervalTransformationMethod.IsAverage() Method
Section titled “IntervalTransformationMethod.IsAverage() Method”Checks if the current interval transformation method is ‘Average’ (value: 2).
public bool IsAverage();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘Average’.
IntervalTransformationMethod.IsDefault() Method
Section titled “IntervalTransformationMethod.IsDefault() Method”Checks if the current value of the interval transformation method is equal to the default literal.
public bool IsDefault();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method value is equal (true) to the default literal.
IntervalTransformationMethod.IsFirstValue() Method
Section titled “IntervalTransformationMethod.IsFirstValue() Method”Checks if the current interval transformation method is ‘FirstValue’ (value: 9).
public bool IsFirstValue();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘FirstValue’.
IntervalTransformationMethod.IsLastValue() Method
Section titled “IntervalTransformationMethod.IsLastValue() Method”Checks if the current interval transformation method is ‘LastValue’ (value: 10).
public bool IsLastValue();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘LastValue’.
IntervalTransformationMethod.IsMax() Method
Section titled “IntervalTransformationMethod.IsMax() Method”Checks if the current interval transformation method is ‘Max’ (value: 4).
public bool IsMax();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘Max’.
IntervalTransformationMethod.IsMin() Method
Section titled “IntervalTransformationMethod.IsMin() Method”Checks if the current interval transformation method is ‘Min’ (value: 3).
public bool IsMin();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘Min’.
IntervalTransformationMethod.IsMostFrequently() Method
Section titled “IntervalTransformationMethod.IsMostFrequently() Method”Checks if the current interval transformation method is ‘MostFrequently’ (value: 5).
public bool IsMostFrequently();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘MostFrequently’.
IntervalTransformationMethod.IsSum() Method
Section titled “IntervalTransformationMethod.IsSum() Method”Checks if the current interval transformation method is ‘Sum’ (value: 1).
public bool IsSum();Returns
Section titled “Returns”System.Boolean
A System.Boolean indicating if the current interval transformation method is ‘Sum’.
IntervalTransformationMethod.LastValue() Method
Section titled “IntervalTransformationMethod.LastValue() Method”Creates a new instance of IntervalTransformationMethod representing a ‘LastValue’ interval transformation method. The LastValue rule determines the last value out of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod LastValue();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing a ‘LastValue’ interval transformation method (Value=10).
IntervalTransformationMethod.Max() Method
Section titled “IntervalTransformationMethod.Max() Method”Creates a new instance of IntervalTransformationMethod representing a ‘Max’ interval transformation method. The Max rule determines the maximum of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod Max();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing a ‘Max’ interval transformation method (Value=4).
IntervalTransformationMethod.Min() Method
Section titled “IntervalTransformationMethod.Min() Method”Creates a new instance of IntervalTransformationMethod representing a ‘Min’ interval transformation method. The Min rule determines the minimum of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod Min();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing a ‘Min’ interval transformation method (Value=3).
IntervalTransformationMethod.MostFrequently() Method
Section titled “IntervalTransformationMethod.MostFrequently() Method”Creates a new instance of IntervalTransformationMethod representing a ‘MostFrequently’ interval transformation method. The MostFrequently rule determines the most frequent of all values, when converting to a longer interval (e.g. quarter hour to hour), or repeats the value, when converting to a shorter interval (hour to quarter hour). If a two different values are equally frequent, the value occuring later will be taken, when converting from a shorter interval.
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod MostFrequently();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing a ‘MostFrequently’ interval transformation method (Value=5).
IntervalTransformationMethod.Sum() Method
Section titled “IntervalTransformationMethod.Sum() Method”Creates a new instance of IntervalTransformationMethod representing a ‘Sum’ interval transformation method. The Sum rule determines the sum of all values, when converting to a longer interval (e.g. quarter hour to hour), or calculates the proportional value of the given target period inside the source period (i.e. a division of the source value by the number of target data points within a given source interval), when converting to a shorter interval (hour to quarter hour).
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod Sum();Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod representing a ‘Sum’ interval transformation method (Value=1).
IntervalTransformationMethod.ToIntervalTransformationMethod(int) Method
Section titled “IntervalTransformationMethod.ToIntervalTransformationMethod(int) Method”Converts an System.Int32 to IntervalTransformationMethod.
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod ToIntervalTransformationMethod(int value);Parameters
Section titled “Parameters”value System.Int32
The System.Int32 id of the interval transformation method.
Returns
Section titled “Returns”IntervalTransformationMethod
A new instance of IntervalTransformationMethod.
IntervalTransformationMethod.ToString() Method
Section titled “IntervalTransformationMethod.ToString() Method”Display the name and numeric value of the IntervalTransformationMethod as formated string.
public override string ToString();Returns
Section titled “Returns”System.String
The name and numeric value in the following format Name (Value).
IntervalTransformationMethod.TryCreate(int) Method
Section titled “IntervalTransformationMethod.TryCreate(int) Method”Attempts to create a new instance of IntervalTransformationMethod with a custom value.
public static HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> TryCreate(int value);Parameters
Section titled “Parameters”value System.Int32
The System.Int32 id of the interval transformation method.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<IntervalTransformationMethod>
A new instance of IntervalTransformationMethod.
Exceptions
Section titled “Exceptions”System.ArgumentOutOfRangeException
Thrown when value is outside the allowed range (1-10).
Remarks
Section titled “Remarks”Sometimes input (or output) data interval might differ from the interval of the target (or source) time series. In such cases interval transformation methods become active to transform across different intervals.
IntervalTransformationMethod.TryCreate(string) Method
Section titled “IntervalTransformationMethod.TryCreate(string) Method”Attempts to create a new instance of IntervalTransformationMethod with a custom value.
public static HAKOM.ErrorHandling.Core.Net.Api.Result<HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod> TryCreate(string name);Parameters
Section titled “Parameters”name System.String
The name of the interval transformation method.
Returns
Section titled “Returns”HAKOM.ErrorHandling.Core.Net.Api.Result<IntervalTransformationMethod>
A new instance of IntervalTransformationMethod.
Exceptions
Section titled “Exceptions”System.ArgumentOutOfRangeException
Thrown when name is not one of the known interval transformation methods.
Remarks
Section titled “Remarks”Sometimes input (or output) data interval might differ from the interval of the target (or source) time series. In such cases interval transformation methods become active to transform across different intervals.
Operators
Section titled “Operators”IntervalTransformationMethod.operator ==(IntervalTransformationMethod, IntervalTransformationMethod) Operator
Section titled “IntervalTransformationMethod.operator ==(IntervalTransformationMethod, IntervalTransformationMethod) Operator”Compares the value of two interval transformation methods using the operator ‘==’.
public static bool operator ==(HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod left, HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod right);Parameters
Section titled “Parameters”left IntervalTransformationMethod
The IntervalTransformationMethod on the left of the ‘==’ operator.
right IntervalTransformationMethod
The IntervalTransformationMethod on the right of the ‘==’ operator.
Returns
Section titled “Returns”System.Boolean
Returns a System.Boolean indicating if the values of the interval transformation methods are equal (true) or not equal (false).
IntervalTransformationMethod.implicit operator IntervalTransformationMethod(int) Operator
Section titled “IntervalTransformationMethod.implicit operator IntervalTransformationMethod(int) Operator”Implicitly converts an integer (value of an interval transformation method) to an interval transformation method.
public static HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod implicit operator HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod(int value);Parameters
Section titled “Parameters”value System.Int32
The System.Int32 (number/id) of an interval transformation method.
Returns
Section titled “Returns”IntervalTransformationMethod.operator !=(IntervalTransformationMethod, IntervalTransformationMethod) Operator
Section titled “IntervalTransformationMethod.operator !=(IntervalTransformationMethod, IntervalTransformationMethod) Operator”Compares the value of two interval transformation methods using the operator ‘!=’.
public static bool operator !=(HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod left, HAKOM.TSM.Net.Api.Time.Intervals.IntervalTransformationMethod right);Parameters
Section titled “Parameters”left IntervalTransformationMethod
The IntervalTransformationMethod on the left of the ‘!=’ operator.
right IntervalTransformationMethod
The IntervalTransformationMethod on the right of the ‘!=’ operator.
Returns
Section titled “Returns”System.Boolean
Returns a System.Boolean indicating if the values of the interval transformation methods are not equal (true) or equal (false).