Class RangeBase<T>

Defines the base class for IRange, used throughout SciChart for visible, data and index range calculations.

Inheritance

Object

RangeBase<T>

Implements

IRange<T>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Namespace:

Assembly: .dll

Syntax

public abstract class RangeBase<T> implements IRange<T>

Type Parameters

Name	Description
T

Constructors

RangeBase(T min, T max, IMath<T> math)

Creates a new instance of RangeBase

Declaration

protected RangeBase(T min, T max, IMath<T> math)

Parameters

Type	Name	Description
T	min	The min value to initialize range with.
T	max	The max value to initialize range with.
IMath<T>	math	The generic IMath helper.

RangeBase(RangeBase<T> range, IMath<T> math)

Creates a new instance of RangeBase.

Declaration

protected RangeBase(RangeBase<T> range, IMath<T> math)

Parameters

Type	Name	Description
RangeBase<T>	range	The RangeBase instance to initialize new range with.
IMath<T>	math	The generic IMath helper.

Fields

math

Declaration

protected final IMath<T> math

Field Value

Type	Description
IMath<T>

Methods

addRangeChangeObserver(IRangeChangeObserver<T> observer)

Adds IRangeChangeObserver instance to listen changes of this IRange instance

Declaration

public final void addRangeChangeObserver(IRangeChangeObserver<T> observer)

Parameters

Type	Name	Description
IRangeChangeObserver<T>	observer

clipTo(IRange<T> maximumRange)

Clips the current com.scichart.data.model.IRange to a maximum range with MinMax mode

Declaration

public final void clipTo(IRange<T> maximumRange)

Parameters

Type	Name	Description
IRange<T>	maximumRange

clipTo(IRange<T> maximumRange, RangeClipMode clipMode)

Clips the current com.scichart.data.model.IRange to a maximum according to clip mode

Declaration

public final void clipTo(IRange<T> maximumRange, RangeClipMode clipMode)

Parameters

Type	Name	Description
IRange<T>	maximumRange
RangeClipMode	clipMode

clone()

Creates and returns a copy of this object

Declaration

public abstract IRange<T> clone()

Returns

Type	Description
IRange<T>

Overrides

Object.clone()

Exceptions

Type	Condition
CloneNotSupportedException

equals(Object o)

Declaration

public boolean equals(Object o)

Parameters

Type	Name	Description
Object	o

Returns

Type	Description
boolean

Overrides

Object.equals(Object)

getDiff()

Gets the difference (max - min) of this range

Declaration

public T getDiff()

Returns

Type	Description
T

getIsDefined()

Gets whether this Range is defined

Declaration

public boolean getIsDefined()

Returns

Type	Description
boolean

getIsMinMaxValid()

Gets whether the min and max value are valid ( min <= max )

Declaration

public final boolean getIsMinMaxValid()

Returns

Type	Description
boolean

getIsZero()

Gets whether the range is Zero, where max equals min

Declaration

public boolean getIsZero()

Returns

Type	Description
boolean

getMath()

Gets the IMath associated with this range

Declaration

public final IMath<T> getMath()

Returns

Type	Description
IMath<T>

getMax()

Gets the max value of this range

Declaration

public final T getMax()

Returns

Type	Description
T

getMin()

Gets the min value of this range

Declaration

public final T getMin()

Returns

Type	Description
T

hashCode()

Declaration

public int hashCode()

Returns

Type	Description
int

Overrides

Object.hashCode()

isValueWithinRange(T value)

Returns true if the value is within the min and max of the Range

Declaration

public final boolean isValueWithinRange(T value)

Parameters

Type	Name	Description
T	value

Returns

Type	Description
boolean

removeRangeChangeObserver(IRangeChangeObserver<T> observer)

Removes IRangeChangeObserver instance from list of change listeners for this IRange instance

Declaration

public final synchronized void removeRangeChangeObserver(IRangeChangeObserver<T> observer)

Parameters

Type	Name	Description
IRangeChangeObserver<T>	observer

set(IRange<T> range)

Sets the min, max values on the com.scichart.data.model.IRange with a range

Declaration

public final void set(IRange<T> range)

Parameters

Type	Name	Description
IRange<T>	range

setMax(T max)

Sets the max value of this range

Declaration

public final void setMax(T max)

Parameters

Type	Name	Description
T	max

setMin(T min)

Sets the min value of this range

Declaration

public final void setMin(T min)

Parameters

Type	Name	Description
T	min

setMinMax(T min, T max)

Sets the min, max values on the com.scichart.data.model.IRange

Declaration

public final void setMinMax(T min, T max)

Parameters

Type	Name	Description
T	min
T	max

setMinMaxDouble(double min, double max)

Sets the min, max values on the com.scichart.data.model.IRange

Declaration

public final void setMinMaxDouble(double min, double max)

Parameters

Type	Name	Description
double	min
double	max

setMinMaxDoubleForced(double min, double max)

Sets the min, max values on the com.scichart.data.model.IRange without equals checks

Declaration

public final void setMinMaxDoubleForced(double min, double max)

Parameters

Type	Name	Description
double	min
double	max

setMinMaxForced(T min, T max)

Sets the min, max values on the com.scichart.data.model.IRange without equals checks

Declaration

public final void setMinMaxForced(T min, T max)

Parameters

Type	Name	Description
T	min
T	max

setMinMaxWithLimit(double min, double max, IRange<T> maximumRange)

Sets the min, max values on the com.scichart.data.model.IRange with a max range to clip values to

Declaration

public final void setMinMaxWithLimit(double min, double max, IRange<T> maximumRange)

Parameters

Type	Name	Description
double	min
double	max
IRange<T>	maximumRange

toString()

Declaration

public String toString()

Returns

Type	Description
String

Overrides

Object.toString()

union(T min, T max)

Performs the union of two com.scichart.data.model.IRange instances

Declaration

public final void union(T min, T max)

Parameters

Type	Name	Description
T	min
T	max

union(IRange<T> range)

Performs the union of two com.scichart.data.model.IRange instances

Declaration

public final void union(IRange<T> range)

Parameters

Type	Name	Description
IRange<T>	range

Implements

com.scichart.data.model.IRange<T>