Package org.bytedeco.hdf5

Class H5File

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.hdf5.IdComponent

org.bytedeco.hdf5.H5Location

org.bytedeco.hdf5.H5Object

org.bytedeco.hdf5.Group

org.bytedeco.hdf5.H5File

All Implemented Interfaces:

AutoCloseable

@Namespace("H5")
@NoOffset
@Properties(inherit=hdf5.class)
public class H5File
extends Group

\class H5File \brief Class H5File represents an HDF5 file and inherits from class Group as file is a root group.

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	Description
H5File()
H5File(long existing_id)
H5File(String name, int flags)
H5File(String name, int flags, FileAccPropList access_plist)
H5File(String name, int flags, FileCreatPropList create_plist, FileAccPropList access_plist)
H5File(H5File original)
H5File(BytePointer name, int flags)
H5File(BytePointer name, int flags, FileAccPropList access_plist)
H5File(BytePointer name, int flags, FileCreatPropList create_plist, FileAccPropList access_plist)
H5File(Pointer p)	Pointer cast constructor.

Method Summary

Modifier and Type	Method	Description
void	_close()
BytePointer	fromClass()	\brief Returns this class name.
FileAccPropList	getAccessPlist()
FileCreatPropList	getCreatePlist()
void	getFileInfo(H5F_info2_t file_info)
long	getFileNum()
long	getFileSize()
long	getFreeSpace()
long	getId()
long	getLocId()
long	getObjCount()
long	getObjCount(int types)
void	getObjIDs(int types, long max_objs, long... oid_list)
void	getObjIDs(int types, long max_objs, LongBuffer oid_list)
void	getObjIDs(int types, long max_objs, LongPointer oid_list)
void	getVFDHandle(FileAccPropList fapl, Pointer file_handle)
void	getVFDHandle(FileAccPropList fapl, PointerPointer file_handle)
void	getVFDHandle(Pointer file_handle)
void	getVFDHandle(PointerPointer file_handle)
static boolean	isAccessible(String name)
static boolean	isAccessible(String name, FileAccPropList access_plist)
static boolean	isAccessible(BytePointer name)
static boolean	isAccessible(BytePointer name, FileAccPropList access_plist)
static boolean	isHdf5(String name)
static boolean	isHdf5(BytePointer name)
void	openFile(String name, int flags)
void	openFile(String name, int flags, FileAccPropList access_plist)
void	openFile(BytePointer name, int flags)
void	openFile(BytePointer name, int flags, FileAccPropList access_plist)
void	reopen()
void	reOpen()
void	throwException(String func_name, String msg)
void	throwException(BytePointer func_name, BytePointer msg)	For subclasses, H5File and Group, to throw appropriate exception.

Methods inherited from class org.bytedeco.hdf5.Group

asCommonFG, asCommonFG, closeObjId, getNumObjs, getObjId, getObjId, getObjId, getObjId

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, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, getNativeObjinfo, 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, 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, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

H5File

