Struct EnumInformation

Namespace

SIMDispatcher.Core.Models

Assembly

SIMDispatcher.Core.dll

Represents detailed information about an enum type used in the system, including its name, numeric value, and localized description. This record is especially useful for displaying enum data dynamically in user interfaces.

public struct EnumInformation : IComparable<EnumInformation>, IComparable

Implements

IComparable<EnumInformation>

IComparable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Description

The localized display name for the enum member, providing a user-friendly description.

public required string Description { readonly get; set; }

Property Value

string

Name

The name of the enum member, typically the result of calling ToString() on an enum.

public required string Name { readonly get; set; }

Property Value

string

Number

The integer value corresponding to the specific enum member.

public int Number { readonly get; set; }

Property Value

int

Type

The name of the enum type this information pertains to, such as e.g.: 'CommandcenterCategory', 'PoiCategory', or 'UnitCategory' ...

public required string Type { readonly get; set; }

Property Value

string

Methods

CompareTo(EnumInformation)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(EnumInformation other)

Parameters

other EnumInformation

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

CompareTo(object?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(object? obj)

Parameters

obj object

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes obj in the sort order.
Zero	This instance occurs in the same position in the sort order as obj.
Greater than zero	This instance follows obj in the sort order.

Exceptions

ArgumentException

obj is not the same type as this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.