Temperature Structure

Represents a temperature, in Kelvin, as a double-precision floating-point number.

Inheritance Hierarchy

SystemObject
SystemValueType
GSF.UnitsTemperature

Namespace: GSF.Units
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

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

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

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

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

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

View Source

The Temperature type exposes the following members.

Constructors

	Name	Description
	Temperature	Creates a new Temperature.

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(Temperature)	Compares this instance to a specified Temperature and returns an indication of their relative values.
	ConvertFrom	Converts the value in the specified sourceUnit to a new Temperature in Kelvin.
	ConvertTo	Converts the Temperature 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(Temperature)	Returns a value indicating whether this instance is equal to a specified Temperature value.
	FromCelsius	Creates a new Temperature value from the specified value in Celsius.
	FromDelisle	Creates a new Temperature value from the specified value in Delisle.
	FromFahrenheit	Creates a new Temperature value from the specified value in Fahrenheit.
	FromNewton	Creates a new Temperature value from the specified value in Newton.
	FromRankine	Creates a new Temperature value from the specified value in Rankine.
	FromRéaumur	Creates a new Temperature value from the specified value in Réaumur.
	FromRømer	Creates a new Temperature value from the specified value in Rømer.
	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 Temperature equivalent.
	Parse(String, NumberStyles)	Converts the string representation of a number in a specified style to its Temperature equivalent.
	Parse(String, IFormatProvider)	Converts the string representation of a number in a specified culture-specific format to its Temperature equivalent.
	Parse(String, NumberStyles, IFormatProvider)	Converts the string representation of a number in a specified style and culture-specific format to its Temperature equivalent.
	ToCelsius	Gets the Temperature value in Celsius.
	ToDelisle	Gets the Temperature value in Delisle.
	ToFahrenheit	Gets the Temperature value in Fahrenheit.
	ToNewton	Gets the Temperature value in Newton.
	ToRankine	Gets the Temperature value in Rankine.
	ToRéaumur	Gets the Temperature value in Réaumur.
	ToRømer	Gets the Temperature value in Rømer.
	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.
	TryParse(String, Temperature)	Converts the string representation of a number to its Temperature equivalent. A return value indicates whether the conversion succeeded or failed.
	TryParse(String, NumberStyles, IFormatProvider, Temperature)	Converts the string representation of a number in a specified style and culture-specific format to its Temperature equivalent. A return value indicates whether the conversion succeeded or failed.

Top

Operators

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

Top

Fields

	Name	Description
	MaxValue	Represents the largest possible value of a Temperature. This field is constant.
	MinValue	Represents the smallest possible value of a Temperature. 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 temperature in Kelvin; 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 temperature representations, specifically Celsius, Fahrenheit, Newton, Rankine, Delisle, Réaumur and Rømer.

Example

This example converts Celsius to Fahrenheit:

Copy

public double GetFahrenheit(double celsius)
{
    return Temperature.FromCelsius(celsius).ToFahrenheit();
}

Reference

GSF.Units Namespace