org.bytedeco.hdf5

Class DataType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.hdf5.IdComponent

org.bytedeco.hdf5.H5Location

org.bytedeco.hdf5.H5Object

org.bytedeco.hdf5.DataType

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ArrayType, AtomType, CompType, EnumType, VarLenType

@Namespace(value="H5")
 @NoOffset
 @Properties(inherit=hdf5.class)
public class DataType
extends H5Object

\class DataType \brief Class DataType provides generic operations on HDF5 datatypes.

DataType inherits from H5Object because a named datatype is an HDF5 object and is a base class of ArrayType, AtomType, CompType, EnumType, and VarLenType.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
DataType()
DataType(DataType original)
DataType(H5Location loc, BytePointer name)
DataType(H5Location loc, Pointer ref)
DataType(H5Location loc, Pointer ref, int ref_type, PropList plist)
DataType(H5Location loc, String name)
DataType(int type_class, long size)
DataType(long type_id)
DataType(Pointer p) Pointer cast constructor.
DataType(PredType pred_type)

Method Summary

Modifier and Type	Method and Description
void	_close()
int	_getClass()
void	commit(H5Location loc, BytePointer name)
void	commit(H5Location loc, String name)
boolean	committed()
void	convert(DataType dest, long nelmts, Pointer buf, Pointer background)
void	convert(DataType dest, long nelmts, Pointer buf, Pointer background, PropList plist)
void	copy(DataSet dset)
void	copy(DataType like_type)
DataType	decode()
boolean	detectClass(int cls)
static boolean	detectClass(PredType pred_type, int cls)
void	encode()
boolean	equals(DataType compared_type)
H5T_conv_t	find(DataType dest, H5T_cdata_t pcdata)
H5T_conv_t	find(DataType dest, PointerPointer pcdata)
BytePointer	fromClass() \brief Returns this class name.
PropList	getCreatePlist()
long	getId()
long	getSize()
DataType	getSuper()
BytePointer	getTag()
boolean	hasBinaryDesc()
boolean	isVariableStr()
void	lock()
boolean	notEquals(DataType compared_type)
DataType	put(DataType rhs)
void	registerFunc(int pers, BytePointer name, DataType dest, H5T_conv_t func)
void	registerFunc(int pers, String name, DataType dest, H5T_conv_t func)
void	setTag(BytePointer tag)
void	setTag(String tag)
void	unregister(int pers, BytePointer name, DataType dest, H5T_conv_t func)
void	unregister(int pers, String name, DataType dest, H5T_conv_t func)

Methods inherited from class org.bytedeco.hdf5.H5Object

attrExists, attrExists, createAttribute, createAttribute, createAttribute, createAttribute, getNumAttrs, getObjName, getObjName, getObjName, getObjName, getObjName, getObjName, getObjName, iterateAttrs, iterateAttrs, iterateAttrs, iterateAttrs, objVersion, openAttribute, openAttribute, openAttribute, removeAttr, removeAttr, renameAttr, renameAttr, visit

Methods inherited from class org.bytedeco.hdf5.H5Location

childObjType, childObjType, childObjType, childObjType, childObjType, childObjVersion, childObjVersion, copyLink, copyLink, copyLink, copyLink, copyLink, copyLink, copyLink, copyLink, createDataSet, createDataSet, createDataSet, createDataSet, createGroup, createGroup, createGroup, createGroup, createGroup, createGroup, dereference, dereference, exists, exists, exists, exists, flush, getComment, getComment, getComment, getComment, getComment, getComment, getComment, getComment, getComment, getComment, getFileName, getLinkInfo, getLinkInfo, getLinkInfo, getLinkInfo, getLinkval, getLinkval, getLinkval, getLinkval, getNumObjs, getObjinfo, getObjinfo, getObjinfo, getObjinfo, getObjinfo, getObjinfo, getObjinfo, getObjinfo, getObjinfo, getObjinfo, getObjnameByIdx, getObjnameByIdx, getObjnameByIdx, getObjnameByIdx, getRefObjType, getRefObjType, getRegion, getRegion, link, link, link, link, link, link, link, link, link, link, link, link, link, link, mount, mount, move, move, moveLink, moveLink, moveLink, moveLink, moveLink, moveLink, moveLink, moveLink, nameExists, nameExists, nameExists, nameExists, openDataSet, openDataSet, openDataSet, openDataSet, openGroup, openGroup, reference, reference, reference, reference, reference, reference, reference, reference, removeComment, removeComment, setComment, setComment, setComment, setComment, throwException, throwException, unlink, unlink, unlink, unlink, unmount, unmount

Methods inherited from class org.bytedeco.hdf5.IdComponent

