Package hec.heclib.grid

Class GriddedData

java.lang.Object

hec.heclib.dss.HecDSSFileAccess

hec.heclib.dss.HecDssCatalog

hec.heclib.dss.HecDSSDataAttributes

hec.heclib.dss.HecDataManager

hec.heclib.grid.GriddedData

All Implemented Interfaces:

HecDssListener, Serializable, AutoCloseable, Cloneable, EventListener

public class GriddedData
extends HecDataManager
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hec.heclib.dss.HecDssCatalog

HecDssCatalog.WriteCatalogFileRunnable

Field Summary

Fields inherited from class hec.heclib.dss.HecDataManager

_recordData, DSS_ERROR, DSS_FILE_ERROR, DSS_SEVERE_ERROR, STATUS_DATA_ERROR

Fields inherited from class hec.heclib.dss.HecDSSDataAttributes

_arrayEndTime, _arraySize, _arrayStartTime, _checkedNumber, _dataLengthInts, _dataType, _defaultEndTime, _defaultStartTime, _desiredArraySize, _dirty, _dssPathname, _endTime, _localUnitSystem, _recordExists, _recordType, _slashPosition, _startTime, _timeSeries, _timeWindowSet, _typeX, _unitsX, ALBERS, ALBERS_GRID, ALBERS_GRID_WITH_TIME, DOUBLE_ARRAY, ENGLISH_UNITS, ERROR, FILE, FLOAT_ARRAY, HRAP, HRAP_GRID, HRAP_GRID_WITH_TIME, IMAGE, INT_ARRAY, IRREGULAR_TIME_PATTERN, IRREGULAR_TIME_SERIES, IRREGULAR_TIME_SERIES_DOUBLES, LOCATION_LEVEL, PAIRED, PAIRED_DOUBLES, REGULAR_TIME_PATTERN, REGULAR_TIME_SERIES, REGULAR_TIME_SERIES_DOUBLES, SI_UNITS, SINGLE_VALUE, SPECIFIED_GRID, SPECIFIED_GRID_TYPE, SPECIFIED_GRID_WITH_TIME, TEXT, UNDEFINED_GRID, UNDEFINED_GRID_TYPE, UNDEFINED_GRID_WITH_TIME, UNDEFINED_UNITS, UNKNOWN

Fields inherited from class hec.heclib.dss.HecDssCatalog

_catalogName, _forceNewCatalog, _listenerList, _observerThreads, _useCollectionGroups, crcValues, dataTypeEnd, dataTypeStart, endDates, lastWriteTimeFile, lastWriteTimeRecord, listIsCollection, listIsComplete, listIsSorted, maxNumberToRetrieve, pathnameAddresses, pathnameHash, pathnameList, pathnameWithWild, startDates, statusRead, statusWanted

Fields inherited from class hec.heclib.dss.HecDSSFileAccess

_defaultDirectory, _defaultDSSFileName, _fileData, _maxNumberReopensForError, _numberReopensForError, _severeErrorIndex, _severeErrorMessages, _severeErrorRaised, ABBREVIATED_CATALOG, CONDENSED_CATALOG, FULL_CATALOG, MESS_LEVEL_CRITICAL, MESS_LEVEL_GENERAL, MESS_LEVEL_INTERNAL_DIAG_1, MESS_LEVEL_INTERNAL_DIAG_2, MESS_LEVEL_NONE, MESS_LEVEL_TERSE, MESS_LEVEL_USER_DIAG, MESS_METHOD_ALIAS, MESS_METHOD_CATALOG, MESS_METHOD_CHECK, MESS_METHOD_COPY, MESS_METHOD_FILE_CHECK, MESS_METHOD_GENERAL, MESS_METHOD_GET, MESS_METHOD_GLOBAL, MESS_METHOD_JNI, MESS_METHOD_LOCKING, MESS_METHOD_OPEN, MESS_METHOD_PERM, MESS_METHOD_PUT, MESS_METHOD_READ, MESS_METHOD_TS_READ, MESS_METHOD_TS_WRITE, MESS_METHOD_UTILITY, MESS_METHOD_WRITE

Constructor Summary

Constructors

Constructor	Description
GriddedData()
GriddedData(boolean verbose)	Deprecated. use constructor without verbose argument

Method Summary

