UiInteger

References
[IoId("00000000-bd72-4608-94bd-31765e246fee")] [DebuggerDisplay("{ToStringFull(),nq}")] public sealed class UiInteger : IComparable<UiInteger>, IEquatable<UiInteger>, IStorable
An integer with controllable limits.

Constructors

UiInteger

#
public UiInteger(int value, int lower, int upper)
Create a new limited Ui integer.
Parameters:
value (int)Value.
lower (int)Lower limit.
upper (int)Upper limit.

UiInteger

#
public UiInteger(int value)
Create a new limitless Ui integer.
Parameters:
value (int)Value.

UiInteger

#
public UiInteger(IReader reader)
Deserialisation constructor.
Parameters:
reader (IReader)Reader to deserialise with.

Fields

Maximum

#
public static readonly int Maximum
Represents the biggest allowed limit value.

Properties

Lower

#
public int Lower { get; }
Gets the lower limit for this number.

Range

#
public long Range { get; }
Gets the limit range.

Upper

#
public int Upper { get; }
Gets the upper limit for this number.

Value

#
public int Value { get; }
Gets the value of this number.

Methods

CompareTo

#
public int CompareTo(UiInteger other)
Compare this number with another. Only the value is taken into consideration.
Parameters:
other (UiInteger)Number to compare against.
Returns: Sorting key.

ComputeSensibleLimits

#
public static void ComputeSensibleLimits(int value, out int lower, out int upper)
Compute sensible limits for a value.
Parameters:
value (int)Value to encompass.
lower (out int)Lower limit.
upper (out int)Upper limit.

Decrement

#
public UiInteger Decrement()
Decrement this number by the smallest possible amount.
Returns: Decremented number, or the same number of decrementation is not possible.

Equals

#
public bool Equals(BigInteger other)
Gets whether this number is equal to some other number. Only values are considered in this equality.
Parameters:
other (BigInteger)Number to test against.
Returns: True if both numbers have the same value.

Equals

#
public override bool Equals(object obj)
Determines whether the specified object is equal to the current object.
Parameters:
obj (object)
Returns: True if the value of this number is equal to the supplied number.
Overrides: Object.Equals

Equals

#
public bool Equals(UiInteger other)
Gets whether this number is equal to some other number. Only values are considered in this equality.
Parameters:
other (UiInteger)Number to test against.
Returns: True if both numbers have the same value.

EqualsFull

#
public bool EqualsFull(UiInteger other)
Gets whether this number is equal to some other number. Value, limits and decimals are all taken into consideration.
Parameters:
other (UiInteger)Number to test against.
Returns: True if both numbers are identical.

FormatValue

#
public string FormatValue(int value)
Format a value.
Parameters:
value (int)Value to format.
Returns: Formatted value.

GetHashCode

#
public override int GetHashCode()
Serves as the default hash function.
Returns: A hash code for the current object.
Overrides: Object.GetHashCode

Increment

#
public UiInteger Increment()
Increment this number by the smallest possible amount.
Returns: Incremented number, or the same number of incrementation is not possible.

ModifyLimits

#
public UiInteger ModifyLimits(int lower, int upper)
Change the limits of this number.
Parameters:
lower (int)New lower limit.
upper (int)New upper limit.
Returns: Modified number.

ModifyValue

#
public UiInteger ModifyValue(int value)
Change the value of this number.
Parameters:
value (int)New value.
Returns: Modified number.

ProcessValue

#
public BigInteger ProcessValue(int value)
Process a value by both limiting and rounding it.
Parameters:
value (int)Value to process.
Returns: Processed value.

Store

#
public void Store(IWriter writer)
This method is called whenever the instance is required to serialize itself.
Parameters:
writer (IWriter)Writer object to serialize with.
Implements: Store

ToString

#
public override string ToString()
Returns a string that represents the current object.
Returns: A string that represents the current object.
Overrides: Object.ToString

ToStringFull

#
public string ToStringFull()
Returns a string that represents the current object.
Returns: A string that represents the current object.

TryParse

#
public static bool TryParse(string text, out UiInteger number, out string message)
Try and parse a string as a UiInteger.
Parameters:
text (string)String to parse.
number (out UiInteger)Parsed number or null on failure.
message (out string)Reason for failure.
Returns: True on success or false on failure.

TryParse

#
public static bool TryParse(string text, out UiInteger number)
Try and parse a string as a UiInteger.
Parameters:
text (string)String to parse.
number (out UiInteger)Parsed number or NaN on failure.
Returns: True on success or false on failure.