Package hdf.hdflib

# Class HDFArray

java.lang.Object
hdf.hdflib.HDFArray

public class HDFArray extends Object
This is a class for handling multidimensional arrays for HDF.

The purpose is to allow the storage and retrieval of arbitrary array types containing scientific data.

The methods support the conversion of an array to and from Java to a one-dimensional array of bytes suitable for I/O by the C library.

This class heavily uses the HDFNativeData class to convert between Java and C representations.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `HDFArray​(Object anArray)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `arrayify​(byte[] bytes)`
  `byte[]`
  `byteify()`
  `byte[]`
  `emptyBytes()`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### HDFArray

    public HDFArray​(Object anArray) throws HDFException
    Throws:
      `HDFException`

- ## Method Details

  - ### emptyBytes

    public byte[] emptyBytes() throws HDFException
    Returns:
      the allocated one-dimensional array of bytes sufficient to store the array.
    Throws:
      `HDFException` - thrown for errors: object is not allocated: HDFJavaException

  - ### byteify

    public byte[] byteify() throws HDFException
    Returns:
      conversion of a Java array of numbers to a one-dimensional array of bytes in correct native order.
    Throws:
      `HDFException` - thrown for errors: object is not array: HDFJavaException

  - ### arrayify

    public Object arrayify​(byte[] bytes) throws HDFException
    Parameters:
      `bytes` - a one-dimensional array of numbers
    Returns:
      convert it to a java array of the shape and size passed to the constructor.
    Throws:
      `HDFException` - thrown for errors: object not an array: HDFJavaException