RangeD Class Reference

Inheritance diagram for RangeD:

Public Member Functions
	RangeD (double minimum, double maximum, double increment)
	Initializes a new instance of the RangeD class with specified minimum, maximum, and increment values.
T	Clamp (T value)
	Clamps a value to the bounds of this range.
T	Constrain (T value)
	Returns a value that is constrained to this range.
override bool	Equals (object? obj)
	Determines whether the specified object is equal to the current range.
override int	GetHashCode ()
	Returns a hash code for the current range.
override string	ToString ()
	Returns a string representation of the range.

Properties
T	Minimum [get]
	Gets the lower boundary of the range.
T	Maximum [get]
	Gets the upper boundary of the range.
T	Increment [get]
	Gets the increment value associated with this range.

Detailed Description

Represents a range with double-precision floating-point boundaries.

Since

IDSImaging.Peak.Common 1.3

Constructor & Destructor Documentation

RangeD()

RangeD ( double minimum, double maximum, double increment )

inline

Initializes a new instance of the RangeD class with specified minimum, maximum, and increment values.

Parameters

minimum	The inclusive starting (lower) boundary of the range.
maximum	The inclusive ending (upper) boundary of the range.
increment	The step size or increment between values within the range.

Member Function Documentation

Clamp()

T Clamp ( T value )

inlineinherited

Clamps a value to the bounds of this range.

Values below the minimum are adjusted to the minimum value, while values above the maximum are adjusted to the maximum value.

Parameters

value

The value to clamp.

Returns

The clamped value within this range's boundaries.

Since

IDSImaging.Peak.Common 2.1

Constrain()

T Constrain ( T value )

inlineinherited

Returns a value that is constrained to this range.

The value is adjusted to the nearest valid increment and clamped between the minimum and maximum boundaries of this range.

Parameters

value

The value to constrain.

Returns

The constrained value.

Since

IDSImaging.Peak.Common 2.1

Equals()

override bool Equals ( object? obj )

inlineinherited

Determines whether the specified object is equal to the current range.

Parameters

obj	The object to compare with the current range.

Returns

true if the specified object is equal to the current range; otherwise, false.

GetHashCode()

override int GetHashCode ( )

inlineinherited

Returns a hash code for the current range.

ToString()

override string ToString ( )

inlineinherited

Returns a string representation of the range.

Property Documentation

Increment

T Increment

getinherited

Gets the increment value associated with this range.

Maximum

T Maximum

getinherited

Gets the upper boundary of the range.

Minimum

T Minimum

getinherited

Gets the lower boundary of the range.