Skip to content
Documentation

Flag Struct

Describes the quality of an individual data point.

public readonly struct Flag : System.IEquatable<HAKOM.TSM.Net.Api.Flags.Flag>, HAKOM.TSM.Net.Api.IEnumeration<HAKOM.TSM.Net.Api.Flags.Flag, byte>, HAKOM.TSM.Net.Api.IEnumeration<HAKOM.TSM.Net.Api.Flags.Flag>

Implements System.IEquatable<Flag>, HAKOM.TSM.Net.Api.IEnumeration<Flag,System.Byte>, HAKOM.TSM.Net.Api.IEnumeration<Flag>

Use this constructor for custom flag values, please make sure your custom values are not in the range between: 0-22.

public Flag(byte value);

value System.Byte

Range: 0-22 Built in flag values.

The value of the flag.

public byte Value { get; init; }

Implements Value

System.Byte

Creates a flag indicating that the value should be considered accounted for.

public static HAKOM.TSM.Net.Api.Flags.Flag Accounted();

Flag
A new Flag.

Creates a new Flag instance from the given value.

public static HAKOM.TSM.Net.Api.Flags.Flag Create(byte value);

value System.Byte

The value for the new flag.

Flag
The created flag.

Creates a default flag of the type Missing().

public static HAKOM.TSM.Net.Api.Flags.Flag Default();

Flag
A new Flag.

Compares the value and priority of this flag to another flag returning a boolean.

public bool Equals(HAKOM.TSM.Net.Api.Flags.Flag other);

other Flag

The flag, which is used for comparison.

System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal(false).

Compares the value and priority of this flag to another flag returning a boolean.

public override bool Equals(object? obj);

obj System.Object

The flag, which is used for comparison.

System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal(false).

Creates a flag indicating that the value is estimated.

public static HAKOM.TSM.Net.Api.Flags.Flag Estimated();

Flag
A new Flag.

Creates a flag indicating that the value is faulty.

public static HAKOM.TSM.Net.Api.Flags.Flag Faulty();

Flag
A new Flag.

Creates the hash code for this flag, using its value.

public override int GetHashCode();

System.Int32
A hash code for this flag.

Creates a flag indicating that the value will be ignored in any operation.

public static HAKOM.TSM.Net.Api.Flags.Flag Ignore();

Flag
A new Flag.

Creates a flag indicating that the value is interpolated.

public static HAKOM.TSM.Net.Api.Flags.Flag Interpolated();

Flag
A new Flag.

Returns true if the Flag is “Accounted”.

public bool IsHakomAccounted();

System.Boolean

Returns true if the Flag is “Estimated”.

public bool IsHakomEstimated();

System.Boolean

Returns true if the Flag is “Faulty”.

public bool IsHakomFaulty();

System.Boolean

Returns true if the Flag is “Ignore”.

public bool IsHakomIgnore();

System.Boolean

Returns true if the Flag is “Interpolated”.

public bool IsHakomInterpolated();

System.Boolean

Returns true if the Flag is “ManuallyReplaced”.

public bool IsHakomManuallyReplaced();

System.Boolean

Returns true if the Flag is “Missing”.

public bool IsHakomMissing();

System.Boolean

Returns true if the Flag is “Schedule”.

public bool IsHakomScheduled();

System.Boolean

Returns true if the Flag is “Valid”.

public bool IsHakomValid();

System.Boolean

Creates a flag indicating that the value has been manually set.

public static HAKOM.TSM.Net.Api.Flags.Flag ManuallyReplaced();

Flag
A new Flag.

Creates a flag indicating that the value should be considered missing.

public static HAKOM.TSM.Net.Api.Flags.Flag Missing();

Flag
A new Flag.

Creates a flag indicating that the value is as scheduled.

public static HAKOM.TSM.Net.Api.Flags.Flag Scheduled();

Flag
A new Flag.

Returns a string representation of this Flag. Flags with common values known to HAKOM will show both their name and value, whereas custom flags will only have their numeric value shown.

public override string ToString();

System.String
The name and/or numeric value of this flag.

Returns a string representation of this Flag. If flagNameProvider returns a name for this flags value, the string will contain both its name and value. If not, the string will contain only the numeric value.

public string ToString(HAKOM.TSM.Net.Api.Flags.IFlagNameProvider flagNameProvider);

flagNameProvider IFlagNameProvider

System.String
The name and/or numeric value of this flag.

Creates a flag indicating that the value is “normal”.

public static HAKOM.TSM.Net.Api.Flags.Flag Valid();

Flag
A new Flag.

Compares the value and priority of two flags using the operator ‘==’.

public static bool operator ==(HAKOM.TSM.Net.Api.Flags.Flag left, HAKOM.TSM.Net.Api.Flags.Flag right);

left Flag

The flag on the left of the ‘==’ operator.

right Flag

The flag on the right of the ‘==’ operator.

System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal (false).

Compares the value and priority of two flags using the operator ‘!=’.

public static bool operator !=(HAKOM.TSM.Net.Api.Flags.Flag left, HAKOM.TSM.Net.Api.Flags.Flag right);

left Flag

The flag on the left of the ‘!=’ operator.

right Flag

The flag on the right of the ‘!=’ operator.

System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal (false).

© 2026 Volue.Version v0.6.38017 November 2026