Interval Class Reference

Inheritance diagram for Interval:

Public Member Functions
	Interval (int minimum, int maximum)
	Initializes a new instance of the Interval class with specified boundaries.
T	Clamp (T value)
	Clamps a value to the bounds of this interval.
override bool	Equals (object? obj)
	Determines whether the specified object is equal to the current interval.
override int	GetHashCode ()
	Returns a hash code for the current interval.
override string	ToString ()
	Returns a string representation of the interval.

Properties
T	Minimum [get]
	Gets the lower boundary of the interval.
T	Maximum [get]
	Gets the upper boundary of the interval.

Detailed Description

Represents an interval with signed integer boundaries.

Since

IDSImaging.Peak.Common 1.3

Constructor & Destructor Documentation

Interval()

Interval ( int minimum, int maximum )

inline

Initializes a new instance of the Interval class with specified boundaries.

Parameters

minimum	The lower boundary.
maximum	The upper boundary.

Member Function Documentation

Clamp()

T Clamp ( T value )

inlineinherited

Clamps a value to the bounds of this interval.

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 interval's boundaries.

Since

IDSImaging.Peak.Common 2.1

Equals()

override bool Equals ( object? obj )

inlineinherited

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

Parameters

obj	The object to compare with the current interval.

Returns

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

GetHashCode()

override int GetHashCode ( )

inlineinherited

Returns a hash code for the current interval.

ToString()

override string ToString ( )

inlineinherited

Returns a string representation of the interval.

Property Documentation

Maximum

T Maximum

getinherited

Gets the upper boundary of the interval.

Minimum

T Minimum

getinherited

Gets the lower boundary of the interval.