Package hec.map.tms

Class TmsMap

java.lang.Object

hec.map.MapObject

hec.map.tms.TmsMap

All Implemented Interfaces:

ElevationMap, GridMap, MapObjectInterface, Serializable

public class TmsMap
extends MapObject
implements GridMap

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.map.MapObject

_debug, _extent, _fileOpener, _loaded, _mapId, mCoordinateReferencySystem

Constructor Summary

Constructors

Constructor	Description
TmsMap()
TmsMap(MapIdentifier mapId)
TmsMap(String filePath)

Method Summary

Modifier and Type	Method	Description
void	clearImage()
int	getAreaHeight()
int	getAreaWidth()
WorldRect	getCurrentLevelExtent()
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	getGridCellSize()
TmsImage	getImage(MapScale scale, TmsGlyphDataRecord gdr)
double	getMaximumElevation()
double	getMinimumElevation()
double	getNoDataValue()	Returns the value that represents an UNDEFINED elevation in the map.
int	getNumberOfLevels()
List<Tile>	getTilesFor(MapScale scale)
void	load()	Method to tell the Map Object to load its data into memory
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, getExtent, 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, getExtent, getMapIdentifier, setExtent, setMapIdentifier

Constructor Details

TmsMap

public TmsMap()

TmsMap

public TmsMap(String filePath)

TmsMap

public TmsMap(MapIdentifier mapId)

Method Details

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

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

getTilesFor

public List<Tile> getTilesFor(MapScale scale)

getNumberOfLevels

public int getNumberOfLevels()

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

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

supportsNoDataValue

public boolean supportsNoDataValue()

Specified by:

supportsNoDataValue 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

getGridCellSize

public WorldRect getGridCellSize()

Specified by:

getGridCellSize in interface GridMap

getAreaWidth

public int getAreaWidth()

Returns:

getAreaHeight

public int getAreaHeight()

Returns:

getImage

public TmsImage getImage(MapScale scale,
 TmsGlyphDataRecord gdr)

getCurrentLevelExtent

public WorldRect getCurrentLevelExtent()

Returns:

clearImage

public void clearImage()