visad.data.netcdf.out
Class DependentVar

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

All Implemented Interfaces:

Accessor, Cloneable, MultiArrayInfo, Named, Serializable

Direct Known Subclasses:

DependentRealVar, DependentTextVar

abstract class DependentVar

extends ExportVar

The DependentVar class provides an abstract class for adapting data in a VisAD data object to a netCDF, dependent-variable API for the purpose of exporting the data.

Constructor Summary

protected

DependentVar(String name, Class type, Dimension[] dims, Attribute[] attrs, 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.
abstract 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.
float	getFloat(int[] indexes) Return an array element identified by position.
int	getInt(int[] indexes) Return an array element identified by position.
long	getLong(int[] indexes) Return an array element identified by position.
short	getShort(int[] indexes) Return an array element identified by position.
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

DependentVar

protected DependentVar(String name,
                       Class type,
                       Dimension[] dims,
                       Attribute[] attrs,
                       VisADAccessor accessor)
                throws BadFormException

Construct.

Parameters:

name - The name of the netCDF, dependent variable.

type - The Java class of the type of the variable (i.e. Double, Byte, Character, etc.).

dims - The netCDF dimensions of the variable.

attrs - The netCDF attributes of the variable.

Throws:

BadFormException - The VisAD data object cannot be adapted to a netCDF API.

Method Detail

get

public abstract Object get(int[] indexes)
                    throws IOException

Return a netCDF datum identified by position.

Specified by:

get in interface Accessor

Specified by:

get in class ExportVar

Parameters:

indexes - The netCDF indexes of the desired datum. Includes all adapted dimensions -- including those of all enclosing VisAD data objects.

Returns:

An Object that contains the data value or the appropriate netCDF fill-value 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.

copyin

public void copyin(int[] origin,
                   MultiArray multiArray)
            throws IOException

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

copyin in interface Accessor

Parameters:

origin - int array specifying the starting index.

multiArray - MultiArray with the same componentType as this and shape smaller than this.getLengths() - origin

Throws:

IOException

set

public void set(int[] index,
                Object value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

set in interface Accessor

Parameters:

index - MultiArray index

value - the new value.

setBoolean

public void setBoolean(int[] index,
                       boolean value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setBoolean in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

setChar

public void setChar(int[] index,
                    char value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setChar in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

setByte

public void setByte(int[] index,
                    byte value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setByte in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

setShort

public void setShort(int[] index,
                     short value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setShort in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

setInt

public void setInt(int[] index,
                   int value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setInt in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

setLong

public void setLong(int[] index,
                    long value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setLong in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

setFloat

public void setFloat(int[] index,
                     float value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setFloat in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

setDouble

public void setDouble(int[] index,
                      double value)

Set an array element identified by position. Not supported for read-only, VisAD data objects.

Specified by:

setDouble in interface Accessor

See Also:

Accessor.set(int[], java.lang.Object)

getBoolean

public boolean getBoolean(int[] indexes)
                   throws IOException

Return an array element identified by position. Not supported.

Specified by:

getBoolean in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

getChar

public char getChar(int[] indexes)
             throws IOException

Return an array element identified by position. Not supported.

Specified by:

getChar in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

getByte

public byte getByte(int[] indexes)
             throws IOException

Return an array element identified by position. Not supported.

Specified by:

getByte in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

getShort

public short getShort(int[] indexes)
               throws IOException

Return an array element identified by position. Not supported.

Specified by:

getShort in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

getInt

public int getInt(int[] indexes)
           throws IOException

Return an array element identified by position. Not supported.

Specified by:

getInt in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

getLong

public long getLong(int[] indexes)
             throws IOException

Return an array element identified by position. Not supported.

Specified by:

getLong in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

getFloat

public float getFloat(int[] indexes)
               throws IOException

Return an array element identified by position. Not supported.

Specified by:

getFloat in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

getDouble

public double getDouble(int[] indexes)
                 throws IOException

Return an array element identified by position. Not supported.

Specified by:

getDouble in interface Accessor

Throws:

IOException

See Also:

Accessor.get(int[])

copyout

public MultiArray copyout(int[] origin,
                          int[] shape)
                   throws IOException

Return a MultiArray into a slice of the data. Not supported.

Specified by:

copyout in interface Accessor

Parameters:

origin - int array specifying the starting index.

shape - int array specifying the extents in each dimension. This becomes the shape of the return.

Returns:

the MultiArray with the specified shape

Throws:

IOException

toArray

public Object toArray()

Convert values to an array. Not supported.

Specified by:

toArray in interface Accessor

Returns:

a one dimensional Array containing all the elements in this MultiArray

toArray

public Object toArray(Object obj,
                      int[] dummy1,
                      int[] dummy2)

Convert values to an array. Not supported.

Specified by:

toArray in interface Accessor

Returns:

a one dimensional Array containing the specified elements