## Uses of Class
hdf.object.Datatype

- Packages that use Datatype
  Package | Description
  --- | ---
  hdf.object |
  hdf.object.h4 |
  hdf.object.h5 |

- - ### Uses of Datatype in hdf.object

    Fields in hdf.object declared as Datatype
    Modifier and Type | Field and Description
    --- | ---
    `protected Datatype` | Datatype.`baseType` The base datatype of this datatype (null if this datatype is atomic).
    `protected Datatype` | Dataset.`datatype` The datatype object of the dataset.
    `protected Datatype[]` | Attribute.`memberTypes` The datatypes of the compound attribute's members.
    `protected Datatype[]` | CompoundDS.`memberTypes` The datatypes of compound members.

    Fields in hdf.object with type parameters of type Datatype
    Modifier and Type | Field and Description
    --- | ---
    `protected List<Datatype>` | Datatype.`compoundMemberTypes` The list of types of members of a compound Datatype.

    Methods in hdf.object that return Datatype
    Modifier and Type | Method and Description
    --- | ---
    `abstract Datatype` | FileFormat.`createDatatype(int tclass, int tsize, int torder, int tsign)` Creates a new datatype in memory.
    `Datatype` | FileFormat.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)` Creates a new datatype in memory.
    `Datatype` | FileFormat.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, String name)` Creates a named datatype in a file.
    `abstract Datatype` | FileFormat.`createDatatype(int tclass, int tsize, int torder, int tsign, String name)` Creates a named datatype in a file.
    `Datatype` | Attribute.`getDatatype()`
    `Datatype` | DataFormat.`getDatatype()` Returns the datatype of the data object.
    `Datatype` | Dataset.`getDatatype()`
    `Datatype` | Datatype.`getDatatypeBase()` Returns the datatype of the elements for this datatype.
    `Datatype[]` | Attribute.`getMemberTypes()` Returns an array of datatype objects of compound members.
    `Datatype[]` | CompoundDS.`getMemberTypes()` Returns an array of datatype objects of compound members.
    `Datatype[]` | CompoundDataFormat.`getMemberTypes()` Returns an array of datatype objects of the compound members.
    `Datatype[]` | Attribute.`getSelectedMemberTypes()` Returns an array of datatype objects of selected compound members.
    `Datatype[]` | CompoundDS.`getSelectedMemberTypes()` Returns an array of datatype objects of selected compound members.
    `Datatype[]` | CompoundDataFormat.`getSelectedMemberTypes()` Returns an array of datatype objects of the selected compound members.

    Methods in hdf.object that return types with arguments of type Datatype
    Modifier and Type | Method and Description
    --- | ---
    `List<Datatype>` | Datatype.`getCompoundMemberTypes()`

    Methods in hdf.object with parameters of type Datatype
    Modifier and Type | Method and Description
    --- | ---
    `Dataset` | FileFormat.`createCompoundDS(String name, Group pgroup, long[] dims, long[] maxdims, long[] chunks, int gzip, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)` Creates a new compound dataset in a file with/without chunking and compression.
    `Dataset` | FileFormat.`createCompoundDS(String name, Group pgroup, long[] dims, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)` Deprecated. As of 2.4, replaced by `FileFormat.createCompoundDS(String, Group, long[], long[], long[], int, String[], Datatype[], int[], Object)` The replacement method has additional parameters: `maxdims, chunks,` and `gzip`. To mimic the behavior originally provided by this method, call the replacement method with the following parameter list: `( name, pgroup, dims, null, null, -1, memberNames, memberDatatypes, memberSizes, data );`
    `Datatype` | FileFormat.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)` Creates a new datatype in memory.
    `Datatype` | FileFormat.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, String name)` Creates a named datatype in a file.
    `abstract Dataset` | FileFormat.`createImage(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)` Creates a new image in a file.
    `Dataset` | FileFormat.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object data)`
    `abstract Dataset` | FileFormat.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)` Creates a new dataset in a file with/without chunking/compression.

    Constructors in hdf.object with parameters of type Datatype
    Constructor and Description
    `Attribute(HObject parentObj, String attrName, Datatype attrType, long[] attrDims)` Create an attribute with specified name, data type and dimension sizes.
    `Attribute(HObject parentObj, String attrName, Datatype attrType, long[] attrDims, Object attrValue)` Create an attribute with specific name and value.
    `Datatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)` Constructs a Datatype with specified class, size, byte order and sign.
    `Datatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, Datatype pbase)` Constructs a Datatype with specified class, size, byte order and sign.
    `Datatype(long tid, Datatype pbase)` Constructs a Datatype with a given native datatype identifier.

  - ### Uses of Datatype in hdf.object.h4

    Subclasses of Datatype in hdf.object.h4
    Modifier and Type | Class and Description
    --- | ---
    `class` | `H4Datatype` This class defines HDF4 data type characteristics and APIs for a data type.

    Methods in hdf.object.h4 that return Datatype
    Modifier and Type | Method and Description
    --- | ---
    `Datatype` | H4File.`createDatatype(int tclass, int tsize, int torder, int tsign)`
    `Datatype` | H4File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)`
    `Datatype` | H4File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, String name)`
    `Datatype` | H4File.`createDatatype(int tclass, int tsize, int torder, int tsign, String name)`
    `Datatype` | H4GRImage.`getDatatype()`
    `Datatype` | H4SDS.`getDatatype()`
    `Datatype` | H4Vdata.`getDatatype()`

    Methods in hdf.object.h4 with parameters of type Datatype
    Modifier and Type | Method and Description
    --- | ---
    `static H4GRImage` | H4GRImage.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)` Creates a new image.
    `static H4SDS` | H4SDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object data)`
    `static H4SDS` | H4SDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)` Creates a new dataset.
    `Datatype` | H4File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)`
    `Datatype` | H4File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, String name)`
    `Dataset` | H4File.`createImage(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)`
    `Dataset` | H4File.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)`

  - ### Uses of Datatype in hdf.object.h5

    Subclasses of Datatype in hdf.object.h5
    Modifier and Type | Class and Description
    --- | ---
    `class` | `H5Datatype` This class defines HDF5 datatype characteristics and APIs for a data type.

    Methods in hdf.object.h5 that return Datatype
    Modifier and Type | Method and Description
    --- | ---
    `Datatype` | H5File.`createDatatype(int tclass, int tsize, int torder, int tsign)` Methods related to Datatypes and HObjects in HDF5 Files.
    `Datatype` | H5File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)`
    `Datatype` | H5File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, String name)`
    `Datatype` | H5File.`createDatatype(int tclass, int tsize, int torder, int tsign, String name)`
    `Datatype` | H5CompoundDS.`getDatatype()`
    `Datatype` | H5ScalarDS.`getDatatype()`

    Methods in hdf.object.h5 with parameters of type Datatype
    Modifier and Type | Method and Description
    --- | ---
    `static Dataset` | H5ScalarDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object data)`
    `static Dataset` | H5ScalarDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)` Creates a scalar dataset in a file with/without chunking and compression.
    `static Dataset` | H5CompoundDS.`create(String name, Group pgroup, long[] dims, long[] maxdims, long[] chunks, int gzip, String[] memberNames, Datatype[] memberDatatypes, int[] memberRanks, long[][] memberDims, Object data)` Creates a simple compound dataset in a file with/without chunking and compression.
    `static Dataset` | H5CompoundDS.`create(String name, Group pgroup, long[] dims, String[] memberNames, Datatype[] memberDatatypes, int[] memberRanks, long[][] memberDims, Object data)` Deprecated. Not for public use in the future. Using `H5CompoundDS.create(String, Group, long[], long[], long[], int, String[], Datatype[], int[], long[][], Object)`
    `static Dataset` | H5CompoundDS.`create(String name, Group pgroup, long[] dims, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)` Deprecated. Not for public use in the future. Using `H5CompoundDS.create(String, Group, long[], long[], long[], int, String[], Datatype[], int[], long[][], Object)`
    `Dataset` | H5File.`createCompoundDS(String name, Group pgroup, long[] dims, long[] maxdims, long[] chunks, int gzip, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)`
    `Datatype` | H5File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)`
    `Datatype` | H5File.`createDatatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, String name)`
    `Dataset` | H5File.`createImage(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)`
    `Dataset` | H5File.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)`

    Method parameters in hdf.object.h5 with type arguments of type Datatype
    Modifier and Type | Method and Description
    --- | ---
    `void` | H5Datatype.`extractCompoundInfo(String name, List<String> names, List<Datatype> flatListTypes)` Extracts compound information into flat structure.

    Constructors in hdf.object.h5 with parameters of type Datatype
    Constructor and Description
    `H5Datatype(int tclass, int tsize, int torder, int tsign, Datatype tbase)` Constructs a Datatype with specified class, size, byte order and sign.
    `H5Datatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, Datatype pbase)` Constructs a Datatype with specified class, size, byte order and sign.
    `H5Datatype(int tclass, int tsize, int torder, int tsign, Datatype tbase, Datatype pbase, List<H5Datatype> members)` Constructs a Datatype with specified class, size, byte order and sign.
    `H5Datatype(long nativeID, Datatype pbase)` Constructs a Datatype with a given native datatype identifier.

Copyright © 2018. All Rights Reserved.