ucar.nc2.iosp.grads

Class GradsDataDescriptorFile

java.lang.Object

ucar.nc2.iosp.grads.GradsDataDescriptorFile

public class GradsDataDescriptorFile
extends java.lang.Object

Class to hold information from a GrADS Data Descriptor File

See Also:

"http://www.iges.org/grads/gadoc/descriptorfile.html"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GradsDataDescriptorFile.Chsub Class to handle the CHSUB parameters

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DSET DSET identifier
static java.lang.String	DTYPE DTYPE identifier
static java.lang.String	EDEF EDEF identifier
static java.lang.String	ENDEDEF ENDEDEF identifier
static java.lang.String	ENDVARS ENDVARS identifier
static int	ENS_TEMPLATE Ensemble template type
static int	ENS_TIME_TEMPLATE Ensemble and time template type
static java.lang.String	FILEHEADER FILEHEADER identifier
static java.lang.String	HEADERBYTES HEADERBYTES identifier
static java.lang.String	INDEX INDEX identifier
static int	NO_TEMPLATE NO template type
static java.lang.String	OPTIONS OPTIONS identifier
static java.lang.String	PDEF EDEF identifier
static java.lang.String	TDEF TDEF identifier
static java.lang.String	THEADER THEADER identifier
static int	TIME_TEMPLATE time template type
static java.lang.String	TITLE TITLE identifier
static java.lang.String	TRAILERBYTES TRAILERBYTES identifier
static java.lang.String	UNDEF UNDEF identifier
static java.lang.String	UNPACK UNPACK identifier
static java.lang.String	VARS VARS identifier
static java.lang.String	XDEF XDEF identifier
static java.lang.String	XYHEADER XYHEADER identifier
static java.lang.String	YDEF YDEF identifier
static java.lang.String	ZDEF ZDEF identifier

Constructor Summary

Constructors

Constructor and Description
GradsDataDescriptorFile(java.lang.String filename, int maxLines) Create a GradsDataDescriptorFile from the file

Method Summary

Modifier and Type	Method and Description
static boolean	failFast(RandomAccessFile raf)
java.util.List<GradsAttribute>	getAttributes() Get the attributes
java.lang.String	getDataDescriptorFile() Get the data descriptor file path
java.lang.String	getDataFile() Get the data file path
java.lang.String	getDataType() Get the data type.
java.util.List<GradsDimension>	getDimensions() Get the dimensions
GradsEnsembleDimension	getEnsembleDimension() Get the ensemble dimension
int	getFileHeaderBytes() Get the number of file header bytes
java.lang.String	getFileName(int eIndex, int tIndex) Get the file name for the particular time and ensemble index
int	getGridsPerTimeStep() Get the number of grids per timestep
double	getMissingValue() Get the missing value
int	getTemplateType() Get the type of template this is
GradsTimeDimension	getTimeDimension() Get the time dimension
int	getTimeHeaderBytes() Get the number of time header bytes
int[]	getTimeStepsPerFile(java.lang.String filename) Get the number of timesteps per file and the starting offset
int	getTimeTrailerBytes() Get the number of time trailer bytes
java.lang.String	getTitle() Get the title
java.util.List<GradsVariable>	getVariables() Get the variables
GradsDimension	getXDimension() Get the X dimension
int	getXYHeaderBytes() Get the number of xy header bytes
GradsDimension	getYDimension() Get the Y dimension
GradsDimension	getZDimension() Get the Z dimension
boolean	hasProjection() Get whether this is using a projection or no
boolean	isBigEndian() Is this a big endian file
boolean	isSequential() Get whether this is a sequentially written file
boolean	isTemplate() Get whether this is using a template or not
boolean	isYReversed() Get whether y axis is reversed or not
java.lang.String	toString() Return a String representation of this object

Methods inherited from class java.lang.Object

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

Field Detail

DSET

public static final java.lang.String DSET

DSET identifier

See Also:

Constant Field Values

DTYPE

public static final java.lang.String DTYPE

DTYPE identifier

See Also:

Constant Field Values

INDEX

public static final java.lang.String INDEX

INDEX identifier

See Also:

Constant Field Values

TITLE

public static final java.lang.String TITLE

TITLE identifier

See Also:

Constant Field Values

UNDEF

public static final java.lang.String UNDEF

UNDEF identifier

See Also:

Constant Field Values

UNPACK

public static final java.lang.String UNPACK

UNPACK identifier

See Also:

Constant Field Values

FILEHEADER

public static final java.lang.String FILEHEADER

FILEHEADER identifier

See Also:

Constant Field Values

XYHEADER

public static final java.lang.String XYHEADER

XYHEADER identifier

See Also:

Constant Field Values

THEADER

public static final java.lang.String THEADER

THEADER identifier

See Also:

Constant Field Values

HEADERBYTES

public static final java.lang.String HEADERBYTES

HEADERBYTES identifier

See Also:

Constant Field Values

TRAILERBYTES

public static final java.lang.String TRAILERBYTES

TRAILERBYTES identifier

See Also:

Constant Field Values

OPTIONS

public static final java.lang.String OPTIONS

OPTIONS identifier

