ucar.ma2
Class ArrayStructureW

java.lang.Object
  ucar.ma2.Array
      ucar.ma2.ArrayStructure
          ucar.ma2.ArrayStructureW

public class ArrayStructureW
extends ArrayStructure

Concrete implementation of ArrayStructure, with data storage in individual Arrays in StructureData objects. The ArrayStructure data accessors thus defer to the accessors in the StructureData objects. Using this and StructureDataW is often the easiest to construct, but not very efficient for large arrays of Structures due to excessive object creation.

Version:

$Revision: 1.11 $ $Date: 2006/02/13 19:51:23 $

Author:

caron

See Also:

Array

Field Summary

Fields inherited from class ucar.ma2.Array

scalarIndex

Constructor Summary

ArrayStructureW(StructureMembers members, int[] shape)
Create a new Array of type StructureData and the given members and shape.

ArrayStructureW(StructureMembers members, int[] shape, StructureData[] sdata)
Create a new Array of type StructureData and the given members, shape, and array of StructureData.

Method Summary

Array	getArray(int recnum, StructureMembers.Member m) Get member data array of any type as an Array.
ArrayStructure	getArrayStructure(int recnum, StructureMembers.Member m) Get member data of type array of Structure.
byte[]	getJavaArrayByte(int recnum, StructureMembers.Member m) Get member data of type byte as a 1D array.
char[]	getJavaArrayChar(int recnum, StructureMembers.Member m) Get member data of type char as a 1D array.
double[]	getJavaArrayDouble(int recnum, StructureMembers.Member m) Get member data of type double as a 1D array.
float[]	getJavaArrayFloat(int recnum, StructureMembers.Member m) Get member data of type float as a 1D array.
int[]	getJavaArrayInt(int recnum, StructureMembers.Member m) Get member data of type int as a 1D array.
long[]	getJavaArrayLong(int recnum, StructureMembers.Member m) Get member data of type long as a 1D array.
short[]	getJavaArrayShort(int recnum, StructureMembers.Member m) Get member data of type short as a 1D array.
java.lang.String[]	getJavaArrayString(int recnum, StructureMembers.Member m) Get member data of type String as a 1D array.
byte	getScalarByte(int recnum, StructureMembers.Member m) Get scalar member data of type byte.
char	getScalarChar(int recnum, StructureMembers.Member m) Get scalar member data of type char.
double	getScalarDouble(int recnum, StructureMembers.Member m) Get scalar member data of type double.
float	getScalarFloat(int recnum, StructureMembers.Member m) Get scalar member data of type float.
int	getScalarInt(int recnum, StructureMembers.Member m) Get scalar member data of type int.
long	getScalarLong(int recnum, StructureMembers.Member m) Get scalar member data of type long.
short	getScalarShort(int recnum, StructureMembers.Member m) Get scalar member data of type short.
java.lang.String	getScalarString(int recnum, StructureMembers.Member m) Get member data of type String or char.
StructureData	getScalarStructure(int recnum, StructureMembers.Member m) Get member data of type Structure.
java.lang.Object	getStorage() Get underlying StructureData primitive array storage.
void	setStructureData(StructureData sd, int index) Set one of the StructureData of this ArrayStructure.

Methods inherited from class ucar.ma2.ArrayStructure

convertScalarDouble, copy, createView, getArrayByte, getArrayChar, getArrayDouble, getArrayFloat, getArrayInt, getArrayLong, getArrayShort, getArrayString, getBoolean, getByte, getChar, getDouble, getElementType, getFloat, getInt, getLong, getObject, getObject, getObject, getScalarObject, getShort, getStructureData, getStructureData, getStructureMembers, getStructureSize, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setShort

Methods inherited from class ucar.ma2.Array

arraycopy, copyTo1DJavaArray, copyToNDJavaArray, factory, factory, factory, factory, factoryConstant, flip, get1DJavaArray, getIndex, getIndexIterator, getIndexIteratorFast, getIndexName, getRangeIterator, getRank, getShape, getSize, permute, reduce, reduce, reshape, section, section, section, sectionNoReduce, sectionNoReduce, setIndexName, shapeToString, slice, toString, transpose

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayStructureW

public ArrayStructureW(StructureMembers members,
                       int[] shape)

Create a new Array of type StructureData and the given members and shape. You must completely construct by calling setStructureData()

