Package org.yamcs.parameterarchive

Class MultiSegmentIterator

java.lang.Object

org.yamcs.parameterarchive.MultiSegmentIterator

All Implemented Interfaces:

AutoCloseable, ParchiveIterator<MultiParameterValueSegment>, PeekingIterator<MultiParameterValueSegment>

public class MultiSegmentIterator
extends Object
implements ParchiveIterator<MultiParameterValueSegment>

Same as SegmentIterator but provides segments for multiple parameters from the same group in one step.

Since Yamcs 5.9.4, with the introduction of the sparseGroup, some segments in the returned MultiParameterValueSegment may be null if they contain no data

Constructor Summary

Constructors

Constructor	Description
MultiSegmentIterator(ParameterArchive parchive, ParameterId[] pids, int parameterGroupId, ParameterRetrievalOptions req)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying rocks iterator if not already closed
int	getParameterGroupId()
boolean	isValid()	Returns true if the iterator has more elements.
void	next()	Moves the iterator to the next element.
MultiParameterValueSegment	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

MultiSegmentIterator

public MultiSegmentIterator(ParameterArchive parchive,
 ParameterId[] pids,
 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<MultiParameterValueSegment>

Returns:

true if the iterator has more elements or false otherwise

value

public MultiParameterValueSegment 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 PeekingIterator<MultiParameterValueSegment>

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<MultiParameterValueSegment>

close

public void close()

Close the underlying rocks iterator if not already closed

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ParchiveIterator<MultiParameterValueSegment>

getParameterGroupId

public int getParameterGroupId()