ucar.nc2.ft

Interface ProfileFeatureCollection

All Superinterfaces:

FeatureCollection, NestedPointFeatureCollection

All Known Implementing Classes:

StandardProfileCollectionImpl

public interface ProfileFeatureCollection
extends NestedPointFeatureCollection

A collection of ProfileFeature.

Since:

Mar 19, 2008

Author:

caron

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Use the internal iterator to check if there is another ProfileFeature in the iteration.
ProfileFeature	next() Use the internal iterator to get the next ProfileFeature in the iteration.
void	resetIteration() Reset the internal iterator for another iteration over the ProfileFeatures in this Collection.
ProfileFeatureCollection	subset(LatLonRect boundingBox) Subset this collection by boundingBox

Methods inherited from interface ucar.nc2.ft.NestedPointFeatureCollection

flatten, flatten, getAltUnits, getExtraVariables, getNestedPointFeatureCollectionIterator, getPointFeatureCollectionIterator, getTimeUnit, isMultipleNested, size

Methods inherited from interface ucar.nc2.ft.FeatureCollection

getCollectionFeatureType, getName

Method Detail

hasNext

boolean hasNext()
                throws IOException

Use the internal iterator to check if there is another ProfileFeature in the iteration.

Returns:

true is there is another ProfileFeature in the iteration.

Throws:

IOException - on read error

next

ProfileFeature next()
                    throws IOException

Use the internal iterator to get the next ProfileFeature in the iteration. You must call hasNext() before you call this.

Returns:

the next ProfileFeature in the iteration

Throws:

IOException - on read error

resetIteration

void resetIteration()
                    throws IOException

Reset the internal iterator for another iteration over the ProfileFeatures in this Collection.

Throws:

IOException - on read error

subset

ProfileFeatureCollection subset(LatLonRect boundingBox)
                                throws IOException

Subset this collection by boundingBox

Specified by:

subset in interface NestedPointFeatureCollection

Parameters:

boundingBox - want only profiles in this lat/lon bounding box.

Returns:

subsetted collection, may be null if empty

Throws:

IOException - on read error