Volume Structure

Represents a volume measurement, in cubic meters, as a double-precision floating-point number.

Inheritance Hierarchy

SystemObject
SystemValueType
GSF.UnitsVolume

Namespace: GSF.Units
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public struct Volume : IComparable, IFormattable, 
	IConvertible, IComparable<Volume>, IComparable<double>, IEquatable<Volume>, 
	IEquatable<double>

<SerializableAttribute>
Public Structure Volume
	Implements IComparable, IFormattable, IConvertible, IComparable(Of Volume), 
	IComparable(Of Double), IEquatable(Of Volume), IEquatable(Of Double)

[SerializableAttribute]
public value class Volume : IComparable, 
	IFormattable, IConvertible, IComparable<Volume>, IComparable<double>, 
	IEquatable<Volume>, IEquatable<double>

[<SealedAttribute>]
[<SerializableAttribute>]
type Volume = 
    struct
        inherit ValueType
        interface IComparable
        interface IFormattable
        interface IConvertible
        interface IComparable<Volume>
        interface IComparable<float>
        interface IEquatable<Volume>
        interface IEquatable<float>
    end

JavaScript supports the use of structures, but not the declaration of new ones.

View Source

The Volume type exposes the following members.

Constructors

	Name	Description
	Volume	Creates a new Volume.

Top

Methods

	Name	Description
	CompareTo(Double)	Compares this instance to a specified Double and returns an indication of their relative values.
	CompareTo(Object)	Compares this instance to a specified object and returns an indication of their relative values.
	CompareTo(Volume)	Compares this instance to a specified Volume and returns an indication of their relative values.
	ConvertFrom	Converts the value in the specified sourceUnit to a new Volume in cubic meters.
	ConvertTo	Converts the Volume to the specified targetUnit.
	Equals(Double)	Returns a value indicating whether this instance is equal to a specified Double value.
	Equals(Object)	Returns a value indicating whether this instance is equal to a specified object. (Overrides ValueTypeEquals(Object))
	Equals(Volume)	Returns a value indicating whether this instance is equal to a specified Volume value.
	FromCubicFeet	Creates a new Volume value from the specified value in cubic feet.
	FromCubicInches	Creates a new Volume value from the specified value in cubic inches.
	FromCups	Creates a new Volume value from the specified value in US cups.
	FromFluidOunces	Creates a new Volume value from the specified value in US fluid ounces.
	FromGallons	Creates a new Volume value from the specified value in US fluid gallons.
	FromLiters	Creates a new Volume value from the specified value in liters.
	FromMetricCups	Creates a new Volume value from the specified value in metric cups.
	FromMetricTablespoons	Creates a new Volume value from the specified value in metric tablespoons.
	FromMetricTeaspoons	Creates a new Volume value from the specified value in metric teaspoons.
	FromPints	Creates a new Volume value from the specified value in US fluid pints.
	FromQuarts	Creates a new Volume value from the specified value in US fluid quarts.
	FromTablespoons	Creates a new Volume value from the specified value in US tablespoons.
	FromTeaspoons	Creates a new Volume value from the specified value in US teaspoons.
	GetHashCode	Returns the hash code for this instance. (Overrides ValueTypeGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetTypeCode	Returns the TypeCode for value type Double.
	Parse(String)	Converts the string representation of a number to its Volume equivalent.
	Parse(String, NumberStyles)	Converts the string representation of a number in a specified style to its Volume equivalent.
	Parse(String, IFormatProvider)	Converts the string representation of a number in a specified culture-specific format to its Volume equivalent.
	Parse(String, NumberStyles, IFormatProvider)	Converts the string representation of a number in a specified style and culture-specific format to its Volume equivalent.
	ToCubicFeet	Gets the Volume value in cubic feet.
	ToCubicInches	Gets the Volume value in cubic inches.
	ToCups	Gets the Volume value in US cups.
	ToFluidOunces	Gets the Volume value in US fluid ounces.
	ToGallons	Gets the Volume value in US fluid gallons.
	ToLiters	Gets the Volume value in liters.
	ToMetricCups	Gets the Volume value in metric cups.
	ToMetricTablespoons	Gets the Volume value in metric tablespoons.
	ToMetricTeaspoons	Gets the Volume value in metric teaspoons.
	ToPints	Gets the Volume value in US fluid pints.
	ToQuarts	Gets the Volume value in US fluid quarts.
	ToString	Converts the numeric value of this instance to its equivalent string representation. (Overrides ValueTypeToString)
	ToString(IFormatProvider)	Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.
	ToString(String)	Converts the numeric value of this instance to its equivalent string representation, using the specified format.
	ToString(String, IFormatProvider)	Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.
	ToTablespoons	Gets the Volume value in US tablespoons.
	ToTeaspoons	Gets the Volume value in US teaspoons.
	TryParse(String, Volume)	Converts the string representation of a number to its Volume equivalent. A return value indicates whether the conversion succeeded or failed.
	TryParse(String, NumberStyles, IFormatProvider, Volume)	Converts the string representation of a number in a specified style and culture-specific format to its Volume equivalent. A return value indicates whether the conversion succeeded or failed.

Top

Operators

	Name	Description
	Addition(Volume, Volume)	Returns computed sum of values.
	Division(Volume, Volume)	Returns computed division of values.
	Equality(Volume, Volume)	Compares the two values for equality.
	Exponent(Volume, Volume)	Returns result of first value raised to volume of second value.
	GreaterThan(Volume, Volume)	Returns true if left value is greater than right value.
	GreaterThanOrEqual(Volume, Volume)	Returns true if left value is greater than or equal to right value.
	(Double to Volume)	Implicitly converts value, represented in cubic meters, to a Volume.
	(Volume to Double)	Implicitly converts Volume, represented in cubic meters, to a Double.
	Inequality(Volume, Volume)	Compares the two values for inequality.
	LessThan(Volume, Volume)	Returns true if left value is less than right value.
	LessThanOrEqual(Volume, Volume)	Returns true if left value is less or equal to than right value.
	Modulus(Volume, Volume)	Returns computed remainder after dividing first value by the second.
	Multiply(Volume, Volume)	Returns computed product of values.
	Subtraction(Volume, Volume)	Returns computed difference of values.

Top

Fields

	Name	Description
	MaxValue	Represents the largest possible value of an Volume. This field is constant.
	MinValue	Represents the smallest possible value of an Volume. This field is constant.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

This class behaves just like a Double representing a volume in cubic meters; it is implicitly castable to and from a Double and therefore can be generally used "as" a double, but it has the advantage of handling conversions to and from other volume representations, specifically liters, teaspoons, tablespoons, cubic inches, fluid ounces, cups, pints, quarts, gallons and cubic feet. Metric conversions are handled simply by applying the needed SI conversion factor, for example:

Example

Convert volume, in cubic meters, to cubic kilometers:

Copy

public double GetCubicKilometers(Volume cubicmeters)
{
    return cubicmeters / SI.Kilo;
}

This example converts teaspoons to cups:

Copy

public double GetCups(double teaspoons)
{
    return Volume.FromTeaspoons(teaspoons).ToCups();
}

This example converts liters to fluid ounces:

Copy

public double GetFluidOunces(double liters)
{
    return Volume.FromLiters(liters).ToFluidOunces();
}

Reference

GSF.Units Namespace