Package hec.geometry

Class TSAxisIterator

java.lang.Object

hec.geometry.AxisIterator

hec.geometry.TSAxisIterator

Direct Known Subclasses:

SeasonalAxisIterator

public class TSAxisIterator
extends AxisIterator

An iterator class for stepping across a time series axis at a fixed interval.

Constructor Summary

Constructors

Constructor	Description
TSAxisIterator(TSAxis ax, double del)	Constructor
TSAxisIterator(TSAxis ax, double del, int units, int pos)
TSAxisIterator(TSAxis ax, int ldel)
TSAxisIterator(TSAxis ax, int ldel, int units, int pos)

Method Summary

Modifier and Type	Method	Description
boolean	getGoAgain()
int	getLocalValue()
double	getValue()
String	getValueString()
String	getValueStringLong()
boolean	next()	moves iterator to next position
void	reset()	resets iterator to beginning of range
void	setInterval(double del)
void	setPeriodPosition(int periodPosition)

Methods inherited from class hec.geometry.AxisIterator

getInterval, getLocalInterval, getScaledValue, getSigFig, iterateMinorScale, setLocalInterval

Methods inherited from class java.lang.Object

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

Constructor Details

TSAxisIterator

public TSAxisIterator(TSAxis ax,
 double del)

Constructor

TSAxisIterator

public TSAxisIterator(TSAxis ax,
 double del,
 int units,
 int pos)

TSAxisIterator

public TSAxisIterator(TSAxis ax,
 int ldel)

TSAxisIterator

public TSAxisIterator(TSAxis ax,
 int ldel,
 int units,
 int pos)

Method Details

setPeriodPosition

public void setPeriodPosition(int periodPosition)

reset

public void reset()

resets iterator to beginning of range

Overrides:

reset in class AxisIterator

setInterval

public void setInterval(double del)

Overrides:

setInterval in class AxisIterator

next

public boolean next()

moves iterator to next position

Overrides:

next in class AxisIterator

getValue

public double getValue()

Overrides:

getValue in class AxisIterator

getLocalValue

public int getLocalValue()

Overrides:

getLocalValue in class AxisIterator

getValueString

public String getValueString()

Overrides:

getValueString in class AxisIterator

getValueStringLong

public String getValueStringLong()

getGoAgain

public boolean getGoAgain()