ncsa.hdf.hdf5lib
Class HDF5GroupInfo

java.lang.Object
  ncsa.hdf.hdf5lib.HDF5GroupInfo

public class HDF5GroupInfo

extends Object

This class is a container for the information reported about an HDF5 Object from the H5Gget_obj_info() method.

The fileno and objno fields contain four values which uniquely identify an object among those HDF5 files which are open: if all four values are the same between two objects, then the two objects are the same (provided both files are still open). The nlink field is the number of hard links to the object or zero when information is being returned about a symbolic link (symbolic links do not have hard links but all other objects always have at least one). The type field contains the type of the object, one of H5G_GROUP, H5G_DATASET, or H5G_LINK. The mtime field contains the modification time. If information is being returned about a symbolic link then linklen will be the length of the link value (the name of the pointed-to object with the null terminator); otherwise linklen will be zero. Other fields may be added to this structure in the future.

For details of the HDF5 libraries, see the HDF5 Documentation at: http://hdf.ncsa.uiuc.edu/HDF5/doc/

Field Summary

(package private) long[]	fileno
(package private) int	linklen
(package private) long	mtime
(package private) int	nlink
(package private) long[]	objno
(package private) int	type

Constructor Summary

HDF5GroupInfo()

Method Summary

long[]	getFileno()
int	getLinklen()
long	getMtime()
int	getNlink()
long[]	getObjno()
int	getType()
void	setGroupInfo(long[] fn, long[] on, int nl, int t, long mt, int len) Sets the HDF5 group information.
String	toString() Converts this object to a String representation.

Methods inherited from class java.lang.Object

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

Field Detail

fileno

long[] fileno

objno

long[] objno

nlink

int nlink

type

int type

mtime

long mtime

linklen

int linklen

Constructor Detail

HDF5GroupInfo

public HDF5GroupInfo()

Method Detail

setGroupInfo

public void setGroupInfo(long[] fn,
                         long[] on,
                         int nl,
                         int t,
                         long mt,
                         int len)

Sets the HDF5 group information. Used by the JHI5.

Parameters:

fn - File id number

on - Object id number

nl - Number of links

t - Type of the object

mt - Modification time

len - Length of link

getFileno

public long[] getFileno()

getObjno

public long[] getObjno()

getType

public int getType()

getNlink

public int getNlink()

getMtime

public long getMtime()

getLinklen

public int getLinklen()

toString

public String toString()

Converts this object to a String representation.

Returns:

a string representation of this object