Class AngleUnit

Namespace

xFunc.Maths.Expressions.Units.AngleUnits

Assembly

xFunc.Maths.dll

Specifies a measurement of angle.

public class AngleUnit : IEquatable<AngleUnit>

Inheritance

object

AngleUnit

Implements

IEquatable<AngleUnit>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

Degree

The degree (deg, degree, degrees) unit.

public static readonly AngleUnit Degree

Field Value

AngleUnit

Gradian

The gradian (grad, gradian, gradians) unit.

public static readonly AngleUnit Gradian

Field Value

AngleUnit

Radian

The radian (rad, radian, radians) unit.

public static readonly AngleUnit Radian

Field Value

AngleUnit

Properties

Factor

Gets a factor of conversion from this unit to base unit.

public double Factor { get; }

Property Value

double

IsDegree

Gets a value indicating whether the current instance is Degree.

public bool IsDegree { get; }

Property Value

bool

IsGradian

Gets a value indicating whether the current instance is Gradian.

public bool IsGradian { get; }

Property Value

bool

IsRadian

Gets a value indicating whether the current instance is Radian.

public bool IsRadian { get; }

Property Value

bool

Names

Gets all available unit names.

public static IEnumerable<string> Names { get; }

Property Value

IEnumerable<string>

UnitNames

Gets a short name of the unit.

public IReadOnlyCollection<string> UnitNames { get; }

Property Value

IReadOnlyCollection<string>

Units

Gets all available units.

public static IEnumerable<AngleUnit> Units { get; }

Property Value

IEnumerable<AngleUnit>

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(AngleUnit?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(AngleUnit? other)

Parameters

other AngleUnit

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

FromName(string, out AngleUnit?)

Gets a unit by name.

public static bool FromName(string name, out AngleUnit? unit)

Parameters

name string

The name of unit.

unit AngleUnit

When this method returns, the value associated with the specified name, if the unit is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

bool

true if area units contain an unit with the specified name; otherwise, false.

Exceptions

ArgumentNullException

name is null.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

operator ==(AngleUnit, AngleUnit)

Determines whether two specified instances of AreaValue are equal.

public static bool operator ==(AngleUnit left, AngleUnit right)

Parameters

left AngleUnit

The first object to compare.

right AngleUnit

The second object to compare.

Returns

bool

true if left is equal to right; otherwise, false.

operator !=(AngleUnit, AngleUnit)

Determines whether two specified instances of AreaValue are equal.

public static bool operator !=(AngleUnit left, AngleUnit right)

Parameters

left AngleUnit

The first object to compare.

right AngleUnit

The second object to compare.

Returns

bool

true if left is equal to right; otherwise, false.