Class AreaUnit

Namespace

xFunc.Maths.Expressions.Units.AreaUnits

Assembly

xFunc.Maths.dll

Represents a area unit.

public class AreaUnit : IEquatable<AreaUnit>

Inheritance

object

AreaUnit

Implements

IEquatable<AreaUnit>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

Acre

The acre (ac) unit.

public static readonly AreaUnit Acre

Field Value

AreaUnit

Centimeter

The centimeter (cm²) unit.

public static readonly AreaUnit Centimeter

Field Value

AreaUnit

Foot

The foot (ft²) unit.

public static readonly AreaUnit Foot

Field Value

AreaUnit

Hectare

The hectare (ha) unit.

public static readonly AreaUnit Hectare

Field Value

AreaUnit

Inch

The inch (in²) unit.

public static readonly AreaUnit Inch

Field Value

AreaUnit

Kilometer

The kilometer (km²) unit.

public static readonly AreaUnit Kilometer

Field Value

AreaUnit

Meter

The meter (m²) unit.

public static readonly AreaUnit Meter

Field Value

AreaUnit

Mile

The mile (mi²) unit.

public static readonly AreaUnit Mile

Field Value

AreaUnit

Millimeter

The millimeter (mm²) unit.

public static readonly AreaUnit Millimeter

Field Value

AreaUnit

Yard

The yard (yd²) unit.

public static readonly AreaUnit Yard

Field Value

AreaUnit

Properties

Factor

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

public double Factor { get; }

Property Value

double

Names

Gets all available unit names.

public static IEnumerable<string> Names { get; }

Property Value

IEnumerable<string>

UnitName

Gets a short name of the unit.

public string UnitName { get; }

Property Value

string

Units

Gets all available units.

public static IEnumerable<AreaUnit> Units { get; }

Property Value

IEnumerable<AreaUnit>

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(AreaUnit?)

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

public bool Equals(AreaUnit? other)

Parameters

other AreaUnit

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 AreaUnit?)

Gets a unit by name.

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

Parameters

name string

The name of unit.

unit AreaUnit

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.

ToVolumeUnit()

Maps the current area unit to volume unit.

public VolumeUnit ToVolumeUnit()

Returns

VolumeUnit

The volume unit.

Exceptions

InvalidOperationException

Cannot convert the current AreaUnit to an VolumeUnit.

See Also

AreaUnit

Operators

operator ==(AreaUnit, AreaUnit)

Determines whether two specified instances of AreaValue are equal.

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

Parameters

left AreaUnit

The first object to compare.

right AreaUnit

The second object to compare.

Returns

bool

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

operator !=(AreaUnit, AreaUnit)

Determines whether two specified instances of AreaValue are equal.

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

Parameters

left AreaUnit

The first object to compare.

right AreaUnit

The second object to compare.

Returns

bool

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