ArrayStructure (NetCDF-Java CDM Public API v5.4.2)

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

All Implemented Interfaces:

Iterable<StructureData>

Direct Known Subclasses:

ArraySequence, ArraySequenceNested, ArrayStructureBB, ArrayStructureComposite, ArrayStructureMA, ArrayStructureW
```
public abstract class ArrayStructure
extends Array
implements Iterable<StructureData>
```
Superclass for implementations of Array of StructureData.
The general way to access data in an ArrayStructure is to use
```
  StructureData getStructureData(Index index).
 
```
For 1D arrays (or by calculating your own recnum for nD arrays), you can also use:
```
  StructureData getStructureData(int recnum).
 
```
Once you have a StructureData object, you can access data in a general way by using:
```
  Array StructureData.getArray(Member m)
 
```
When dealing with large arrays of Structures, there can be significant overhead in using the generic interfaces. A number of convenience routines may be able to avoid extra Object creation, and so are recommended for efficiency. The following may avoid the overhead of creating the StructureData object:
```
  Array getArray(int recno, StructureMembers.Member m)
 
```
The following can be convenient for accessing all the data in the ArrayStructure for one member, but its efficiency depends on the implementation:
```
  Array getMemberArray(StructureMembers.Member m)
 
```
These require that you know the data types of the member data, but they are the most efficent:
```
 getScalarXXX(int recnum, Member m)
 getJavaArrayXXX(int recnum, Member m)
 
```
where XXX is Byte, Char, Double, Float, Int, Long, Short, or String. For members that are themselves Structures, the equivilent is:
```
 StructureData getScalarStructure(int recnum, Member m)
 ArrayStructure getArrayStructure(int recnum, Member m)
 
```
These will return any compatible type as a double or float, but will have extra overhead when the types dont match:
```
 convertScalarXXX(int recnum, Member m)
 convertJavaArrayXXX(int recnum, Member m)
 
```
where XXX is Double or Float
See Also:

Array, StructureData

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ArrayStructure.ArrayStructureIterator

