DependentRealVar

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

visad.data.netcdf.out
Class DependentRealVar

java.lang.Object
  ucar.netcdf.ProtoVariable
      visad.data.netcdf.out.ExportVar
          visad.data.netcdf.out.DependentVar
              visad.data.netcdf.out.DependentRealVar

All Implemented Interfaces:: Accessor, Cloneable, MultiArrayInfo, Named, Serializable

class DependentRealVar
extends DependentVar

The DependentRealVar class adapts numeric data in a VisAD data object to a netCDF, dependent-variable, API for the purpose of exporting the data.

Constructor Summary
`protected`	`DependentRealVar(Real real, VisADAccessor accessor)` Construct.

Method Summary
`void`	`copyin(int[] origin, MultiArray multiArray)` Set an array element identified by position.
`MultiArray`	`copyout(int[] origin, int[] shape)` Return a MultiArray into a slice of the data.
`Object`	`get(int[] indexes)` Return a netCDF datum identified by position.
`protected VisADAccessor`	`getAccessor()` Return the data accessor.
`boolean`	`getBoolean(int[] indexes)` Return an array element identified by position.
`byte`	`getByte(int[] indexes)` Return an array element identified by position.
`char`	`getChar(int[] indexes)` Return an array element identified by position.
`double`	`getDouble(int[] indexes)` Return an array element identified by position.
`protected static Number`	`getFillValue(Class type)` Return the fill-value object for a numeric netCDF variable of the given type.
`float`	`getFloat(int[] indexes)` Return an array element identified by position.
`int`	`getInt(int[] indexes)` Return an array element identified by position.
`protected static Class`	`getJavaClass(Set set)` Get the class of the Java primitive type that can contain the VisAD Set of a VisAD range value.
`long`	`getLong(int[] indexes)` Return an array element identified by position.
`short`	`getShort(int[] indexes)` Return an array element identified by position.
`protected static Attribute[]`	`myAttributes(Real real)` Get the netCDF attributes for a DependentRealVar.
`void`	`set(int[] index, Object value)` Set an array element identified by position.
`void`	`setBoolean(int[] index, boolean value)` Set an array element identified by position.
`void`	`setByte(int[] index, byte value)` Set an array element identified by position.
`void`	`setChar(int[] index, char value)` Set an array element identified by position.
`void`	`setDouble(int[] index, double value)` Set an array element identified by position.
`void`	`setFloat(int[] index, float value)` Set an array element identified by position.
`void`	`setInt(int[] index, int value)` Set an array element identified by position.
`void`	`setLong(int[] index, long value)` Set an array element identified by position.
`void`	`setShort(int[] index, short value)` Set an array element identified by position.
`Object`	`toArray()` Convert values to an array.
`Object`	`toArray(Object obj, int[] dummy1, int[] dummy2)` Convert values to an array.

Methods inherited from class ucar.netcdf.ProtoVariable

clone, getAttribute, getAttributes, getComponentType, getDimensionIterator, getLengths, getName, getRank, isScalar, isUnlimited, putAttribute, toCdl, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DependentRealVar

protected DependentRealVar(Real real,
                           VisADAccessor accessor)
                    throws VisADException,
                           BadFormException

Construct.
Parameters:: real - The VisAD Real object to be adapted.; accessor - The means for accessing the individual VisAD Real objects of the enclosing VisAD data object.
Throws:: BadFormException - The VisAD data object cannot be adapted to a netCDF API; VisADException - Problem in core VisAD. Probably some VisAD object couldn't be created.

Method Detail

myAttributes

protected static Attribute[] myAttributes(Real real)
                                   throws VisADException,
                                          BadFormException

Get the netCDF attributes for a DependentRealVar.

Parameters:: real - The VisAD data object for which netCDF Attribute must be created.
Returns:: An array of netCDF Attributes for real.
Throws:: BadFormException - The VisAD data object cannot be adapted to a netCDF API; VisADException - Problem in core VisAD. Probably some VisAD object couldn't be created.

getJavaClass

protected static Class getJavaClass(Set set)
                             throws VisADException

Get the class of the Java primitive type that can contain the VisAD Set of a VisAD range value.

Parameters:: set - The VisAD Set describing the range of the variable data.
Returns:: The Java class corresponding to the variable data (i.e. Double, Float, Integer, etc.).
Throws:: VisADException - Problem in core VisAD. Probably some VisAD object couldn't be created.

getFillValue

protected static Number getFillValue(Class type)
                              throws BadFormException

Return the fill-value object for a numeric netCDF variable of the given type.

Parameters:: type - netCDF type (e.g. Character.TYPE, Float.TYPE).
Returns:: The default fill-value object for the given netCDF type.
Throws:: BadFormException - Unknown netCDF type.

get

public Object get(int[] indexes)
           throws IOException

Return a netCDF datum identified by position.

Specified by:: get in interface Accessor
Specified by:: get in class DependentVar

Parameters:: indexes - The netCDF indexes of the desired datum. Includes all adapted dimensions -- including those of all enclosing VisAD data objects.
Returns:: A Java Double that contains the data value or NaN if the data is missing.
Throws:: IOException - Data access failure.

getAccessor

protected VisADAccessor getAccessor()

Return the data accessor.

Returns:: The data accessor that knows how to get the data from the VisAD data object.