de.toem.impulse.samples

Interface ISamplesIterator

All Superinterfaces:

java.util.Iterator<Long>

public interface ISamplesIterator
extends java.util.Iterator<Long>

Interface for sample iterators.

Method Summary

Modifier and Type	Method and Description
long	current() Returns position of current sample.
DomainValue	getCurrentPosition() Returns position of current sample.
IDomainBase	getDomainBase() Returns domain base.
long	getEnd() Returns end units of iterator.
DomainValue	getEndPosition() Returns end position of iterator.
long	getStart() Returns start units of iterator.
DomainValue	getStartPosition() Returns start position of iterator.
boolean	hasPrev() Returns true if there is a previous sample.
boolean	isCurrent(ISamplePointer samples) Returns true if samples is at current position.
Long	next() Goto next sample.
boolean	next(ISamplePointer samples) Goto next sample of 'samples'.
boolean	nextEdge(ISamplePointer samples, int edge) Goto next edge.
boolean	nextEdge(ISamplePointer samples, int edge, ILogicDetector detector)
Long	prev() Goto previous sample.
boolean	prev(ISamplePointer samples) Goto previous sample of 'samples'.
boolean	prevEdge(ISamplePointer samples, int edge) Goto previous edge.
boolean	prevEdge(ISamplePointer samples, int edge, ILogicDetector detector)
void	setCurrent(DomainValue position, boolean iterationStart) Sets the current position to 'position'.
void	setCurrent(long units, boolean iterationStart) Sets the current position to 'units'.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, remove

Method Detail

hasPrev

boolean hasPrev()

Returns true if there is a previous sample.

prev

Long prev()

Goto previous sample.

Returns:

Position if the previous sample.

next

Long next()

Goto next sample.

Specified by:

next in interface java.util.Iterator<Long>

Returns:

Position of the next sample.

current

long current()

Returns position of current sample.

setCurrent

void setCurrent(long units,
                boolean iterationStart)

Sets the current position to 'units'.

Parameters:

units - Domain position as a multiple of its domain base (e.g. domain base=1ms; units = 100; -> domain value = 100ms).

iterationStart - If true, next prev() or next() will return current sample position.

isCurrent

boolean isCurrent(ISamplePointer samples)

Returns true if samples is at current position.

setCurrent

void setCurrent(DomainValue position,
                boolean iterationStart)

Sets the current position to 'position'.

Parameters:

position -

iterationStart - If true, next prev() or next() will return current sample position.

getDomainBase

IDomainBase getDomainBase()

Returns domain base.

getStart

long getStart()

Returns start units of iterator.

getEnd

long getEnd()

Returns end units of iterator.

getCurrentPosition

DomainValue getCurrentPosition()

Returns position of current sample.

getStartPosition

DomainValue getStartPosition()

Returns start position of iterator.

getEndPosition

DomainValue getEndPosition()

Returns end position of iterator.

prev

boolean prev(ISamplePointer samples)

Goto previous sample of 'samples'.

Returns:

True if available.

next

boolean next(ISamplePointer samples)

Goto next sample of 'samples'.

Returns:

True if available.

prevEdge

boolean prevEdge(ISamplePointer samples,
                 int edge)

Goto previous edge.

Returns:

True if detected.

prevEdge

boolean prevEdge(ISamplePointer samples,
                 int edge,
                 ILogicDetector detector)

nextEdge

boolean nextEdge(ISamplePointer samples,
                 int edge)

Goto next edge.

Returns:

True if detected.

nextEdge

boolean nextEdge(ISamplePointer samples,
                 int edge,
                 ILogicDetector detector)