Parameters:

members - a description of the structure members

shape - the shape of the Array.

ArrayStructureW

public ArrayStructureW(StructureMembers members,
                       int[] shape,
                       StructureData[] sdata)

Create a new Array of type StructureData and the given members, shape, and array of StructureData.

Parameters:

members - a description of the structure members

shape - the shape of the Array.

sdata - StructureData array, must be

Method Detail

setStructureData

public void setStructureData(StructureData sd,
                             int index)

Set one of the StructureData of this ArrayStructure.

Parameters:

sd - set it to this StructureData.

index - which one to set, as an index into 1D backing store.

getStorage

public java.lang.Object getStorage()

Get underlying StructureData primitive array storage. CAUTION! You may invalidate your warrentee!

Specified by:

getStorage in class Array

getArray

public Array getArray(int recnum,
                      StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data array of any type as an Array.

Overrides:

getArray in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member.

Returns:

Array values.

getScalarDouble

public double getScalarDouble(int recnum,
                              StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type double.

Specified by:

getScalarDouble in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type double.

Returns:

scalar double value

getJavaArrayDouble

public double[] getJavaArrayDouble(int recnum,
                                   StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type double as a 1D array. The member data may be any rank.

Specified by:

getJavaArrayDouble in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type double.

Returns:

double[]

getScalarFloat

public float getScalarFloat(int recnum,
                            StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type float.

Specified by:

getScalarFloat in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type float.

Returns:

scalar double value

getJavaArrayFloat

public float[] getJavaArrayFloat(int recnum,
                                 StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type float as a 1D array.

Specified by:

getJavaArrayFloat in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type float.

Returns:

float[]

getScalarByte

public byte getScalarByte(int recnum,
                          StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type byte.

Specified by:

getScalarByte in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type byte.

Returns:

scalar double value

getJavaArrayByte

public byte[] getJavaArrayByte(int recnum,
                               StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type byte as a 1D array.

Specified by:

getJavaArrayByte in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type byte.

Returns:

byte[]

getScalarShort

public short getScalarShort(int recnum,
                            StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type short.

Specified by:

getScalarShort in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type short.

Returns:

scalar double value

getJavaArrayShort

public short[] getJavaArrayShort(int recnum,
                                 StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type short as a 1D array.

Specified by:

getJavaArrayShort in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type float.

Returns:

short[]

getScalarInt

public int getScalarInt(int recnum,
                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type int.

Specified by:

getScalarInt in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type int.

Returns:

scalar double value

getJavaArrayInt

public int[] getJavaArrayInt(int recnum,
                             StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type int as a 1D array.

Specified by:

getJavaArrayInt in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type int.

Returns:

int[]

getScalarLong

public long getScalarLong(int recnum,
                          StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type long.

Specified by:

getScalarLong in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type long.

Returns:

scalar double value

getJavaArrayLong

public long[] getJavaArrayLong(int recnum,
                               StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type long as a 1D array.

Specified by:

getJavaArrayLong in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type long.

Returns:

long[]

getScalarChar

public char getScalarChar(int recnum,
                          StructureMembers.Member m)

Description copied from class: ArrayStructure

Get scalar member data of type char.

Specified by:

getScalarChar in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type char.

Returns:

scalar double value

getJavaArrayChar

public char[] getJavaArrayChar(int recnum,
                               StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type char as a 1D array.

Specified by:

getJavaArrayChar in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type char.

Returns:

char[]

getScalarString

public java.lang.String getScalarString(int recnum,
                                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type String or char.

Specified by:

getScalarString in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type String or char.

Returns:

scalar String value

getJavaArrayString

public java.lang.String[] getJavaArrayString(int recnum,
                                             StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type String as a 1D array.

Specified by:

getJavaArrayString in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type String.

Returns:

String[]

getScalarStructure

public StructureData getScalarStructure(int recnum,
                                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type Structure.

Specified by:

getScalarStructure in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type Structure.

Returns:

scalar StructureData

getArrayStructure

public ArrayStructure getArrayStructure(int recnum,
                                        StructureMembers.Member m)

Description copied from class: ArrayStructure

Get member data of type array of Structure.

Specified by:

getArrayStructure in class ArrayStructure

Parameters:

recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();

m - get data from this StructureMembers.Member. Must be of type Structure.

Returns:

nested ArrayStructure.