## Uses of Class
hdf.object.HObject

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

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

    Subclasses of HObject in hdf.object
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Attribute` An attribute is a (name, value) pair of metadata attached to a primary data object such as a dataset, group or named datatype.
    `class` | `CompoundDS` A CompoundDS is a dataset with compound datatype.
    `class` | `Dataset` The abstract class provides general APIs to create and manipulate dataset objects, and retrieve dataset properties, datatype and dimension sizes.
    `class` | `Datatype` Datatype is an abstract class that defines datatype characteristics and APIs for a data type.
    `class` | `Group` Group is an abstract class.
    `class` | `ScalarDS` A scalar dataset is a multiple dimension array of scalar points.

    Fields in hdf.object declared as HObject
    Modifier and Type | Field and Description
    --- | ---
    `protected HObject` | Attribute.`parentObject` The HObject to which this Attribute is attached

    Methods in hdf.object that return HObject
    Modifier and Type | Method and Description
    --- | ---
    `HObject` | FileFormat.`copy(HObject srcObj, Group dstGroup)` Deprecated. As of 2.4, replaced by `FileFormat.copy(HObject, Group, String)` To mimic the behavior originally provided by this method, call the replacement method with `null` as the 3rd parameter.
    `abstract HObject` | FileFormat.`copy(HObject srcObj, Group dstGroup, String dstName)` Copies the source object to a new destination.
    `HObject` | FileFormat.`createLink(Group parentGroup, String name, HObject currentObj, int type)` Creates a soft, hard or external link to an existing object in the open file.
    `HObject` | FileFormat.`createLink(Group linkGroup, String name, Object currentObj)` Creates a link to an existing object in the open file.
    `HObject` | FileFormat.`createLink(Group parentGroup, String name, String currentObj, int type)` Creates a soft or external link to an object in a file that does not exist at the time the link is created.
    `static HObject` | FileFormat.`findObject(FileFormat file, long[] oid)` Finds an object by its object ID
    `static HObject` | FileFormat.`findObject(FileFormat file, String path)` Finds an object by the full path of the object (path+name)
    `abstract HObject` | FileFormat.`get(String path)` Gets the HObject with the specified path from the file.
    `static HObject` | FileFormat.`getHObject(String fullPath)` Deprecated. As of 2.4, replaced by `FileFormat.get(String)` This static method, which as been deprecated, causes two problems: It can be very expensive if it is called many times or in a loop because each call to the method creates an instance of a file. Since the method does not return the instance of the file, the file cannot be closed directly and may be left open (memory leak). The only way to close the file is through the object returned by this method.
    - `static HObject` | FileFormat.`getHObject(String filename, String path)` Deprecated. As of 2.4, replaced by `FileFormat.get(String)` This static method, which as been deprecated, causes two problems: It can be very expensive if it is called many times or in a loop because each call to the method creates an instance of a file. Since the method does not return the instance of the file, the file cannot be closed directly and may be left open (memory leak). The only way to close the file is through the object returned by this method, for example:
           Dataset dset = H5File.getObject("hdf5_test.h5", "/images/iceburg");
           ...
           // close the file through dset
           dset.getFileFormat().close();
    `HObject` | Group.`getMember(int idx)` Get the HObject at the specified index in this Group's member list.
    `HObject` | Attribute.`getParentObject()` Returns the HObject to which this Attribute is currently "attached".
    `abstract HObject` | FileFormat.`getRootObject()` Returns the root object for the file associated with this instance.

    Methods in hdf.object that return types with arguments of type HObject
    Modifier and Type | Method and Description
    --- | ---
    `List<HObject>` | Group.`breadthFirstMemberList()`
    `List<HObject>` | Group.`depthFirstMemberList()`
    `List<HObject>` | Group.`getMemberList()` Returns the list of members of this group.

    Methods in hdf.object with parameters of type HObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | Group.`addToMemberList(HObject object)` Adds an object to the member list of this group in memory.
    `HObject` | FileFormat.`copy(HObject srcObj, Group dstGroup)` Deprecated. As of 2.4, replaced by `FileFormat.copy(HObject, Group, String)` To mimic the behavior originally provided by this method, call the replacement method with `null` as the 3rd parameter.
    `abstract HObject` | FileFormat.`copy(HObject srcObj, Group dstGroup, String dstName)` Copies the source object to a new destination.
    `HObject` | FileFormat.`createLink(Group parentGroup, String name, HObject currentObj, int type)` Creates a soft, hard or external link to an existing object in the open file.
    `abstract void` | FileFormat.`delete(HObject obj)` Deletes an object from a file.
    `boolean` | Attribute.`equals(HObject obj)` Returns whether this Attribute is equal to the specified HObject by comparing various properties.
    `boolean` | HObject.`equals(HObject obj)` Returns whether this HObject is equal to the specified HObject by comparing their OIDs.
    `void` | Group.`removeFromMemberList(HObject object)` Removes an object from the member list of this group in memory.
    `void` | FileFormat.`renameAttribute(HObject obj, String oldAttrName, String newAttrName)` Renames an attribute.
    `void` | Attribute.`setParentObject(HObject pObj)` Sets the HObject to which this Attribute is "attached".
    `abstract void` | FileFormat.`writeAttribute(HObject obj, Attribute attr, boolean attrExisted)` Attaches a given attribute to an object.

    Constructors in hdf.object with parameters of type HObject
    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.

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

    Subclasses of HObject 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.
    `class` | `H4GRImage` H4GRImage describes an HDF4 general raster(GR) image and operations performed on the GR image.
    `class` | `H4Group` An H4Group is a vgroup in HDF4, inheriting from Group.
    `class` | `H4SDS` H4SDS describes HDF4 Scientific Data Sets (SDS) and operations performed on the SDS.
    `class` | `H4Vdata` H4Vdata describes a multi-dimension array of HDF4 vdata, inheriting CompoundDS.

    Methods in hdf.object.h4 that return HObject
    Modifier and Type | Method and Description
    --- | ---
    `HObject` | H4File.`copy(HObject srcObj, Group dstGroup, String dstName)` Copy an object to a group.
    `HObject` | H4File.`get(String path)` Get an individual HObject with a given path.
    `HObject` | H4File.`getRootObject()`

    Methods in hdf.object.h4 with parameters of type HObject
    Modifier and Type | Method and Description
    --- | ---
    `HObject` | H4File.`copy(HObject srcObj, Group dstGroup, String dstName)` Copy an object to a group.
    `void` | H4File.`delete(HObject obj)` Delete an object from the file.
    `void` | H4File.`writeAttribute(HObject obj, Attribute attr, boolean isSDglobalAttr)` Creates a new attribute and attaches it to the object if the attribute does not exist.

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

    Subclasses of HObject in hdf.object.h5
    Modifier and Type | Class and Description
    --- | ---
    `class` | `H5CompoundDS` The H5CompoundDS class defines an HDF5 dataset of compound datatypes.
    `class` | `H5Datatype` This class defines HDF5 datatype characteristics and APIs for a data type.
    `class` | `H5Group` An H5Group object represents an existing HDF5 group in file.
    `class` | `H5Link` An H5Link object represents an existing HDF5 object in file.
    `class` | `H5ScalarDS` H5ScalarDS describes a multi-dimension array of HDF5 scalar or atomic data types, such as byte, int, short, long, float, double and string, and operations performed on the scalar dataset.

    Methods in hdf.object.h5 that return HObject
    Modifier and Type | Method and Description
    --- | ---
    `HObject` | H5File.`copy(HObject srcObj, Group dstGroup, String dstName)`
    `HObject` | H5File.`createLink(Group parentGroup, String name, HObject currentObj, int lType)` Creates a link to an object in the open file.
    `HObject` | H5File.`createLink(Group parentGroup, String name, Object currentObj)`
    `HObject` | H5File.`createLink(Group parentGroup, String name, String currentObj, int lType)` Creates a soft or external link to object in a file that does not exist at the time the link is created.
    `HObject` | H5File.`get(String path)`
    `HObject` | H5File.`getRootObject()` Returns the root object of the open HDF5 File.

    Methods in hdf.object.h5 with parameters of type HObject
    Modifier and Type | Method and Description
    --- | ---
    `HObject` | H5File.`copy(HObject srcObj, Group dstGroup, String dstName)`
    `static void` | H5File.`copyAttributes(HObject src, HObject dst)` Copies the attributes of one object to another object.
    `HObject` | H5File.`createLink(Group parentGroup, String name, HObject currentObj, int lType)` Creates a link to an object in the open file.
    `void` | H5File.`delete(HObject obj)`
    `static List<Attribute>` | H5File.`getAttribute(HObject obj)` Returns a list of attributes for the specified object.
    `static List<Attribute>` | H5File.`getAttribute(HObject obj, int idx_type, int order)` Returns a list of attributes for the specified object, in creation or alphabetical order.
    `static String` | H5File.`getLinkTargetName(HObject obj)` Retrieves the name of the target object that is being linked to.
    `void` | H5File.`renameAttribute(HObject obj, String oldAttrName, String newAttrName)` Renames an attribute.
    `static void` | H5File.`renameObject(HObject obj, String newName)` Rename the given object
    `void` | H5File.`writeAttribute(HObject obj, Attribute attr, boolean attrExisted)`

  - ### Uses of HObject in hdf.view

    Methods in hdf.view that return HObject
    Modifier and Type | Method and Description
    --- | ---
    `HObject` | DataView.`getDataObject()`

    Methods in hdf.view with parameters of type HObject
    Modifier and Type | Method and Description
    --- | ---
    `DataView` | HDFView.`getDataView(HObject dataObject)`
    `DataView` | ViewManager.`getDataView(HObject dataObject)` Returns DataView that contains the specified data object.
    `abstract hdf.view.MetaDataView.MetaDataView` | DataViewFactory.`getMetaDataView(org.eclipse.swt.widgets.Composite parentObj, ViewManager viewer, HObject theObj)`
    `void` | HDFView.`showMetaData(HObject obj)`

Copyright © 2018. All Rights Reserved.