public H5File(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

H5File

public H5File(@Cast("const char*")
              BytePointer name,
              @Cast("unsigned int")
              int flags,
              @Const @ByRef(nullValue="H5::FileCreatPropList::DEFAULT")
              FileCreatPropList create_plist,
              @Const @ByRef(nullValue="H5::FileAccPropList::DEFAULT")
              FileAccPropList access_plist)

H5File

public H5File(@Cast("const char*")
              BytePointer name,
              @Cast("unsigned int")
              int flags)

H5File

public H5File(String name,
              @Cast("unsigned int")
              int flags,
              @Const @ByRef(nullValue="H5::FileCreatPropList::DEFAULT")
              FileCreatPropList create_plist,
              @Const @ByRef(nullValue="H5::FileAccPropList::DEFAULT")
              FileAccPropList access_plist)

H5File

public H5File(String name,
              @Cast("unsigned int")
              int flags)

H5File

public H5File(@Cast("const char*")
              BytePointer name,
              @Cast("unsigned int")
              int flags,
              @Const @ByRef
              FileAccPropList access_plist)

H5File

public H5File(String name,
              @Cast("unsigned int")
              int flags,
              @Const @ByRef
              FileAccPropList access_plist)

H5File

public H5File(@Cast("hid_t")
              long existing_id)

H5File

public H5File()

H5File

public H5File(@Const @ByRef
              H5File original)

Method Detail

openFile

public void openFile(@StdString
                     BytePointer name,
                     @Cast("unsigned int")
                     int flags,
                     @Const @ByRef(nullValue="H5::FileAccPropList::DEFAULT")
                     FileAccPropList access_plist)

openFile

public void openFile(@StdString
                     BytePointer name,
                     @Cast("unsigned int")
                     int flags)

openFile

public void openFile(@StdString
                     String name,
                     @Cast("unsigned int")
                     int flags,
                     @Const @ByRef(nullValue="H5::FileAccPropList::DEFAULT")
                     FileAccPropList access_plist)

openFile

public void openFile(@StdString
                     String name,
                     @Cast("unsigned int")
                     int flags)

_close

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

Overrides:

_close in class Group

getAccessPlist

@ByVal
public FileAccPropList getAccessPlist()

getCreatePlist

@ByVal
public FileCreatPropList getCreatePlist()

getFileInfo

public void getFileInfo(@ByRef
                        H5F_info2_t file_info)

getFreeSpace

@Cast("hssize_t")
public long getFreeSpace()

getObjCount

@Cast("ssize_t")
public long getObjCount(@Cast("unsigned")
                        int types)

getObjCount

@Cast("ssize_t")
public long getObjCount()

getObjIDs

public void getObjIDs(@Cast("unsigned")
                      int types,
                      @Cast("size_t")
                      long max_objs,
                      @Cast("hid_t*")
                      LongPointer oid_list)

getObjIDs

public void getObjIDs(@Cast("unsigned")
                      int types,
                      @Cast("size_t")
                      long max_objs,
                      @Cast("hid_t*")
                      LongBuffer oid_list)

getObjIDs

public void getObjIDs(@Cast("unsigned")
                      int types,
                      @Cast("size_t")
                      long max_objs,
                      @Cast("hid_t*")
                      long... oid_list)

getVFDHandle

public void getVFDHandle(@Cast("void**")
                         PointerPointer file_handle)

getVFDHandle

public void getVFDHandle(@Cast("void**") @ByPtrPtr
                         Pointer file_handle)

getVFDHandle

public void getVFDHandle(@Const @ByRef
                         FileAccPropList fapl,
                         @Cast("void**")
                         PointerPointer file_handle)

getVFDHandle

public void getVFDHandle(@Const @ByRef
                         FileAccPropList fapl,
                         @Cast("void**") @ByPtrPtr
                         Pointer file_handle)

getFileSize

@Cast("hsize_t")
public long getFileSize()

getFileNum

@Cast("unsigned long")
public long getFileNum()

isHdf5

@Cast("bool")
public static boolean isHdf5(@Cast("const char*")
                             BytePointer name)

isHdf5

@Cast("bool")
public static boolean isHdf5(String name)

isAccessible

@Cast("bool")
public static boolean isAccessible(@Cast("const char*")
                                   BytePointer name,
                                   @Const @ByRef(nullValue="H5::FileAccPropList::DEFAULT")
                                   FileAccPropList access_plist)

isAccessible

@Cast("bool")
public static boolean isAccessible(@Cast("const char*")
                                   BytePointer name)

isAccessible

@Cast("bool")
public static boolean isAccessible(String name,
                                   @Const @ByRef(nullValue="H5::FileAccPropList::DEFAULT")
                                   FileAccPropList access_plist)

isAccessible

@Cast("bool")
public static boolean isAccessible(String name)

reOpen

public void reOpen()

reopen

public void reopen()

fromClass

@StdString
public BytePointer fromClass()

\brief Returns this class name.

Overrides:

fromClass in class Group

throwException

public void throwException(@StdString
                           BytePointer func_name,
                           @StdString
                           BytePointer msg)

Description copied from class: H5Location

For subclasses, H5File and Group, to throw appropriate exception.

Overrides:

throwException in class Group

throwException

public void throwException(@StdString
                           String func_name,
                           @StdString
                           String msg)

Overrides:

throwException in class Group

getLocId

@Cast("hid_t")
public long getLocId()

Overrides:

getLocId in class Group

getId

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

Overrides:

getId in class Group