com.highqsoft.interfaces.p2d

Interface P2DRange1DInterface

All Superinterfaces:

FwkInterface, java.io.Serializable

All Known Implementing Classes:

P2DRange1D

public interface P2DRange1DInterface
extends FwkInterface

The Range1D object represents a one dimensional range value.

Since:

$Date: 2017/04/06 13:30:05 $

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(double value) This method checks whether the range contains the given point.
boolean	equals(P2DRange1DInterface r) Compare this range with the given.
double	getDistance() Returns the distance of the range.
double	getLower() Retrieves the lower limit of the range.
double	getMinPositiveValue() Get the lowest value that is greater than 0.
double[]	getNiceNumbers(double base, boolean isLog, int ticks_requested) Get the nicenumber vector of Double's from axis.
java.lang.String	getParams() Get the parameter string.
double	getUpper() Retrieves the upper limit of the range.
void	move(double distance) Move the range.
void	setDefaults() Set all the internal properties to the default.
void	setDistance(double distance) Sets the length of the range.
void	setLower(double lower) Sets the lower limit of the range.
void	setMinPositiveValue(double minPositiveValue) Set the lowest value that is greater than 0.
void	setRange(double lower, double upper) Set the range.
void	setUpper(double upper) Sets the upper limit of the range.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Method Detail

contains

boolean contains(double value)

This method checks whether the range contains the given point.

Parameters:

value - The value to be checked.

Returns:

true if the given point is included by this range.

getLower

double getLower()

Retrieves the lower limit of the range.

Returns:

The lower limit of the range.

See Also:

getUpper(), getDistance()

getMinPositiveValue

double getMinPositiveValue()

Get the lowest value that is greater than 0. This method is needed for logarithmn use.

Returns:

the lowest value that is greater than 0. If no value is greater than 0 the method returns Double.NaN.

setMinPositiveValue

void setMinPositiveValue(double minPositiveValue)

Set the lowest value that is greater than 0. This method is needed for logarithmn use.

Parameters:

minPositiveValue - the lowest value that is greater than 0. If no value is greater than 0 the method returns Double.NaN.

setRange

void setRange(double lower,
            double upper)

Set the range.

Parameters:

lower - The new lower limit of the range.

upper - The new upper limit of the range.

setLower

void setLower(double lower)

Sets the lower limit of the range. If the new lower limit is greater than the current upper limit the two values will be swapped.

Parameters:

lower - The new lower limit of the range.

See Also:

setUpper(double), setDistance(double)

getUpper

double getUpper()

Retrieves the upper limit of the range.

Returns:

The upper limit of the range.

See Also:

getLower(), getDistance()

setUpper

void setUpper(double upper)

Sets the upper limit of the range. If the new upper limit is lower than the current lower limit the two values will be swapped.

Parameters:

lower - The new lower limit of the range.

See Also:

setUpper(double), setDistance(double)

getDistance

double getDistance()

Returns the distance of the range. The retrieved value is always greater the null.

Returns:

The upper limit of the range.

See Also:

getLower(), getUpper()

setDistance

void setDistance(double distance)

Sets the length of the range. This routine sets the upper limit to the sum of the incoming parameter and the lower limit. A negative distance is allowed, it will swap the the lmits.

Parameters:

lower - The new lower limit of the range.

See Also:

setLower(double), setUpper(double)

move

void move(double distance)

Move the range.

Parameters:

distance - The value of the distance.

equals

boolean equals(P2DRange1DInterface r)

Compare this range with the given.

Parameters:

r - The range that should be compared to this.

Returns:

true if the given range is equal to this one.

getParams

java.lang.String getParams()

Get the parameter string.

setDefaults

void setDefaults()

Set all the internal properties to the default.

getNiceNumbers

double[] getNiceNumbers(double base,
                      boolean isLog,
                      int ticks_requested)

Get the nicenumber vector of Double's from axis.

Parameters:

base - The log base. If <= 1 then 10.

isLog - A boolean indicates that the scale should be logarithmic.

ticks_requested - The total number of requested tick values. If this parameter is 0 the routine will optimized the value.