Package hec.geometry

Class LogAxisIterator

java.lang.Object

hec.geometry.AxisIterator

hec.geometry.LogAxisIterator

public class LogAxisIterator
extends AxisIterator

This iterates over a Logarithmic axis, returning the point of each tic mark

Since:

September 28, 2000

See Also:

• AxisIterator
• TSAxisIterator
• SeasonalAxisIterator

Constructor Summary

Constructors

Constructor	Description
LogAxisIterator(LogAxis ax, double del)	Constructor for the iterator.

Method Summary

Modifier and Type	Method	Description
int	getLocalValue()
double	getValue()
String	getValueString()	Returns the value of the label for that tic mark at the given position
void	iterateMinorScale()	Sets the Iterator to iterate the log minor scale
boolean	next()	Positions the iterator at the next available tic marc
void	reset()	Resets the iterator to an initial state, where it points to the begining of the Axis it iterates over

Methods inherited from class hec.geometry.AxisIterator

getInterval, getLocalInterval, getScaledValue, getSigFig, setInterval, setLocalInterval

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LogAxisIterator

public LogAxisIterator(LogAxis ax,
 double del)

Constructor for the iterator.

Parameters:

ax - A reference to the axis to iterate over

del - The spacing between each tic mark. For the log axis iterator this only works for Major tic marc which are evenly spaced. The minor tic marks are not evenly spaced but rather spaced according to a logarithmic scale.

Method Details

iterateMinorScale

public void iterateMinorScale()

Sets the Iterator to iterate the log minor scale

Overrides:

iterateMinorScale in class AxisIterator

getValueString

public String getValueString()

Returns the value of the label for that tic mark at the given position

Overrides:

getValueString in class AxisIterator

next

public boolean next()

Positions the iterator at the next available tic marc

Overrides:

next in class AxisIterator

Returns:

true if there is a next tic mark. false if we moved passed the end of the axis

reset

public void reset()

Resets the iterator to an initial state, where it points to the begining of the Axis it iterates over

Overrides:

reset in class AxisIterator

getValue

public double getValue()

Overrides:

getValue in class AxisIterator

getLocalValue

public int getLocalValue()

Overrides:

getLocalValue in class AxisIterator