See Also:

Constant Field Values

XDEF

public static final java.lang.String XDEF

XDEF identifier

See Also:

Constant Field Values

YDEF

public static final java.lang.String YDEF

YDEF identifier

See Also:

Constant Field Values

ZDEF

public static final java.lang.String ZDEF

ZDEF identifier

See Also:

Constant Field Values

TDEF

public static final java.lang.String TDEF

TDEF identifier

See Also:

Constant Field Values

EDEF

public static final java.lang.String EDEF

EDEF identifier

See Also:

Constant Field Values

PDEF

public static final java.lang.String PDEF

EDEF identifier

See Also:

Constant Field Values

ENDEDEF

public static final java.lang.String ENDEDEF

ENDEDEF identifier

See Also:

Constant Field Values

VARS

public static final java.lang.String VARS

VARS identifier

See Also:

Constant Field Values

ENDVARS

public static final java.lang.String ENDVARS

ENDVARS identifier

See Also:

Constant Field Values

NO_TEMPLATE

public static final int NO_TEMPLATE

NO template type

See Also:

Constant Field Values

TIME_TEMPLATE

public static final int TIME_TEMPLATE

time template type

See Also:

Constant Field Values

ENS_TEMPLATE

public static final int ENS_TEMPLATE

Ensemble template type

See Also:

Constant Field Values

ENS_TIME_TEMPLATE

public static final int ENS_TIME_TEMPLATE

Ensemble and time template type

See Also:

Constant Field Values

Constructor Detail

GradsDataDescriptorFile

public GradsDataDescriptorFile(java.lang.String filename,
                               int maxLines)
                        throws java.io.IOException

Create a GradsDataDescriptorFile from the file

Parameters:

filename - the name of the file

Throws:

java.io.IOException - problem reading/parsing the file

Method Detail

failFast

public static boolean failFast(RandomAccessFile raf)
                        throws java.io.IOException

Throws:

java.io.IOException

getDimensions

public java.util.List<GradsDimension> getDimensions()

Get the dimensions

Returns:

the dimensions

getVariables

public java.util.List<GradsVariable> getVariables()

Get the variables

Returns:

the variables

getAttributes

public java.util.List<GradsAttribute> getAttributes()

Get the attributes

Returns:

the attributes

getEnsembleDimension

public GradsEnsembleDimension getEnsembleDimension()

Get the ensemble dimension

Returns:

the ensemble dimension

getTimeDimension

public GradsTimeDimension getTimeDimension()

Get the time dimension

Returns:

the time dimension

getZDimension

public GradsDimension getZDimension()

Get the Z dimension

Returns:

the Z dimension

getYDimension

public GradsDimension getYDimension()

Get the Y dimension

Returns:

the Y dimension

getXDimension

public GradsDimension getXDimension()

Get the X dimension

Returns:

the X dimension

getDataFile

public java.lang.String getDataFile()

Get the data file path

Returns:

the data file path

getDataDescriptorFile

public java.lang.String getDataDescriptorFile()

Get the data descriptor file path

Returns:

the data descriptor file path

getMissingValue

public double getMissingValue()

Get the missing value

Returns:

the missing value

getGridsPerTimeStep

public int getGridsPerTimeStep()

Get the number of grids per timestep

Returns:

the number of grids per timestep

getTimeStepsPerFile

public int[] getTimeStepsPerFile(java.lang.String filename)

Get the number of timesteps per file and the starting offset

Parameters:

filename - the filename to check

Returns:

the starting index and number of times in that file

isTemplate

public boolean isTemplate()

Get whether this is using a template or not

Returns:

whether this is using a template or not

getTemplateType

public int getTemplateType()

Get the type of template this is

Returns:

the type of template

hasProjection

public boolean hasProjection()

Get whether this is using a projection or no

Returns:

whether this is using a projection or not

isSequential

public boolean isSequential()

Get whether this is a sequentially written file

Returns:

true if this is sequential

isYReversed

public boolean isYReversed()

Get whether y axis is reversed or not

Returns:

whether y axis is reversed or not

getXYHeaderBytes

public int getXYHeaderBytes()

Get the number of xy header bytes

Returns:

the number of xy header bytes

getFileHeaderBytes

public int getFileHeaderBytes()

Get the number of file header bytes

Returns:

the number of file header bytes

getTimeHeaderBytes

public int getTimeHeaderBytes()

Get the number of time header bytes

Returns:

the number of time header bytes

getTimeTrailerBytes

public int getTimeTrailerBytes()

Get the number of time trailer bytes

Returns:

the number of time trailer bytes

isBigEndian

public boolean isBigEndian()

Is this a big endian file

Returns:

true if big endian

getTitle

public java.lang.String getTitle()

Get the title

Returns:

the title

getDataType

public java.lang.String getDataType()

Get the data type. Only support raw binary

Returns:

type or null

toString

public java.lang.String toString()

Return a String representation of this object

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this object

getFileName

public java.lang.String getFileName(int eIndex,
                                    int tIndex)

Get the file name for the particular time and ensemble index

Parameters:

eIndex - ensemble index

tIndex - time index

Returns:

the appropriate filename