# Uses of Class
hdf.object.HObject

Packages that use HObject
Package
Description
hdf.object
hdf.object.fits
hdf.object.h4
hdf.object.h5
hdf.object.nc2
hdf.view
hdf.view.DataView
hdf.view.dialog
hdf.view.ImageView
hdf.view.MetaDataView
hdf.view.PaletteView
hdf.view.TableView
hdf.view.TreeView

- ## Uses of HObject in hdf.object

  Subclasses of HObject in hdf.object
  Modifier and Type
  Class
  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
  Description
  `protected HObject`
  Attribute.`parentObject`
  The HObject to which this Attribute is attached
  Methods in hdf.object that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  FileFormat.`copy​(HObject srcObj, Group dstGroup)`
  Deprecated.
  As of 2.4, replaced by `FileFormat.copy(HObject, Group, String)`
  `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)`
  `static HObject`
  FileFormat.`getHObject​(String filename, String path)`
  Deprecated.
  As of 2.4, replaced by `FileFormat.get(String)`
  `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
  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
  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)`
  `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`
  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
  Modifier
  Constructor
  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.fits

  Subclasses of HObject in hdf.object.fits
  Modifier and Type
  Class
  Description
  `class`
  `FitsDataset`
  FitsDataset describes an 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
  `class`
  `FitsDatatype`
  Datatype encapsulates information of a datatype.
  `class`
  `FitsGroup`
  An H5Group represents HDF5 group, inheriting from Group.
  Methods in hdf.object.fits that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  FitsFile.`copy​(HObject srcObj, Group dstGroup, String dstName)`
  `HObject`
  FitsFile.`get​(String path)`
  `HObject`
  FitsFile.`getRootObject()`
  Methods in hdf.object.fits with parameters of type HObject
  Modifier and Type
  Method
  Description
  `HObject`
  FitsFile.`copy​(HObject srcObj, Group dstGroup, String dstName)`
  `void`
  FitsFile.`copyAttributes​(HObject src, HObject dst)`
  `void`
  FitsFile.`delete​(HObject obj)`
  `void`
  FitsFile.`writeAttribute​(HObject obj, Attribute attr, boolean attrExisted)`
  Creates a new attribute and attached to the object if attribute does not exist.

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

  Subclasses of HObject in hdf.object.h4
  Modifier and Type
  Class
  Description
  `class`
  `H4Attribute`
  An attribute is a (name, value) pair of metadata attached to a primary data object such as a dataset, group or named datatype.
  `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
  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
  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.
  Constructors in hdf.object.h4 with parameters of type HObject
  Modifier
  Constructor
  Description
  ``
  `H4Attribute​(HObject parentObj, String attrName, Datatype attrType, long[] attrDims)`
  Create an attribute with specified name, data type and dimension sizes.
  ``
  `H4Attribute​(HObject parentObj, String attrName, Datatype attrType, long[] attrDims, Object attrValue)`
  Create an attribute with specific name and value.

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

  Subclasses of HObject in hdf.object.h5
  Modifier and Type
  Class
  Description
  `class`
  `H5Attribute`
  An attribute is a (name, value) pair of metadata attached to a primary data object such as a dataset, group or named datatype.
  `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
  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
  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
  `static void`
  H5File.`renameObject​(HObject obj, String newPath, String newName)`
  Rename the given object
  `void`
  H5File.`writeAttribute​(HObject obj, Attribute attr, boolean attrExisted)`
  Constructors in hdf.object.h5 with parameters of type HObject
  Modifier
  Constructor
  Description
  ``
  `H5Attribute​(HObject parentObj, String attrName, Datatype attrType, long[] attrDims)`
  Create an attribute with specified name, data type and dimension sizes.
  ``
  `H5Attribute​(HObject parentObj, String attrName, Datatype attrType, long[] attrDims, Object attrValue)`
  Create an attribute with specific name and value.

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

  Subclasses of HObject in hdf.object.nc2
  Modifier and Type
  Class
  Description
  `class`
  `NC2Attribute`
  An attribute is a (name, value) pair of metadata attached to a primary data object such as a dataset, group or named datatype.
  `class`
  `NC2Dataset`
  NC2Dataset describes an 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
  `class`
  `NC2Datatype`
  Datatype encapsulates information of a datatype.
  `class`
  `NC2Group`
  An NC2Group represents NetCDF3 group, inheriting from Group.
  Methods in hdf.object.nc2 that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  NC2File.`copy​(HObject srcObj, Group dstGroup, String dstName)`
  `HObject`
  NC2File.`get​(String path)`
  `HObject`
  NC2File.`getRootObject()`
  Methods in hdf.object.nc2 with parameters of type HObject
  Modifier and Type
  Method
  Description
  `static Attribute`
  NC2File.`convertAttribute​(HObject parent, ucar.nc2.Attribute netcdfAttr)`
  `HObject`
  NC2File.`copy​(HObject srcObj, Group dstGroup, String dstName)`
  `void`
  NC2File.`copyAttributes​(HObject src, HObject dst)`
  `void`
  NC2File.`delete​(HObject obj)`
  `void`
  NC2File.`writeAttribute​(HObject obj, Attribute attr, boolean attrExisted)`
  Constructors in hdf.object.nc2 with parameters of type HObject
  Modifier
  Constructor
  Description
  ``
  `NC2Attribute​(HObject parentObj, String attrName, Datatype attrType, long[] attrDims)`
  Create an attribute with specified name, data type and dimension sizes.
  ``
  `NC2Attribute​(HObject parentObj, String attrName, Datatype attrType, long[] attrDims, Object attrValue)`
  Create an attribute with specific name and value.

