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

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

All Implemented Interfaces:

Iterable<StructureData>

Direct Known Subclasses:

ArrayStructureBBpos, ArrayStructureBBsection
```
public class ArrayStructureBB
extends ArrayStructure
```
Concrete implementation of ArrayStructure, data storage is in a ByteBuffer, which is converted to member data on the fly. In order to use this, the records must have the same size, and the member offset must be the same for each record. Use StructureMembers.setStructureSize() to set the record size. Use StructureMembers.Member.setDataParam() to set the offset of the member from the start of each record. The member data will then be located in the BB at offset = recnum * getStructureSize() + member.getDataParam(). This defers object creation for efficiency. Use getArray
() and getScalar
() data accessors if possible.
```
 Structure pdata = (Structure) ncfile.findVariable(name);
 StructureMembers members = pdata.makeStructureMembers();
 members.findMember("value").setDataParam(0); // these are the offsets into the record
 members.findMember("x_start").setDataParam(2);
 members.findMember("y_start").setDataParam(4);
 members.findMember("direction").setDataParam(6);
 members.findMember("speed").setDataParam(8);
 int recsize = pos[1] - pos[0]; // each record must be all the same size
 members.setStructureSize(recsize);
 ArrayStructureBB asbb = new ArrayStructureBB(members, new int[] {size}, bos, pos[0]);
 
```
For String members, you must store the Strings in the stringHeap. An integer index into the heap is used in the ByteBuffer.
See Also:

Array

Nested Class Summary
- Nested classes/interfaces inherited from class ucar.ma2.ArrayStructure
  ArrayStructure.ArrayStructureIterator

Constructor Summary

Constructors
Constructor and Description
`ArrayStructureBB(StructureMembers members, int[] shape)` Create a new Array of type StructureData and the given members and shape.
`ArrayStructureBB(StructureMembers members, int[] shape, ByteBuffer bbuffer, int offset)` Construct an ArrayStructureBB with the given ByteBuffer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addObjectToHeap(int recnum, StructureMembers.Member m, Object s)`
`int`	`addObjectToHeap(Object s)`
`Array`	`getArray(int recnum, StructureMembers.Member m)` Get member data of any type for a specific record as an Array.
`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.
`ByteBuffer`	`getByteBuffer()` Return backing storage as a ByteBuffer
`List<Object>`	`getHeap()` DO NOT MODIFY
`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.
`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.
`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.
`static int`	`setOffsets(StructureMembers members)` Set the offsets, based on m.getSizeBytes().
`void`	`showInternal(Formatter f, Indent indent)`
`static int`	`showOffsets(StructureMembers members, Indent indent, Formatter f)`

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

- Constructor Detail
  - ArrayStructureBB
```
public ArrayStructureBB(StructureMembers members,
                        int[] shape)
```
    Create a new Array of type StructureData and the given members and shape. Generally, you extract the byte array and fill it:
```
 byte[] result = (byte[]) structureArray.getStorage();
 
```
    Parameters:
    
    members - a description of the structure members
    
    shape - the shape of the Array.
  - ArrayStructureBB
```
public ArrayStructureBB(StructureMembers members,
                        int[] shape,
                        ByteBuffer bbuffer,
                        int offset)
```
    Construct an ArrayStructureBB with the given ByteBuffer.
    
    Parameters:
    
    members - the list of structure members.
    
    shape - the shape of the structure array
    
    bbuffer - the data is stored in this ByteBuffer. bbuffer.order must already be set.
    
    offset - offset from the start of the ByteBufffer to the first record.
- Method Detail
  - addObjectToHeap
```
public void addObjectToHeap(int recnum,
                            StructureMembers.Member m,
                            Object s)
```
  - addObjectToHeap
```
public int addObjectToHeap(Object s)
```
  - getArray
```
public Array getArray(int recnum,
                      StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    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).
    
    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.
  - getArraySequence