decRefCount, decRefCount, getCounter, getCounter, getHDFObjType, getHDFObjType, getNumMembers, incRefCount, incRefCount, inMemFunc, inMemFunc, isValid, put, setId, typeExists

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataType

public DataType(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

DataType

public DataType(@Cast(value="const H5T_class_t")
                int type_class,
                @Cast(value="size_t")
                long size)

DataType

public DataType(@Const @ByRef
                DataType original)

DataType

public DataType(@Const @ByRef
                PredType pred_type)

DataType

public DataType(@Const @ByRef
                H5Location loc,
                @Cast(value="const char*")
                BytePointer name)

DataType

public DataType(@Const @ByRef
                H5Location loc,
                String name)

DataType

public DataType(@Const @ByRef
                H5Location loc,
                @Const
                Pointer ref,
                @Cast(value="H5R_type_t")
                int ref_type,
                @Const @ByRef(nullValue="H5::PropList::DEFAULT")
                PropList plist)

DataType

public DataType(@Const @ByRef
                H5Location loc,
                @Const
                Pointer ref)

DataType

public DataType(@Cast(value="const hid_t")
                long type_id)

DataType

public DataType()

Method Detail

_close

@Name(value="close")
public void _close()

Overrides:

_close in class IdComponent

copy

public void copy(@Const @ByRef
                 DataType like_type)

copy

public void copy(@Const @ByRef
                 DataSet dset)

decode

public DataType decode()

encode

public void encode()

_getClass

@Cast(value="H5T_class_t")
 @Name(value="getClass")
public int _getClass()

commit

public void commit(@Const @ByRef
                   H5Location loc,
                   @Cast(value="const char*")
                   BytePointer name)

commit

public void commit(@Const @ByRef
                   H5Location loc,
                   String name)

committed

@Cast(value="bool")
public boolean committed()

find

public H5T_conv_t find(@Const @ByRef
                       DataType dest,
                       @Cast(value="H5T_cdata_t**")
                       PointerPointer pcdata)

find

public H5T_conv_t find(@Const @ByRef
                       DataType dest,
                       @ByPtrPtr
                       H5T_cdata_t pcdata)

convert

public void convert(@Const @ByRef
                    DataType dest,
                    @Cast(value="size_t")
                    long nelmts,
                    Pointer buf,
                    Pointer background,
                    @Const @ByRef(nullValue="H5::PropList::DEFAULT")
                    PropList plist)

convert

public void convert(@Const @ByRef
                    DataType dest,
                    @Cast(value="size_t")
                    long nelmts,
                    Pointer buf,
                    Pointer background)

put

@ByRef
 @Name(value="operator =")
public DataType put(@Const @ByRef
                                                      DataType rhs)

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                      DataType compared_type)

notEquals

@Cast(value="bool")
 @Name(value="operator !=")
public boolean notEquals(@Const @ByRef
                                                                         DataType compared_type)

lock

public void lock()

getSize

@Cast(value="size_t")
public long getSize()

getSuper

@ByVal
public DataType getSuper()

registerFunc

public void registerFunc(@Cast(value="H5T_pers_t")
                         int pers,
                         @Cast(value="const char*")
                         BytePointer name,
                         @Const @ByRef
                         DataType dest,
                         H5T_conv_t func)

registerFunc

public void registerFunc(@Cast(value="H5T_pers_t")
                         int pers,
                         String name,
                         @Const @ByRef
                         DataType dest,
                         H5T_conv_t func)

unregister

public void unregister(@Cast(value="H5T_pers_t")
                       int pers,
                       @Cast(value="const char*")
                       BytePointer name,
                       @Const @ByRef
                       DataType dest,
                       H5T_conv_t func)

unregister

public void unregister(@Cast(value="H5T_pers_t")
                       int pers,
                       String name,
                       @Const @ByRef
                       DataType dest,
                       H5T_conv_t func)

setTag

public void setTag(@Cast(value="const char*")
                   BytePointer tag)

setTag

public void setTag(String tag)

getTag

@StdString
public BytePointer getTag()

detectClass

@Cast(value="bool")
public boolean detectClass(@Cast(value="H5T_class_t")
                                               int cls)

detectClass

@Cast(value="bool")
public static boolean detectClass(@Const @ByRef
                                                      PredType pred_type,
                                                      @Cast(value="H5T_class_t")
                                                      int cls)

isVariableStr

@Cast(value="bool")
public boolean isVariableStr()

getCreatePlist

@ByVal
public PropList getCreatePlist()

fromClass

@StdString
public BytePointer fromClass()

\brief Returns this class name.

Overrides:

fromClass in class IdComponent

hasBinaryDesc

@Cast(value="bool")
public boolean hasBinaryDesc()

getId

@Cast(value="hid_t")
public long getId()

Overrides:

getId in class H5Object