ArrayStructureBB (NetCDF-Java 2.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ucar.ma2
Class ArrayStructureBB

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

Direct Known Subclasses:: ArrayStructureBBpos

public class ArrayStructureBB
extends ArrayStructure
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]);

Version:: $Revision:51 $ $Date:2006-07-12 17:13:13Z $
Author:: caron
See Also:: Array

Field Summary

Fields inherited from class ucar.ma2.Array
`scalarIndex`

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

Method Summary
`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()` Return backing storage as a byte[]
`static void`	`main(java.lang.String[] argv)` debug

Methods inherited from class ucar.ma2.ArrayStructure
`convertScalarDouble, copy, createView, getArray, 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.ArrayStructure

convertScalarDouble, copy, createView, getArray, 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

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,
                        java.nio.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

getStorage

public java.lang.Object getStorage()

Return backing storage as a byte[]

Specified by:: getStorage in class Array