Package hec.map.flo2d

Class Flo2dDepthMap

java.lang.Object

hec.map.MapObject

hec.map.flo2d.Flo2dDepthMap

All Implemented Interfaces:

ElevationMap, Flo2dMap, GridMap, MapObjectInterface, Serializable

public class Flo2dDepthMap
extends MapObject
implements MapObjectInterface, GridMap, Flo2dMap

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	_maxElev
protected double	_minElev

Fields inherited from class hec.map.MapObject

_debug, _extent, _fileOpener, _loaded, _mapId, mCoordinateReferencySystem

Constructor Summary

Constructors

Constructor	Description
Flo2dDepthMap()
Flo2dDepthMap(MapIdentifier id)
Flo2dDepthMap(String path)

Method Summary

Modifier and Type	Method	Description
Flo2dCell	findCell(double e, double n)
Flo2dCell	findCell(WorldPt pt)
int	getCell(WorldPt wpt)
List<Flo2dCell>	getCells()
float[]	getElevation(double[] northing, double[] easting)	Retruns an array of elevations for an array of northin/easting points.
float	getElevation(WorldPt pt)	Returns the elevation at the given World point.
WorldRect	getExtent()	Gets the Extent attribute of the MapObjectInterface object
WorldRect	getGridCellSize()
double	getMaximumElevation()
double	getMinimumElevation()
double	getNoDataValue()	Returns the value that represents an UNDEFINED elevation in the map.
void	load()	Method to tell the Map Object to load its data into memory
boolean	readFile(MapIdentifier shpId)
boolean	supportsNoDataValue()
void	unload()	Method to tell the Map Object to unload, because the map is done

Methods inherited from class hec.map.MapObject

equals, getCoordinateInfo, getCoordinateReferenceSystem, getFilenames, getFileOpener, getMapIdentifier, getName, mapIdentifierEquals, newFile, newThenOpenFile, openFile, readProjection, setExtent, setFileOpener, setMapIdentifier, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface hec.map.ElevationMap

getName

Methods inherited from interface hec.map.MapObjectInterface

getCoordinateReferenceSystem, getMapIdentifier, setExtent, setMapIdentifier

Field Details

_maxElev

protected double _maxElev

_minElev

protected double _minElev

Constructor Details

Flo2dDepthMap

public Flo2dDepthMap()

Flo2dDepthMap

public Flo2dDepthMap(String path)

Flo2dDepthMap

public Flo2dDepthMap(MapIdentifier id)

Method Details

getExtent

public WorldRect getExtent()

Description copied from interface: MapObjectInterface

Gets the Extent attribute of the MapObjectInterface object

Specified by:

getExtent in interface MapObjectInterface

Overrides:

getExtent in class MapObject

Returns:

The Extent value

load

public void load()
          throws IOException

Description copied from interface: MapObjectInterface

Method to tell the Map Object to load its data into memory

Specified by:

load in interface MapObjectInterface

Specified by:

load in class MapObject

Throws:

IOException - Description of Exception

readFile

public boolean readFile(MapIdentifier shpId)

unload

public void unload()

Description copied from interface: MapObjectInterface

Method to tell the Map Object to unload, because the map is done

Specified by:

unload in interface MapObjectInterface

Specified by:

unload in class MapObject

getGridCellSize

public WorldRect getGridCellSize()

Specified by:

getGridCellSize in interface GridMap

getNoDataValue

public double getNoDataValue()

Description copied from interface: ElevationMap

Returns the value that represents an UNDEFINED elevation in the map.

Specified by:

getNoDataValue in interface ElevationMap

Specified by:

getNoDataValue in interface GridMap

supportsNoDataValue

public boolean supportsNoDataValue()

Specified by:

supportsNoDataValue in interface GridMap

getElevation

public float getElevation(WorldPt pt)

Description copied from interface: ElevationMap

Returns the elevation at the given World point. If there is no elvation defined, the the "No Data Value" is returned.

Specified by:

getElevation in interface ElevationMap

findCell

public Flo2dCell findCell(WorldPt pt)

findCell

public Flo2dCell findCell(double e,
 double n)

getElevation

public float[] getElevation(double[] northing,
 double[] easting)

Description copied from interface: ElevationMap

Retruns an array of elevations for an array of northin/easting points. Northing/Easting array values are paired northing[0],easting[0], etc to make one point. Throws an invalid value exception if the northing/easting arrays are not the same size.

Specified by:

getElevation in interface ElevationMap

Returns:

array of elevation points. The elevation value elevation[n] was derived using the point (easting[n],northing[n]).

getMaximumElevation

public double getMaximumElevation()

Specified by:

getMaximumElevation in interface ElevationMap

getMinimumElevation

public double getMinimumElevation()

Specified by:

getMinimumElevation in interface ElevationMap

getCells

public List<Flo2dCell> getCells()

Specified by:

getCells in interface Flo2dMap

getCell

public int getCell(WorldPt wpt)

Specified by:

getCell in interface Flo2dMap

Returns: