Logo Search packages:      
Sourcecode: jhdf version File versions  Download package

ncsa::hdf::object::Datatype Class Reference

Inheritance diagram for ncsa::hdf::object::Datatype:

ncsa::hdf::object::HObject ncsa::hdf::object::DataFormat ncsa::hdf::object::fits::FitsDatatype ncsa::hdf::object::h4::H4Datatype ncsa::hdf::object::h5::H5Datatype ncsa::hdf::object::nc2::NC2Datatype

List of all members.

Detailed Description

Datatype is an abstract class that defines datatype characteristics and APIs for a data type.

A datatype has four basic characteristics: class, size, byte order and sign. These charactertics are defeined in the HDF5 User's Guide.

These charactertics apply to all the sub-classes. The sub-classes may have different ways to describe a datatype. We here define the native datatype to the datatype used by the sub-class. For example, H5Datatype uses a datatype identifier (hid_t) to specify a datatype. NC2Datatype uses ucar.nc2.DataType object to describe its dataype. "Native" here is different from the "native" definition in the HDF5 library.

Two functions, toNative() and fromNative(), are defined to convert the general charactertics to/form the native datatype. Sub-classes must implement these functions so that the conversion will be done correctly.

1.1 9/4/2007
Peter X. Cao

Definition at line 39 of file Datatype.java.

Public Member Functions

abstract void close (int id)
 Datatype (int type)
 Datatype (int tclass, int tsize, int torder, int tsign)
 Datatype (FileFormat theFile, String name, String path, long[] oid)
 Datatype (FileFormat theFile, String name, String path)
final boolean equalsOID (long[] theID)
abstract void fromNative (int nativeID)
Datatype getBasetype ()
int getDatatypeClass ()
String getDatatypeDescription ()
int getDatatypeOrder ()
int getDatatypeSign ()
int getDatatypeSize ()
final String getEnumMembers ()
final int getFID ()
final String getFile ()
final FileFormat getFileFormat ()
final String getFullName ()
List getMetadata () throws Exception
final String getName ()
final long[] getOID ()
final String getPath ()
abstract boolean hasAttribute ()
abstract boolean isUnsigned ()
int open ()
void removeMetadata (Object info) throws Exception
final void setEnumMembers (String enumStr)
void setName (String newName) throws Exception
void setPath (String newPath) throws Exception
abstract int toNative ()
String toString ()
void writeMetadata (Object info) throws Exception

Static Public Attributes

static final int CLASS_ARRAY = 10
static final int CLASS_BITFIELD = 4
static final int CLASS_CHAR = 2
static final int CLASS_COMPOUND = 6
static final int CLASS_ENUM = 8
static final int CLASS_FLOAT = 1
static final int CLASS_INTEGER = 0
static final int CLASS_NO_CLASS = -1
static final int CLASS_OPAQUE = 5
static final int CLASS_REFERENCE = 7
static final int CLASS_STRING = 3
static final int CLASS_VLEN = 9
static final int NATIVE = -1
static final int NSGN = 2
static final int ORDER_BE = 1
static final int ORDER_LE = 0
static final int ORDER_NONE = 3
static final int ORDER_VAX = 2
static final String separator = "/"
static final long serialVersionUID = 240L
static final int SIGN_2 = 1
static final int SIGN_NONE = 0

Protected Member Functions

final void debug (Object msg)

Protected Attributes

Datatype baseType
int datatypeClass
int datatypeOrder
int datatypeSign
int datatypeSize
int[] dims
String enumMembers
long[] oid

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index