EnergyCompareTo(Object) Method

Compares this instance to a specified object and returns an indication of their relative values.

Namespace: GSF.Units
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.242-beta+5de70bd1c87865d409ebc16b8886196644c0c750

Syntax

C++

JavaScript

Copy

public int CompareTo(
	Object value
)

Public Function CompareTo ( 
	value As Object
) As Integer

public:
virtual int CompareTo(
	Object^ value
) sealed

abstract CompareTo : 
        value : Object -> int 
override CompareTo : 
        value : Object -> int

function CompareTo(value);

View Source

Parameters

value Object: An object to compare, or null.

Return Value

Int32
A signed number indicating the relative values of this instance and value. Returns less than zero if this instance is less than value, zero if this instance is equal to value, or greater than zero if this instance is greater than value.

Implements

IComparableCompareTo(Object)

Exceptions

Exception	Condition
ArgumentException	value is not a Double or Energy.

Reference

Energy Structure

CompareTo Overload

GSF.Units Namespace