Module org.yamcs.core

Package org.yamcs.parameterarchive

Class SimpleParameterIterator

java.lang.Object

org.yamcs.parameterarchive.SimpleParameterIterator

All Implemented Interfaces:

AutoCloseable, ParameterIterator, ParchiveIterator<TimedValue>, PeekingIterator<TimedValue>

public class SimpleParameterIterator
extends Object
implements ParameterIterator

For a given parameter id and group id, iterates over all parameters in the parameter archive (across all segments and partitions).

Provides objects of type TimedValue.

It embeds an SegmentIterator object.

Constructor Summary

Constructors

Constructor	Description
SimpleParameterIterator(ParameterArchive parchive, ParameterId parameterId, int parameterGroupId, ParameterRetrievalOptions req)

Method Summary

Modifier and Type	Method	Description
void	close()
int	getParameterGroupId()
ParameterId	getParameterId()
boolean	isValid()	Returns true if the iterator has more elements.
void	next()	Moves the iterator to the next element.
TimedValue	value()	Returns the current value from the iterator without advancing.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleParameterIterator

public SimpleParameterIterator(ParameterArchive parchive,
 ParameterId parameterId,
 int parameterGroupId,
 ParameterRetrievalOptions req)

Method Details

isValid

public boolean isValid()

Description copied from interface: PeekingIterator

Returns true if the iterator has more elements.

This method allows to verify whether the iterator has a valid value to be fetched.

Specified by:

isValid in interface PeekingIterator<TimedValue>

Returns:

true if the iterator has more elements or false otherwise

value

public TimedValue value()

Description copied from interface: PeekingIterator

Returns the current value from the iterator without advancing.

This method can only be called if PeekingIterator.isValid() returns true. If called after PeekingIterator.isValid() returns false, this method will throw an exception.

Specified by:

value in interface ParameterIterator

Specified by:

value in interface PeekingIterator<TimedValue>

Returns:

the current element

next

public void next()

Description copied from interface: PeekingIterator

Moves the iterator to the next element.

If PeekingIterator.isValid() returns false, calling this method has no effect.

Specified by:

next in interface PeekingIterator<TimedValue>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ParchiveIterator<TimedValue>

getParameterId

public ParameterId getParameterId()

Specified by:

getParameterId in interface ParameterIterator

getParameterGroupId

public int getParameterGroupId()

Specified by:

getParameterGroupId in interface ParameterIterator