Class VolumeUnit

Namespace

xFunc.Maths.Expressions.Units.VolumeUnits

Assembly

xFunc.Maths.dll

Represents a area unit.

public class VolumeUnit : IEquatable<VolumeUnit>

Inheritance

object

VolumeUnit

Implements

IEquatable<VolumeUnit>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

Centimeter

The centimeter (cm³) unit.

public static readonly VolumeUnit Centimeter

Field Value

VolumeUnit

Foot

The foot (ft³) unit.

public static readonly VolumeUnit Foot

Field Value

VolumeUnit

Gallon

The gallon (gal) unit.

public static readonly VolumeUnit Gallon

Field Value

VolumeUnit

Inch

The inch (in³) unit.

public static readonly VolumeUnit Inch

Field Value

VolumeUnit

Liter

The Liter (l) unit.

public static readonly VolumeUnit Liter

Field Value

VolumeUnit

Meter

The meter (m³) unit.

public static readonly VolumeUnit Meter

Field Value

VolumeUnit

Yard

The yard (yd³) unit.

public static readonly VolumeUnit Yard

Field Value

VolumeUnit

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.

[ExcludeFromCodeCoverage]
public static IEnumerable<VolumeUnit> Units { get; }

Property Value

IEnumerable<VolumeUnit>

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

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

public bool Equals(VolumeUnit? other)

Parameters

other VolumeUnit

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

Gets a unit by name.

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

Parameters

name string

The name of unit.

unit VolumeUnit

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 volume units contain an unit with the specified name; otherwise, false.

Exceptions

ArgumentNullException

name is null.

GetHashCode()

Serves as the default hash function.

[ExcludeFromCodeCoverage]
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 ==(VolumeUnit, VolumeUnit)

Determines whether two specified instances of AreaValue are equal.

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

Parameters

left VolumeUnit

The first object to compare.

right VolumeUnit

The second object to compare.

Returns

bool

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

operator !=(VolumeUnit, VolumeUnit)

Determines whether two specified instances of AreaValue are equal.

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

Parameters

left VolumeUnit

The first object to compare.

right VolumeUnit

The second object to compare.

Returns

bool

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