UtilitiesRange Method

Flexible routine to range a number into a given range between a lower and an higher bound.

Definition

Namespace: ASCOM.Tools
Assembly: ASCOM.Tools (in ASCOM.Tools.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea

C#

public static double Range(
	double Value,
	double LowerBound,
	bool LowerEqual,
	double UpperBound,
	bool UpperEqual
)

VB

Public Shared Function Range ( 
	Value As Double,
	LowerBound As Double,
	LowerEqual As Boolean,
	UpperBound As Double,
	UpperEqual As Boolean
) As Double

Parameters

Value Double: Value to be ranged
LowerBound Double: Lowest value of the range
LowerEqual Boolean: Boolean flag indicating whether the ranged value can have the lower bound value
UpperBound Double: Highest value of the range
UpperEqual Boolean: Boolean flag indicating whether the ranged value can have the upper bound value

Return Value

Double
The ranged number as a double

Remarks

UpperEqual and LowerEqual switches control whether the ranged value can be equal to either the upper and lower bounds. So, to range an hour angle into the range 0 to 23.999999.. hours, use this call: RangedValue = Range(InputValue, 0.0, True, 24.0, False)

The input value will be returned in the range where 0.0 is an allowable value and 24.0 is not i.e. in the range 0..23.999999..

It is not permissible for both LowerEqual and UpperEqual to be false because it will not be possible to return a value that is exactly equal to either lower or upper bounds. An exception is thrown if this scenario is requested.

Exceptions

InvalidOperationException	Thrown if the lower bound is greater than the upper bound.
InvalidOperationException	Thrown if LowerEqual and UpperEqual are both false and the ranged value equals one of these values. This is impossible to handle as the algorithm will always violate one of the rules!

Version Information

.NET Standard

Supported in: 2.0