Nested Classes
Modifier and Type	Class and Description
`class`	`ArrayStructure.ArrayStructureIterator`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`convertScalarDouble(int recnum, StructureMembers.Member m)` Get scalar value as a double, with conversion as needed.
`float`	`convertScalarFloat(int recnum, StructureMembers.Member m)` Get scalar value as a float, with conversion as needed.
`int`	`convertScalarInt(int recnum, StructureMembers.Member m)` Get scalar value as an int, with conversion as needed.
`long`	`convertScalarLong(int recnum, StructureMembers.Member m)`
`Array`	`copy()` DO NOT USE, throws UnsupportedOperationException
`Array`	`createView(Index index)` create new Array with given Index and the same backing store
`Array`	`extractMemberArray(StructureMembers.Member m)` Extract data for one member, over all structures.
`StructureMembers.Member`	`findMember(String memberName)` Find a member by its name.
`Array`	`getArray(int recno, StructureMembers.Member m)` Get member data of any type for a specific record as an Array.
`ArrayObject`	`getArrayObject(int recnum, StructureMembers.Member m)` Get member data of type ArrayObject
`ArraySequence`	`getArraySequence(int recnum, StructureMembers.Member m)` Get member data of type ArraySequence
`ArrayStructure`	`getArrayStructure(int recnum, StructureMembers.Member m)` Get member data of type array of Structure.
`boolean`	`getBoolean(Index i)` DO NOT USE, throw ForbiddenConversionException
`boolean`	`getBoolean(int index)`
`byte`	`getByte(Index i)` DO NOT USE, throw ForbiddenConversionException
`byte`	`getByte(int index)`
`char`	`getChar(Index i)` DO NOT USE, throw ForbiddenConversionException
`char`	`getChar(int index)`
`double`	`getDouble(Index i)` DO NOT USE, throw ForbiddenConversionException
`double`	`getDouble(int index)`
`Class`	`getElementType()` Get the element class type of this Array
`float`	`getFloat(Index i)` DO NOT USE, throw ForbiddenConversionException
`float`	`getFloat(int index)`
`int`	`getInt(Index i)` DO NOT USE, throw ForbiddenConversionException
`int`	`getInt(int index)`
`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.
`String[]`	`getJavaArrayString(int recnum, StructureMembers.Member m)` Get member data of type String as a 1D array.
`long`	`getLong(Index i)` DO NOT USE, throw ForbiddenConversionException
`long`	`getLong(int index)`
`List<StructureMembers.Member>`	`getMembers()` Get a list of structure members.
`Object`	`getObject(Index i)` Get the index-th StructureData of this ArrayStructure.
`Object`	`getObject(int index)` Get the index-th StructureData of this ArrayStructure.
`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.
`Object`	`getScalarObject(int recno, StructureMembers.Member m)` Get member data array of any type as an Object, eg, Float, Double, String, StructureData etc.
`short`	`getScalarShort(int recnum, StructureMembers.Member m)` Get scalar member data of type short.
`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.
`short`	`getShort(Index i)` DO NOT USE, throw ForbiddenConversionException
`short`	`getShort(int index)`
`long`	`getSizeBytes()` Get the total number of bytes in the array.
`Object`	`getStorage()` Get underlying primitive array storage.
`StructureData`	`getStructureData(Index i)` Get the index-th StructureData of this ArrayStructure.
`StructureData`	`getStructureData(int index)` Get the index-th StructureData of this ArrayStructure.
`StructureDataIterator`	`getStructureDataIterator()`
`List<String>`	`getStructureMemberNames()` Get a list structure member names.
`StructureMembers`	`getStructureMembers()` Get the StructureMembers object.
`int`	`getStructureSize()` Get the size of each StructureData object in bytes.
`Iterator<StructureData>`	`iterator()`
`Array`	`sectionNoReduce(List<Range> ranges)` Create a new Array as a subsection of this Array, without rank reduction.
`void`	`setBoolean(Index i, boolean value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setBoolean(int index, boolean value)`
`void`	`setByte(Index i, byte value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setByte(int index, byte value)`
`void`	`setChar(Index i, char value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setChar(int index, char value)`
`void`	`setDouble(Index i, double value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setDouble(int index, double value)`
`void`	`setFloat(Index i, float value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setFloat(int index, float value)`
`void`	`setInt(Index i, int value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setInt(int index, int value)`
`void`	`setLong(Index i, long value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setLong(int index, long value)`
`void`	`setMemberArray(StructureMembers.Member m, Array memberArray)` Set data for one member, over all structures.
`void`	`setObject(Index i, Object value)` Set one of the StructureData of this ArrayStructure.
`void`	`setObject(int index, Object value)` Set the index-th StructureData of this ArrayStructure.
`void`	`setShort(Index i, short value)` DO NOT USE, throw ForbiddenConversionException
`void`	`setShort(int index, short value)`
`void`	`showInternal(Formatter f, Indent indent)`
`void`	`showInternalMembers(Formatter f, Indent indent)`

Methods inherited from class ucar.ma2.Array
arraycopy, copyTo1DJavaArray, copyToNDJavaArray, factory, factory, factory, factory, factoryConstant, flip, get1DJavaArray, getDataAsByteBuffer, getDataAsByteBuffer, getDataAsByteBuffer, getDataType, getIndex, getIndexIterator, getRangeIterator, getRank, getShape, getSize, hasNext, isConstant, isUnsigned, isVlen, makeArray, makeArray, makeArray, makeArrayRankPlusOne, makeFromJavaArray, makeFromJavaArray, makeObjectArray, makeVlenArray, next, nextBoolean, nextByte, nextChar, nextDouble, nextFloat, nextInt, nextLong, nextShort, permute, reduce, reduce, resetLocalIterator, reshape, reshapeNoCopy, section, section, section, sectionNoReduce, shapeToString, slice, toString, transpose

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - convertScalarDouble
```
public double convertScalarDouble(int recnum,
                                  StructureMembers.Member m)
```
    Get scalar value as a double, with conversion as needed. Underlying type must be convertible to double.
    
    Parameters:
    
    recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - member Variable.
    
    Returns:
    
    scalar double value
    
    Throws:
    
    ForbiddenConversionException - if not convertible to double.
  - convertScalarFloat
```
public float convertScalarFloat(int recnum,
                                StructureMembers.Member m)
```
    Get scalar value as a float, with conversion as needed. Underlying type must be convertible to float.
    
    Parameters:
    
    recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - member Variable.
    
    Returns:
    
    scalar float value
    
    Throws:
    
    ForbiddenConversionException - if not convertible to float.
  - convertScalarInt
```
public int convertScalarInt(int recnum,
                            StructureMembers.Member m)
```
    Get scalar value as an int, with conversion as needed. Underlying type must be convertible to int.
    
    Parameters:
    
    recnum - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - member Variable.
    
    Returns:
    
    scalar double value
    
    Throws:
    
    ForbiddenConversionException - if not convertible to double.
  - convertScalarLong
```
public long convertScalarLong(int recnum,
                              StructureMembers.Member m)
```
  - copy
```
public Array copy()
```
    DO NOT USE, throws UnsupportedOperationException
    
    Overrides:
    
    copy in class Array
    
    Returns:
    
    the new Array
  - createView
```
public Array createView(Index index)
```
    Description copied from class: Array
    
    create new Array with given Index and the same backing store
    
    Parameters:
    
    index - use this Index
    
    Returns:
    
    a view of the Array using the given Index
  - extractMemberArray
```
public Array extractMemberArray(StructureMembers.Member m)
                         throws IOException
```
    Extract data for one member, over all structures.
    
    Parameters:
    
    m - get data from this StructureMembers.Member.
    
    Returns:
    
    Array values.
    
    Throws:
    
    IOException - on read error (only happens for Sequences, otherwise data is already read)
  - findMember
```
public StructureMembers.Member findMember(String memberName)
```
    Find a member by its name.
    
    Parameters:
    
    memberName - find member with this name
    
    Returns:
    
    StructureMembers.Member matching the name, or null if not found
  - getArray
```
public Array getArray(int recno,
                      StructureMembers.Member m)
```
    Get member data of any type for a specific record as an Array. This may avoid the overhead of creating the StructureData object, but is equivilent to getStructure(recno).getArray( Member m).
    
    Parameters:
    
    recno - 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.
  - getArrayObject
```
public ArrayObject getArrayObject(int recnum,
                                  StructureMembers.Member m)
```
    Get member data of type ArrayObject
    
    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:
    
    ArrayObject.
  - getArraySequence
```
public ArraySequence getArraySequence(int recnum,
                                      StructureMembers.Member m)
```
    Get member data of type ArraySequence
    
    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.
  - getArrayStructure
```
public ArrayStructure getArrayStructure(int recnum,
                                        StructureMembers.Member m)
```
    Get member data of type array of Structure.
    
    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.
  - getBoolean
```
public boolean getBoolean(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getBoolean in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to boolean if necessary.
  - getBoolean
```
public boolean getBoolean(int index)
```
    Specified by:
    
    getBoolean in class Array
  - getByte
```
public byte getByte(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getByte in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to float if necessary.
  - getByte
```
public byte getByte(int index)
```
    Specified by:
    
    getByte in class Array
  - getChar
```
public char getChar(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getChar in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to char if necessary.
  - getChar
```
public char getChar(int index)
```
    Specified by:
    
    getChar in class Array
  - getDouble
```
public double getDouble(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getDouble in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to double if necessary.
  - getDouble
```
public double getDouble(int index)
```
    Specified by:
    
    getDouble in class Array
  - getElementType
```
public Class getElementType()
```
    Description copied from class: Array
    
    Get the element class type of this Array
    
    Specified by:
    
    getElementType in class Array
    
    Returns:
    
    the class of the element
  - getFloat
```
public float getFloat(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getFloat in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to float if necessary.
  - getFloat
```
public float getFloat(int index)
```
    Specified by:
    
    getFloat in class Array
  - getInt
```
public int getInt(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getInt in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to int if necessary.
  - getInt
```
public int getInt(int index)
```
    Specified by:
    
    getInt in class Array
  - getJavaArrayByte
```
public byte[] getJavaArrayByte(int recnum,
                               StructureMembers.Member m)
```
    Get member data of type byte as a 1D array.
    
    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[]
  - getJavaArrayChar
```
public char[] getJavaArrayChar(int recnum,
                               StructureMembers.Member m)
```
    Get member data of type char as a 1D array.
    
    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[]
  - getJavaArrayDouble
```
public double[] getJavaArrayDouble(int recnum,
                                   StructureMembers.Member m)
```
    Get member data of type double as a 1D array. The member data may be any rank.
    
    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[]
  - getJavaArrayFloat
```
public float[] getJavaArrayFloat(int recnum,
                                 StructureMembers.Member m)
```
    Get member data of type float as a 1D array.
    
    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[]
  - getJavaArrayInt
```
public int[] getJavaArrayInt(int recnum,
                             StructureMembers.Member m)
```
    Get member data of type int as a 1D array.
    
    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[]
  - getJavaArrayLong
```
public long[] getJavaArrayLong(int recnum,
                               StructureMembers.Member m)
```
    Get member data of type long as a 1D array.
    
    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[]
  - getJavaArrayShort
```
public short[] getJavaArrayShort(int recnum,
                                 StructureMembers.Member m)
```
    Get member data of type short as a 1D array.
    
    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[]
  - getJavaArrayString
```
public String[] getJavaArrayString(int recnum,
                                   StructureMembers.Member m)
```
    Get member data of type String as a 1D array.
    
    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[]
  - getLong
```
public long getLong(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getLong in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to long if necessary.
  - getLong
```
public long getLong(int index)
```
    Specified by:
    
    getLong in class Array
  - getMembers
```
public List<StructureMembers.Member> getMembers()
```
    Get a list of structure members.
    
    Returns:
    
    the structure members.
  - getObject
```
public Object getObject(Index i)
```
    Get the index-th StructureData of this ArrayStructure.
    
    Specified by:
    
    getObject in class Array
    
    Parameters:
    
    i - which one to get, specified by an Index.
    
    Returns:
    
    object of type StructureData.
  - getObject
```
public Object getObject(int index)
```
    Get the index-th StructureData of this ArrayStructure.
    
    Specified by:
    
    getObject in class Array
    
    Parameters:
    
    index - which one to get, specified by an integer.
    
    Returns:
    
    object of type StructureData.
  - getScalarByte
```
public byte getScalarByte(int recnum,
                          StructureMembers.Member m)
```
    Get scalar member data of type byte.
    
    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
  - getScalarChar
```
public char getScalarChar(int recnum,
                          StructureMembers.Member m)
```
    Get scalar member data of type char.
    
    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
  - getScalarDouble
```
public double getScalarDouble(int recnum,
                              StructureMembers.Member m)
```
    Get scalar member data of type double.
    
    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
  - getScalarFloat
```
public float getScalarFloat(int recnum,
                            StructureMembers.Member m)
```
    Get scalar member data of type float.
    
    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
  - getScalarInt
```
public int getScalarInt(int recnum,
                        StructureMembers.Member m)
```
    Get scalar member data of type int.
    
    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
  - getScalarLong
```
public long getScalarLong(int recnum,
                          StructureMembers.Member m)
```
    Get scalar member data of type long.
    
    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
  - getScalarObject
```
public Object getScalarObject(int recno,
                              StructureMembers.Member m)
```
    Get member data array of any type as an Object, eg, Float, Double, String, StructureData etc.
    
    Parameters:
    
    recno - get data from the recnum-th StructureData of the ArrayStructure. Must be less than getSize();
    
    m - get data from this StructureMembers.Member.
    
    Returns:
    
    value as Float, Double, etc..
  - getScalarShort
```
public short getScalarShort(int recnum,
                            StructureMembers.Member m)
```
    Get scalar member data of type short.
    
    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
  - getScalarString
```
public String getScalarString(int recnum,
                              StructureMembers.Member m)
```
    Get member data of type String or char.
    
    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
  - getScalarStructure
```
public StructureData getScalarStructure(int recnum,
                                        StructureMembers.Member m)
```
    Get member data of type Structure.
    
    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
  - getShort
```
public short getShort(Index i)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    getShort in class Array
    
    Parameters:
    
    i - Index with current element set
    
    Returns:
    
    value at index cast to short if necessary.
  - getShort
```
public short getShort(int index)
```
    Specified by:
    
    getShort in class Array
  - getSizeBytes
```
public long getSizeBytes()
```
    Description copied from class: Array
    
    Get the total number of bytes in the array.
    
    Overrides:
    
    getSizeBytes in class Array
    
    Returns:
    
    total number of bytes in the array
  - getStorage
```
public Object getStorage()
```
    Description copied from class: Array
    
    Get underlying primitive array storage. Exposed for efficiency, use at your own risk.
    
    Specified by:
    
    getStorage in class Array
    
    Returns:
    
    underlying primitive array storage
  - getStructureData
```
public StructureData getStructureData(Index i)
```
    Get the index-th StructureData of this ArrayStructure.
    
    Parameters:
    
    i - which one to get, specified by an Index.
    
    Returns:
    
    object of type StructureData.
  - getStructureData
```
public StructureData getStructureData(int index)
```
    Get the index-th StructureData of this ArrayStructure.
    
    Parameters:
    
    index - which one to get, specified by an integer.
    
    Returns:
    
    object of type StructureData.
  - getStructureDataIterator
```
public StructureDataIterator getStructureDataIterator()
```
  - getStructureMemberNames
```
public List<String> getStructureMemberNames()
```
    Get a list structure member names.
    
    Returns:
    
    the structure members.
  - getStructureMembers
```
public StructureMembers getStructureMembers()
```
    Get the StructureMembers object.
    
    Returns:
    
    the StructureMembers object.
  - getStructureSize
```
public int getStructureSize()
```
    Get the size of each StructureData object in bytes.
    
    Returns:
    
    the size of each StructureData object in bytes.
  - iterator
```
public Iterator<StructureData> iterator()
```
    Specified by:
    
    iterator in interface Iterable<StructureData>
  - sectionNoReduce
```
public Array sectionNoReduce(List<Range> ranges)
```
    Description copied from class: Array
    
    Create a new Array as a subsection of this Array, without rank reduction. No data is moved, so the new Array references the same backing store as the original. Vlen is transferred over unchanged.
    
    Overrides:
    
    sectionNoReduce in class Array
    
    Parameters:
    
    ranges - list of Ranges that specify the array subset. Must be same rank as original Array. A particular Range: 1) may be a subset, or 2) may be null, meaning use entire Range.
    
    Returns:
    
    the new Array
  - setBoolean
```
public void setBoolean(Index i,
                       boolean value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setBoolean in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setBoolean
```
public void setBoolean(int index,
                       boolean value)
```
    Specified by:
    
    setBoolean in class Array
  - setByte
```
public void setByte(Index i,
                    byte value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setByte in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setByte
```
public void setByte(int index,
                    byte value)
```
    Specified by:
    
    setByte in class Array
  - setChar
```
public void setChar(Index i,
                    char value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setChar in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setChar
```
public void setChar(int index,
                    char value)
```
    Specified by:
    
    setChar in class Array
  - setDouble
```
public void setDouble(Index i,
                      double value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setDouble in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setDouble
```
public void setDouble(int index,
                      double value)
```
    Specified by:
    
    setDouble in class Array
  - setFloat
```
public void setFloat(Index i,
                     float value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setFloat in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setFloat
```
public void setFloat(int index,
                     float value)
```
    Specified by:
    
    setFloat in class Array
  - setInt
```
public void setInt(Index i,
                   int value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setInt in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setInt
```
public void setInt(int index,
                   int value)
```
    Specified by:
    
    setInt in class Array
  - setLong
```
public void setLong(Index i,
                    long value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setLong in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setLong
```
public void setLong(int index,
                    long value)
```
    Specified by:
    
    setLong in class Array
  - setMemberArray
```
public void setMemberArray(StructureMembers.Member m,
                           Array memberArray)
```
    Set data for one member, over all structures. This is used by VariableDS to do scale/offset.
    
    Parameters:
    
    m - set data for this StructureMembers.Member.
    
    memberArray - Array values.
  - setObject
```
public void setObject(Index i,
                      Object value)
```
    Set one of the StructureData of this ArrayStructure.
    
    Specified by:
    
    setObject in class Array
    
    Parameters:
    
    i - which one to set, specified by an Index.
    
    value - must be type StructureData.
  - setObject
```
public void setObject(int index,
                      Object value)
```
    Set the index-th StructureData of this ArrayStructure.
    
    Specified by:
    
    setObject in class Array
    
    Parameters:
    
    index - which one to set.
    
    value - must be type StructureData.
  - setShort
```
public void setShort(Index i,
                     short value)
```
    DO NOT USE, throw ForbiddenConversionException
    
    Specified by:
    
    setShort in class Array
    
    Parameters:
    
    i - Index with current element set
    
    value - the new value; cast to underlying data type if necessary.
  - setShort
```
public void setShort(int index,
                     short value)
```
    Specified by:
    
    setShort in class Array
  - showInternal
```
public void showInternal(Formatter f,
                         Indent indent)
```
  - showInternalMembers
```
public void showInternalMembers(Formatter f,
                                Indent indent)
```

Class ArrayStructure

Nested Class Summary

Method Summary

Methods inherited from class ucar.ma2.Array

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

convertScalarDouble

convertScalarFloat

convertScalarInt

convertScalarLong

copy

createView

extractMemberArray

findMember

getArray

getArrayObject

getArraySequence

getArrayStructure

getBoolean

getBoolean

getByte

getByte

getChar

getChar

getDouble

getDouble

getElementType

getFloat

getFloat

getInt

getInt

getJavaArrayByte

getJavaArrayChar

getJavaArrayDouble

getJavaArrayFloat

getJavaArrayInt

getJavaArrayLong

getJavaArrayShort

getJavaArrayString

getLong

getLong

getMembers

getObject

getObject

getScalarByte

getScalarChar

getScalarDouble

getScalarFloat

getScalarInt

getScalarLong

getScalarObject

getScalarShort

getScalarString

getScalarStructure

getShort

getShort

getSizeBytes

getStorage

getStructureData

getStructureData

getStructureDataIterator

getStructureMemberNames

getStructureMembers

getStructureSize

iterator

sectionNoReduce

setBoolean

setBoolean

setByte

setByte

setChar

setChar

setDouble

setDouble

setFloat

setFloat

setInt

setInt

setLong