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>
Constructors
Section titled “Constructors”Flag(byte) Constructor
Section titled “Flag(byte) Constructor”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);Parameters
Section titled “Parameters”value System.Byte
Range: 0-22 Built in flag values.
Properties
Section titled “Properties”Flag.Value Property
Section titled “Flag.Value Property”The value of the flag.
public byte Value { get; init; }Implements Value
Property Value
Section titled “Property Value”Methods
Section titled “Methods”Flag.Accounted() Method
Section titled “Flag.Accounted() Method”Creates a flag indicating that the value should be considered accounted for.
public static HAKOM.TSM.Net.Api.Flags.Flag Accounted();Returns
Section titled “Returns”Flag.Create(byte) Method
Section titled “Flag.Create(byte) Method”Creates a new Flag instance from the given value.
public static HAKOM.TSM.Net.Api.Flags.Flag Create(byte value);Parameters
Section titled “Parameters”value System.Byte
The value for the new flag.
Returns
Section titled “Returns”Flag
The created flag.
Flag.Default() Method
Section titled “Flag.Default() Method”Creates a default flag of the type Missing().
public static HAKOM.TSM.Net.Api.Flags.Flag Default();Returns
Section titled “Returns”Flag.Equals(Flag) Method
Section titled “Flag.Equals(Flag) Method”Compares the value and priority of this flag to another flag returning a boolean.
public bool Equals(HAKOM.TSM.Net.Api.Flags.Flag other);Parameters
Section titled “Parameters”other Flag
The flag, which is used for comparison.
Returns
Section titled “Returns”System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal(false).
Flag.Equals(object) Method
Section titled “Flag.Equals(object) Method”Compares the value and priority of this flag to another flag returning a boolean.
public override bool Equals(object? obj);Parameters
Section titled “Parameters”obj System.Object
The flag, which is used for comparison.
Returns
Section titled “Returns”System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal(false).
Flag.Estimated() Method
Section titled “Flag.Estimated() Method”Creates a flag indicating that the value is estimated.
public static HAKOM.TSM.Net.Api.Flags.Flag Estimated();Returns
Section titled “Returns”Flag.Faulty() Method
Section titled “Flag.Faulty() Method”Creates a flag indicating that the value is faulty.
public static HAKOM.TSM.Net.Api.Flags.Flag Faulty();Returns
Section titled “Returns”Flag.GetHashCode() Method
Section titled “Flag.GetHashCode() Method”Creates the hash code for this flag, using its value.
public override int GetHashCode();Returns
Section titled “Returns”System.Int32
A hash code for this flag.
Flag.Ignore() Method
Section titled “Flag.Ignore() Method”Creates a flag indicating that the value will be ignored in any operation.
public static HAKOM.TSM.Net.Api.Flags.Flag Ignore();Returns
Section titled “Returns”Flag.Interpolated() Method
Section titled “Flag.Interpolated() Method”Creates a flag indicating that the value is interpolated.
public static HAKOM.TSM.Net.Api.Flags.Flag Interpolated();Returns
Section titled “Returns”Flag.IsHakomAccounted() Method
Section titled “Flag.IsHakomAccounted() Method”Returns true if the Flag is “Accounted”.
public bool IsHakomAccounted();Returns
Section titled “Returns”Flag.IsHakomEstimated() Method
Section titled “Flag.IsHakomEstimated() Method”Returns true if the Flag is “Estimated”.
public bool IsHakomEstimated();Returns
Section titled “Returns”Flag.IsHakomFaulty() Method
Section titled “Flag.IsHakomFaulty() Method”Returns true if the Flag is “Faulty”.
public bool IsHakomFaulty();Returns
Section titled “Returns”Flag.IsHakomIgnore() Method
Section titled “Flag.IsHakomIgnore() Method”Returns true if the Flag is “Ignore”.
public bool IsHakomIgnore();Returns
Section titled “Returns”Flag.IsHakomInterpolated() Method
Section titled “Flag.IsHakomInterpolated() Method”Returns true if the Flag is “Interpolated”.
public bool IsHakomInterpolated();Returns
Section titled “Returns”Flag.IsHakomManuallyReplaced() Method
Section titled “Flag.IsHakomManuallyReplaced() Method”Returns true if the Flag is “ManuallyReplaced”.
public bool IsHakomManuallyReplaced();Returns
Section titled “Returns”Flag.IsHakomMissing() Method
Section titled “Flag.IsHakomMissing() Method”Returns true if the Flag is “Missing”.
public bool IsHakomMissing();Returns
Section titled “Returns”Flag.IsHakomScheduled() Method
Section titled “Flag.IsHakomScheduled() Method”Returns true if the Flag is “Schedule”.
public bool IsHakomScheduled();Returns
Section titled “Returns”Flag.IsHakomValid() Method
Section titled “Flag.IsHakomValid() Method”Returns true if the Flag is “Valid”.
public bool IsHakomValid();Returns
Section titled “Returns”Flag.ManuallyReplaced() Method
Section titled “Flag.ManuallyReplaced() Method”Creates a flag indicating that the value has been manually set.
public static HAKOM.TSM.Net.Api.Flags.Flag ManuallyReplaced();Returns
Section titled “Returns”Flag.Missing() Method
Section titled “Flag.Missing() Method”Creates a flag indicating that the value should be considered missing.
public static HAKOM.TSM.Net.Api.Flags.Flag Missing();Returns
Section titled “Returns”Flag.Scheduled() Method
Section titled “Flag.Scheduled() Method”Creates a flag indicating that the value is as scheduled.
public static HAKOM.TSM.Net.Api.Flags.Flag Scheduled();Returns
Section titled “Returns”Flag.ToString() Method
Section titled “Flag.ToString() Method”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();Returns
Section titled “Returns”System.String
The name and/or numeric value of this flag.
Flag.ToString(IFlagNameProvider) Method
Section titled “Flag.ToString(IFlagNameProvider) Method”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);Parameters
Section titled “Parameters”flagNameProvider IFlagNameProvider
Returns
Section titled “Returns”System.String
The name and/or numeric value of this flag.
Flag.Valid() Method
Section titled “Flag.Valid() Method”Creates a flag indicating that the value is “normal”.
public static HAKOM.TSM.Net.Api.Flags.Flag Valid();Returns
Section titled “Returns”Operators
Section titled “Operators”Flag.operator ==(Flag, Flag) Operator
Section titled “Flag.operator ==(Flag, Flag) Operator”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);Parameters
Section titled “Parameters”left Flag
The flag on the left of the ‘==’ operator.
right Flag
The flag on the right of the ‘==’ operator.
Returns
Section titled “Returns”System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal (false).
Flag.operator !=(Flag, Flag) Operator
Section titled “Flag.operator !=(Flag, Flag) Operator”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);Parameters
Section titled “Parameters”left Flag
The flag on the left of the ‘!=’ operator.
right Flag
The flag on the right of the ‘!=’ operator.
Returns
Section titled “Returns”System.Boolean
Returns a boolean representing if the values and priorities of the flags are equal (true) or not equal (false).