Modifier and Type	Method	Description
String	DSSFileName(boolean useDefault)
int	getGridStructVersion()
void	printArray(float[] X)
protected int	readStructGrids(GridStructContainer gridContainer, boolean retrieveData, int[] status)
protected GridInfo	retrieveGriddedContainer(boolean dataWanted, GridData gridData, int[] status)
GridInfo	retrieveGriddedData()
GridInfo	retrieveGriddedData(boolean dataWanted, GridData gridData, int[] stat)
float	retrieveUserHeaderNullValue(int[] status)	This call is used to retrieve the otherwise discarded value of GridStructContainer._nullValue, which is necessary to correct data stored in the user header of DSS 7 grid records that were incorrectly stored on Solaris by heclib versions earlier than 7-IH
void	setGriddedPathnameParts(String aPart, String bPart, String cPart, String fPart)
void	setGriddedTimeWindow(HecTime start, HecTime end)	Sets start and end time in pathname for this grid.
void	setGriddedTimeWindow(HecTime start, HecTime end, boolean startOfDay)	Sets start and end time in pathname for this grid.
void	setGridTime(HecTime time)	Sets time in pathname for this grid.
void	setGridTime(HecTime time, Boolean startOfDay)	Allows setting time to beginning of day.
int	storeGriddedContainer(GridInfo gridInfo, GridData gridData)	Store gridded struct
int	storeGriddedData(GridInfo gridInfo, GridData gridData)	store gridded data out to dss
protected int	writeStructGrids(GridStructContainer gridContainer)

Methods inherited from class hec.heclib.dss.HecDataManager

addAlias, addAlias, addAlias, addAliasList, aliasGetPrimary, aliasGetPrimary, aliasList, aliasList, aliasRemove, aliasRemove, aliasRemoveList, clear, closeLogFile, closeMessageFile, convertUnitSystem, copyContainerToRecordData, copyRecordDataToContainer, done, flushMessageFile, getRecordInfo, getRecordInfo, getRecordInfo, getTSRecordInfo, numberArray, release, release, setMessageFile, setProgramName, status, Xarray, Yarray, Yarray, zlocationRetrieve, zlocationStore

Methods inherited from class hec.heclib.dss.HecDSSDataAttributes

aPart, arrayEndTime, arrayStartTime, bPart, convertDoubleUnits, convertUnits, cPart, createArrayObject, createObject, createPairedDataObject, createTextObject, createTimeSeriesObject, dirty, dPart, endTime, ePart, fPart, getLastWriteTime, getLastWriteTime, getLastWriteTimeMillis, getLastWriteTimeMillis, getRecordBasics, isGridRecord, isTimeWindowSet, localUnitSystem, pathname, pathnameDataType, recordExists, recordsUpdated, recordType, recordType, recordTypes, setAPart, setBPart, setCPart, setDefaultTimeWindow, setDefaultTimeWindow, setDPart, setDSSFileName, setEndTime, setEPart, setFPart, setLocalUnitSystem, setPathname, setPathnameParts, setStartTime, setTimeWindow, setTimeWindow, startTime

Methods inherited from class hec.heclib.dss.HecDssCatalog

addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, addHecDssListener, buildCondensedList, buildSortedCatalog, callCatalog, callCatalog, callCatalogOriginal, catalogFile, clearList, clone, compareCondensedPaths, expandPathname, fireHecDssEvent, getCatalog, getCatalog, getCatalog, getCatalogName, getCatalogSortAddresses, getCondensedCatalog, getCondensedCatalog, getDeletedPaths, getEPartLoc, getMaximumPartLengths, getPathnameList, getPathnameList, getPathnameList7, getPathnameListAndDates, getPathnames, getSortedPathnameList, getUseCollectionGroups, hecDssEventPerformed, isCatalogValid, isPathnamePartsString, pathNamePartsToRegex, processSearchParts, readCatalog, removeHecDssListener, searchDSSCatalog, searchDSSCatalog, searchDSSPaths, searchDSSPaths, setCatalogSortAddresses, setForceNewCatalog, setMaxNumberToRetrieve, setPathnameList, setPathnameList, setPathWithWildChars, setUseCollectionGroups, sort, sortCatalog, startObserverThread, whatChanged, whatChanged, whatChangedCompare, whatChangedSetStart, whatChangedSetStart, whatChangedSetStart, wildCharsToRegex, writeCatalog