- ## Uses of HObject in hdf.view

  Methods in hdf.view with parameters of type HObject
  Modifier and Type
  Method
  Description
  `DataView`
  HDFView.`getDataView​(HObject dataObject)`
  `void`
  HDFView.`showMetaData​(HObject obj)`

- ## Uses of HObject in hdf.view.DataView

  Methods in hdf.view.DataView that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  DataView.`getDataObject()`
  Methods in hdf.view.DataView with parameters of type HObject
  Modifier and Type
  Method
  Description
  `DataView`
  DataViewManager.`getDataView​(HObject dataObject)`
  Returns DataView that contains the specified data object.
  `abstract MetaDataView`
  DataViewFactory.`getMetaDataView​(org.eclipse.swt.widgets.Composite parentObj, DataViewManager viewer, HObject theObj)`

- ## Uses of HObject in hdf.view.dialog

  Fields in hdf.view.dialog declared as HObject
  Modifier and Type
  Field
  Description
  `protected HObject`
  NewDataObjectDialog.`newObject`
  the object created
  `protected HObject`
  NewDataObjectDialog.`parentObj`
  the object which the this object is attached
  `protected HObject`
  NewDataObjectDialog.`refObject`
  the object referenced
  Methods in hdf.view.dialog that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  NewDataObjectDialog.`getObject()`
  `HObject`
  NewLinkDialog.`getObject()`
  Constructors in hdf.view.dialog with parameters of type HObject
  Modifier
  Constructor
  Description
  ``
  `NewAttributeDialog​(org.eclipse.swt.widgets.Shell parent, HObject obj, List<HObject> objs)`
  Constructs a NewAttributeDialog with specified object (dataset, group, or image) for the new attribute to be attached to.
  ``
  `NewDataObjectDialog​(org.eclipse.swt.widgets.Shell parent, HObject pGroup, List<?> objs)`
  Constructor parameters in hdf.view.dialog with type arguments of type HObject
  Modifier
  Constructor
  Description
  ``
  `NewAttributeDialog​(org.eclipse.swt.widgets.Shell parent, HObject obj, List<HObject> objs)`
  Constructs a NewAttributeDialog with specified object (dataset, group, or image) for the new attribute to be attached to.

- ## Uses of HObject in hdf.view.ImageView

  Methods in hdf.view.ImageView that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  DefaultImageView.`getDataObject()`
  Methods in hdf.view.ImageView with parameters of type HObject
  Modifier and Type
  Method
  Description
  `MetaDataView`
  ImageViewFactory.`getMetaDataView​(org.eclipse.swt.widgets.Composite parentObj, DataViewManager viewer, HObject theObj)`