```
public ArraySequence getArraySequence(int recnum,
                                      StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type ArraySequence
    
    Overrides:
    
    getArraySequence 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.
  - getArrayStructure
```
public ArrayStructure getArrayStructure(int recnum,
                                        StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type array of Structure.
    
    Overrides:
    
    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.
  - getByteBuffer
```
public ByteBuffer getByteBuffer()
```
    Return backing storage as a ByteBuffer
    
    Returns:
    
    backing storage as a ByteBuffer
  - getHeap
```
public List<Object> getHeap()
```
    DO NOT MODIFY
    
    Returns:
    
    heap
  - getJavaArrayByte
```
public byte[] getJavaArrayByte(int recnum,
                               StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type byte as a 1D array.
    
    Overrides:
    
    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[]
  - getJavaArrayChar
```
public char[] getJavaArrayChar(int recnum,
                               StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type char as a 1D array.
    
    Overrides:
    
    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[]
  - 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.
    
    Overrides:
    
    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[]
  - getJavaArrayFloat
```
public float[] getJavaArrayFloat(int recnum,
                                 StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type float as a 1D array.
    
    Overrides:
    
    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[]
  - getJavaArrayInt
```
public int[] getJavaArrayInt(int recnum,
                             StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type int as a 1D array.
    
    Overrides:
    
    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[]
  - getJavaArrayLong
```
public long[] getJavaArrayLong(int recnum,
                               StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type long as a 1D array.
    
    Overrides:
    
    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[]
  - getJavaArrayShort
```
public short[] getJavaArrayShort(int recnum,
                                 StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type short as a 1D array.
    
    Overrides:
    
    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[]
  - getJavaArrayString
```
public String[] getJavaArrayString(int recnum,
                                   StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type String as a 1D array.
    
    Overrides:
    
    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[]
  - getScalarByte
```
public byte getScalarByte(int recnum,
                          StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type byte.
    
    Overrides:
    
    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
  - getScalarChar
```
public char getScalarChar(int recnum,
                          StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type char.
    
    Overrides:
    
    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
  - getScalarDouble
```
public double getScalarDouble(int recnum,
                              StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type double.
    
    Overrides:
    
    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
  - getScalarFloat
```
public float getScalarFloat(int recnum,
                            StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type float.
    
    Overrides:
    
    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
  - getScalarInt
```
public int getScalarInt(int recnum,
                        StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type int.
    
    Overrides:
    
    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
  - getScalarLong
```
public long getScalarLong(int recnum,
                          StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type long.
    
    Overrides:
    
    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
  - getScalarShort
```
public short getScalarShort(int recnum,
                            StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get scalar member data of type short.
    
    Overrides:
    
    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
  - getScalarString
```
public String getScalarString(int recnum,
                              StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type String or char.
    
    Overrides:
    
    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
  - getScalarStructure
```
public StructureData getScalarStructure(int recnum,
                                        StructureMembers.Member m)
```
    Description copied from class: ArrayStructure
    
    Get member data of type Structure.
    
    Overrides:
    
    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
  - setOffsets
```
public static int setOffsets(StructureMembers members)
```
    Set the offsets, based on m.getSizeBytes(). Also sets members.setStructureSize().
    
    Parameters:
    
    members - set offsets for these members
    
    Returns:
    
    the total size
  - showInternal
```
public void showInternal(Formatter f,
                         Indent indent)
```
    Overrides:
    
    showInternal in class ArrayStructure
  - showOffsets
```
public static int showOffsets(StructureMembers members,
                              Indent indent,
                              Formatter f)
```

Class ArrayStructureBB

Nested Class Summary

Nested classes/interfaces inherited from class ucar.ma2.ArrayStructure

Constructor Summary

Method Summary

Methods inherited from class ucar.ma2.ArrayStructure

Methods inherited from class ucar.ma2.Array

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

ArrayStructureBB

ArrayStructureBB

Method Detail

addObjectToHeap

addObjectToHeap

getArray

getArraySequence

getArrayStructure

getByteBuffer

getHeap

getJavaArrayByte

getJavaArrayChar

getJavaArrayDouble

getJavaArrayFloat

getJavaArrayInt

getJavaArrayLong

getJavaArrayShort

getJavaArrayString

getScalarByte

getScalarChar

getScalarDouble

getScalarFloat

getScalarInt

getScalarLong

getScalarShort

getScalarString

getScalarStructure

setOffsets

showInternal

showOffsets