Package hec.heclib.grid

Class SpecifiedGridInfo

java.lang.Object

hec.heclib.grid.GridInfo

hec.heclib.grid.SpecifiedGridInfo

All Implemented Interfaces:

Serializable

public class SpecifiedGridInfo
extends GridInfo

The SpecifiedGridInfo class inherits from GridInfo, extending the grid metadata to support any coordinate system, and adding new metadata fields that HEC has determined would be useful since the original GridInfo was defined in 1994. The new data fields are: _srsName (String) The name of the spatial reference system (SRS) for the grid. _srsDefinition (String) A complete spatial reference identifier in a text of arbitrary length. For present use, we are populating this field with a Spatial Reference Identifier in well-known text (WKT) format. _xCoordOfGridCellZero (float) The x coordinate value, in the SRS, of the lower left corner (not the center) of cell (0, 0). _yCoordOfGridCellZero (float) The y coordinate value, in the SRS, of the lower left corner (not the center) of cell (0, 0). _nullValue (float) the value used in the grid's data array to represent a "no data" cell. _timeZoneID (String) a name for the time zone that applies to the data in the grid. _timeZoneRawOffset (int) Offset in milliseconds from UTC. _isTimeStamped (boolean) false for data that is time-invariant (e.g. grids of stable parameters, like ground elevation). _isTSElement (boolean) false for data that is time-invariant (e.g. grids of stable parameters, like ground elevation). _isInterval (boolean) false for instantaneous values, true for period data. In addition, the GridInfo version number is explicitly stored in the header of the DSS record, and the compression method defaults to ZLIB's deflate method

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.heclib.grid.GridInfo

DSS7_GRID_STRUCT_VERSION, GRID_NODATA_VALUE, GRID_STRUCT_VERSION_UNDEFINED, NAD_27, NAD_83

Constructor Summary

Constructors

Constructor	Description
SpecifiedGridInfo()	Default constructor
SpecifiedGridInfo(SpecifiedGridInfo si)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
int	convertToGridInfo(GridInfoFlat s1)
int	convertToGridInfo(SpecifiedGridInfoFlat sif)
int	convertToSridInfo(SpecifiedGridInfoFlat sif)
boolean	equals(Object obj)
int	flatSize()	public int flatSize(){ returns size in bytes
String	getSpatialReferenceSystem()
float	getXCoordOfGridCellZero()
float	getYCoordOfGridCellZero()
SpecifiedGridInfoFlat	makeGridInfoFlat()
SpecifiedGridInfoFlat	makeGridInfoFlat(SpecifiedGridInfoFlat a)
void	set(SpecifiedGridInfo si)
void	setCoordOfGridCellZero(float x, float y)
int	setSpatialReference(String srsName, String srsDefinition, float xOrigin, float yOrigin)
void	show(BufferedWriter out)
String	toString()

Methods inherited from class hec.heclib.grid.GridInfo

copy, getCellSize, getCompressionBase, getCompressionMethod, getCompressionScaleFactor, getDataType, getDataTypeName, getDataUnits, getEndTime, getEndTimeFromPath, getGridInfoSize, getGridNodataValue, getGridType, getInfoSize, getLowerLeftCellX, getLowerLeftCellY, getMaxDataValue, getMaxValue, getMeanDataValue, getMeanValue, getMinDataValue, getMinValue, getNad27, getNad83, getNumberOfCellsX, getNumberOfCellsY, getNumEqual, getPrecip2Byte, getRange, getRangeLimitTable, getRangeNum, getSizeOfCompressedElements, getStartTime, getStartTimeFromPath, getTimePeriod, getUndefinedCompressionMethod, getUndefinedProjectionDatum, getVersion, getZlibDeflate, loadFlatData, set, setCellInfo, setCompressionInfo, setCompressionMethod, setDataInfo, setDataType, setDataUnits, setGridTimes, setGridTimes, setGridTimes, setGridType, setMaxDataValue, setParameterInfo, setRangeInfo, setVerboseMode, show, show, showRanges

Methods inherited from class java.lang.Object

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

Constructor Details

SpecifiedGridInfo

public SpecifiedGridInfo()

Default constructor

SpecifiedGridInfo

public SpecifiedGridInfo(SpecifiedGridInfo si)

Copy Constructor. Makes a copy of given GridInfo object.

Parameters:

si -

Method Details

convertToGridInfo

public int convertToGridInfo(GridInfoFlat s1)

Overrides:

convertToGridInfo in class GridInfo

convertToGridInfo

public int convertToGridInfo(SpecifiedGridInfoFlat sif)

convertToSridInfo

public int convertToSridInfo(SpecifiedGridInfoFlat sif)

show

public void show(BufferedWriter out)

Overrides:

show in class GridInfo

setSpatialReference

public int setSpatialReference(String srsName,
 String srsDefinition,
 float xOrigin,
 float yOrigin)

getSpatialReferenceSystem

public String getSpatialReferenceSystem()

Overrides:

getSpatialReferenceSystem in class GridInfo

getXCoordOfGridCellZero

public float getXCoordOfGridCellZero()

getYCoordOfGridCellZero

public float getYCoordOfGridCellZero()

setCoordOfGridCellZero

public void setCoordOfGridCellZero(float x,
 float y)

flatSize

public int flatSize()

public int flatSize(){ returns size in bytes

Overrides:

flatSize in class GridInfo

makeGridInfoFlat

public SpecifiedGridInfoFlat makeGridInfoFlat(SpecifiedGridInfoFlat a)

makeGridInfoFlat

public SpecifiedGridInfoFlat makeGridInfoFlat()

set

public void set(SpecifiedGridInfo si)

equals

public boolean equals(Object obj)

Overrides:

equals in class GridInfo

toString

public String toString()

Overrides:

toString in class GridInfo