- ## Uses of HObject in hdf.view.MetaDataView

  Fields in hdf.view.MetaDataView declared as HObject
  Modifier and Type
  Field
  Description
  `protected HObject`
  DefaultBaseMetaDataView.`dataObject`
  The HDF data object
  Methods in hdf.view.MetaDataView that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  DefaultBaseMetaDataView.`getDataObject()`
  Methods in hdf.view.MetaDataView with parameters of type HObject
  Modifier and Type
  Method
  Description
  `Attribute`
  DefaultBaseMetaDataView.`addAttribute​(HObject obj)`
  `Attribute`
  MetaDataView.`addAttribute​(HObject obj)`
  Add an attribute to a data object.
  `Attribute`
  DefaultBaseMetaDataView.`deleteAttribute​(HObject obj)`
  `Attribute`
  MetaDataView.`deleteAttribute​(HObject obj)`
  Delete an attribute from a data object.
  `MetaDataView`
  DefaultMetaDataViewFactory.`getMetaDataView​(org.eclipse.swt.widgets.Composite parentObj, DataViewManager viewer, HObject theObj)`
  Constructors in hdf.view.MetaDataView with parameters of type HObject
  Modifier
  Constructor
  Description
  ``
  `DefaultBaseMetaDataView​(org.eclipse.swt.widgets.Composite parentComposite, DataViewManager viewer, HObject theObj)`
  ``
  `DefaultDatasetMetaDataView​(org.eclipse.swt.widgets.Composite parentComposite, DataViewManager viewer, HObject theObj)`
  ``
  `DefaultDatatypeMetaDataView​(org.eclipse.swt.widgets.Composite parentComposite, DataViewManager viewer, HObject theObj)`
  ``
  `DefaultGroupMetaDataView​(org.eclipse.swt.widgets.Composite parentComposite, DataViewManager viewer, HObject theObj)`
  ``
  `DefaultLinkMetaDataView​(org.eclipse.swt.widgets.Composite parentComposite, DataViewManager viewer, HObject theObj)`

- ## Uses of HObject in hdf.view.PaletteView

  Methods in hdf.view.PaletteView that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  DefaultPaletteView.`getDataObject()`
  Methods in hdf.view.PaletteView with parameters of type HObject
  Modifier and Type
  Method
  Description
  `MetaDataView`
  PaletteViewFactory.`getMetaDataView​(org.eclipse.swt.widgets.Composite parentObj, DataViewManager viewer, HObject theObj)`

- ## Uses of HObject in hdf.view.TableView

  Methods in hdf.view.TableView that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  DefaultBaseTableView.`getDataObject()`
  Methods in hdf.view.TableView with parameters of type HObject
  Modifier and Type
  Method
  Description
  `MetaDataView`
  TableViewFactory.`getMetaDataView​(org.eclipse.swt.widgets.Composite parentObj, DataViewManager viewer, HObject theObj)`

- ## Uses of HObject in hdf.view.TreeView

  Methods in hdf.view.TreeView that return HObject
  Modifier and Type
  Method
  Description
  `HObject`
  DefaultTreeView.`getCurrentObject()`
  `HObject`
  TreeView.`getCurrentObject()`
  Methods in hdf.view.TreeView with parameters of type HObject
  Modifier and Type
  Method
  Description
  `org.eclipse.swt.widgets.TreeItem`
  DefaultTreeView.`addObject​(HObject obj, Group parentGroup)`
  Adds an already created HObject to the tree under the TreeItem containing the specified parent group.
  `org.eclipse.swt.widgets.TreeItem`
  TreeView.`addObject​(HObject newObject, Group parentGroup)`
  Adds an already created HObject to the tree under the TreeItem containing the specified parent group.
  `org.eclipse.swt.widgets.TreeItem`
  DefaultTreeView.`findTreeItem​(HObject obj)`
  Returns the tree item that contains the given data object.
  `org.eclipse.swt.widgets.TreeItem`
  TreeView.`findTreeItem​(HObject obj)`
  `MetaDataView`
  TreeViewFactory.`getMetaDataView​(org.eclipse.swt.widgets.Composite parentObj, DataViewManager viewer, HObject theObj)`
  `DataView`
  DefaultTreeView.`showDataContent​(HObject dataObject)`
  Display the content of a data object.
  `DataView`
  TreeView.`showDataContent​(HObject dataObject)`
  Display the content of a data object.
  `MetaDataView`
  DefaultTreeView.`showMetaData​(HObject dataObject)`
  Displays the meta data of a data object.
  `MetaDataView`
  TreeView.`showMetaData​(HObject dataObject)`
  Displays the meta data of a data object.
  `void`
  DefaultTreeView.`updateItemIcon​(HObject obj)`
  Updates the icon for the TreeItem representing the given HObject.