TemperatureCompareTo Method

Compares two Temperature objects for low-to-high ordering.

Namespace: DegreeDays.Api.Data
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4

Syntax

public int CompareTo(
	Temperature comparisonTemperature
)

Public Function CompareTo ( 
	comparisonTemperature As Temperature
) As Integer

Parameters

comparisonTemperature Temperature: The Temperature to be compared. Cannot be null.

Return Value

Int32
A negative integer if this Temperature is lower than comparisonTemperature or exactly equivalent with this temperature being in Celsius and comparisonTemperature being in Fahrenheit; zero if this Temperature is equal to comparisonTemperature (in Unit and in Value); or a positive integer if this Temperature is greater than comparisonTemperature or exactly equivalent with this temperature being in Fahrenheit and comparisonTemperature being in Celsius.

Implements

IComparableTCompareTo(T)

Remarks

If two temperatures have different units but are exactly equivalent (like how 18°C is exactly equivalent to 64.4°F), the Celsius temperature will be ordered first.

Version History

Version	Description
1.4	This was added in version 1.4.

Reference

Temperature Structure

DegreeDays.Api.Data Namespace