Methods inherited from class hec.heclib.dss.HecDSSFileAccess

allSevereErrorMessages, appendNameToDirectory, checkAllPathnames, checkForError, checkForSevereError, checkForSevereError, checkForSevereFileError, checkLinks, checkPathnameBins, checkSystemError, cleanDSSFileName, clearError, clearSevereError, clearSevereError, clearStatus, close, close, closeAll, closeAllFiles, closeAndClear, closeDSSFile, debugLook, debugLook7, debugModify, defaultDirectory, defaultDSSFileName, doesDSSFileExist, DSSFileName, fileAccessible, fileOpened, fileStatus, flushMessages, forceMultiUserAccess, getCollectionList, getCollectionSequenceList, getCollectionSize, getDssFileVersion, getDssFileVersion, getFileInfo, getFileLastWriteTime, getFileLastWriteTimeMillis, getIrregBeginningDate, getLastError, getMessageLevel, getNumberRecords, getProcessStatus, getTimeSeriesExtents, getTSRecordInfo, lastSevereErrorMessage, numberRecords, open, open, processStatus, requestSecondAccess, setDefaultDirectory, setDefaultDSSFileName, setDss, setDSSFileName, setDSSFileName, setDSSFileName, setInterrupt, setMessageLevel, setUnit, writeAccess, zgetMessageLevel, zinqir, zinqir, zinquire, zmessage, zquery, zquery, zset, zsetFile, zsetMessageLevel

Methods inherited from class java.lang.Object

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

Constructor Details

GriddedData

public GriddedData()

GriddedData

@Deprecated
public GriddedData(boolean verbose)

Deprecated.

use constructor without verbose argument

Parameters:

verbose - not used

Method Details

setGriddedPathnameParts

public void setGriddedPathnameParts(String aPart,
 String bPart,
 String cPart,
 String fPart)

printArray

public void printArray(float[] X)

DSSFileName

public String DSSFileName(boolean useDefault)

setGriddedTimeWindow

public void setGriddedTimeWindow(HecTime start,
 HecTime end)

Sets start and end time in pathname for this grid.

Parameters:

start - (D part)

end - ( E part)

setGriddedTimeWindow

public void setGriddedTimeWindow(HecTime start,
 HecTime end,
 boolean startOfDay)

Sets start and end time in pathname for this grid. User can specify whether to use start of day (0000) or end of day (2400)

Parameters:

start - (D part)

end - (E part)

startOfDay - when true, show time at beginning of day

setGridTime

public void setGridTime(HecTime time)

Sets time in pathname for this grid. Set D part of pathname to specified time. Sets E part to empty string.

Parameters:

time - used to set D part

setGridTime

public void setGridTime(HecTime time,
 Boolean startOfDay)

Allows setting time to beginning of day. Sets time in pathname for this grid. Set D part of pathname to specified time. Sets E part to empty string. User can specify whether to use start of day (0000) or end of day (2400)

Parameters:

time - use for D part of pathname

startOfDay - when true, display time as start of day

getGridStructVersion

public int getGridStructVersion()

readStructGrids

protected int readStructGrids(GridStructContainer gridContainer,
 boolean retrieveData,
 int[] status)

writeStructGrids

protected int writeStructGrids(GridStructContainer gridContainer)

retrieveGriddedContainer

protected GridInfo retrieveGriddedContainer(boolean dataWanted,
 GridData gridData,
 int[] status)

retrieveUserHeaderNullValue

public float retrieveUserHeaderNullValue(int[] status)

This call is used to retrieve the otherwise discarded value of GridStructContainer._nullValue, which is necessary to correct data stored in the user header of DSS 7 grid records that were incorrectly stored on Solaris by heclib versions earlier than 7-IH

retrieveGriddedData

public GridInfo retrieveGriddedData()

retrieveGriddedData

public GridInfo retrieveGriddedData(boolean dataWanted,
 GridData gridData,
 int[] stat)

storeGriddedContainer

public int storeGriddedContainer(GridInfo gridInfo,
 GridData gridData)

Store gridded struct

storeGriddedData

public int storeGriddedData(GridInfo gridInfo,
 GridData gridData)

store gridded data out to dss