## Uses of Class
hdf.object.Group

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

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

    Fields in hdf.object declared as Group
    Modifier and Type | Field and Description
    --- | ---
    `protected Group` | Group.`parent` The parent group where this group is located.

    Methods in hdf.object that return Group
    Modifier and Type | Method and Description
    --- | ---
    `abstract Group` | FileFormat.`createGroup(String name, Group parentGroup)` Creates a new group with specified name in existing group.
    `Group` | FileFormat.`createGroup(String name, Group pgroup, long... gplist)` Creates a new group with specified name in existing group.
    `Group` | Group.`getParent()`

    Methods in hdf.object with parameters of type Group
    Modifier and Type | Method and Description
    --- | ---
    `Dataset` | Attribute.`copy(Group pgroup, String name, long[] dims, Object data)`
    `Dataset` | CompoundDS.`copy(Group pgroup, String name, long[] dims, Object data)` Deprecated. Not implemented for compound dataset.
    `abstract Dataset` | Dataset.`copy(Group pgroup, String name, long[] dims, Object data)` Creates a new dataset and writes the data buffer to the new dataset.
    `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.
    `Dataset` | FileFormat.`createCompoundDS(String name, Group pgroup, long[] dims, long[] maxdims, long[] chunks, int gzip, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)` Creates a new compound dataset in a file with/without chunking and compression.
    `Dataset` | FileFormat.`createCompoundDS(String name, Group pgroup, long[] dims, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)` Deprecated. As of 2.4, replaced by `FileFormat.createCompoundDS(String, Group, long[], long[], long[], int, String[], Datatype[], int[], Object)` The replacement method has additional parameters: `maxdims, chunks,` and `gzip`. To mimic the behavior originally provided by this method, call the replacement method with the following parameter list: `( name, pgroup, dims, null, null, -1, memberNames, memberDatatypes, memberSizes, data );`
    `abstract Group` | FileFormat.`createGroup(String name, Group parentGroup)` Creates a new group with specified name in existing group.
    `Group` | FileFormat.`createGroup(String name, Group pgroup, long... gplist)` Creates a new group with specified name in existing group.
    `abstract Dataset` | FileFormat.`createImage(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)` Creates a new image in a file.
    `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.
    `Dataset` | FileFormat.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object data)`
    `abstract Dataset` | FileFormat.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)` Creates a new dataset in a file with/without chunking/compression.

    Constructors in hdf.object with parameters of type Group
    Constructor and Description
    `Group(FileFormat theFile, String grpName, String grpPath, Group grpParent)` Constructs an instance of the group with specific name, path and parent group.
    `Group(FileFormat theFile, String grpName, String grpPath, Group grpParent, long[] oid)` Deprecated. Not for public use in the future. Using `Group(FileFormat, String, String, Group)`

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

    Subclasses of Group in hdf.object.h4
    Modifier and Type | Class and Description
    --- | ---
    `class` | `H4Group` An H4Group is a vgroup in HDF4, inheriting from Group.

    Methods in hdf.object.h4 that return Group
    Modifier and Type | Method and Description
    --- | ---
    `Group` | H4File.`createGroup(String name, Group pgroup)`

    Methods in hdf.object.h4 with parameters of type Group
    Modifier and Type | Method and Description
    --- | ---
    `Dataset` | H4GRImage.`copy(Group pgroup, String dname, long[] dims, Object buff)`
    `Dataset` | H4SDS.`copy(Group pgroup, String dname, long[] dims, Object buff)`
    `Dataset` | H4Vdata.`copy(Group pgroup, String name, long[] dims, Object data)`
    `HObject` | H4File.`copy(HObject srcObj, Group dstGroup, String dstName)` Copy an object to a group.
    `static H4Group` | H4Group.`create(String name, Group pgroup)` Creates a new group.
    `static H4GRImage` | H4GRImage.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)` Creates a new image.
    `static H4SDS` | H4SDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object data)`
    `static H4SDS` | H4SDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)` Creates a new dataset.
    `Group` | H4File.`createGroup(String name, Group pgroup)`
    `Dataset` | H4File.`createImage(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)`
    `Dataset` | H4File.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)`

    Constructors in hdf.object.h4 with parameters of type Group
    Constructor and Description
    `H4Group(FileFormat theFile, String name, String path, Group parent)`
    `H4Group(FileFormat theFile, String name, String path, Group parent, long[] oid)` Creates a group object with specific name, path, and parent.

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

    Subclasses of Group in hdf.object.h5
    Modifier and Type | Class and Description
    --- | ---
    `class` | `H5Group` An H5Group object represents an existing HDF5 group in file.

    Methods in hdf.object.h5 that return Group
    Modifier and Type | Method and Description
    --- | ---
    `Group` | H5File.`createGroup(String name, Group pgroup)` Creates a new group with specified name in existing group.
    `Group` | H5File.`createGroup(String name, Group pgroup, long... gplist)` Creates a new group with specified name in existing group and with the group creation properties list, gplist.

    Methods in hdf.object.h5 with parameters of type Group
    Modifier and Type | Method and Description
    --- | ---
    `Dataset` | H5ScalarDS.`copy(Group pgroup, String dstName, long[] dims, Object buff)`
    `HObject` | H5File.`copy(HObject srcObj, Group dstGroup, String dstName)`
    `static Dataset` | H5ScalarDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object data)`
    `static Dataset` | H5ScalarDS.`create(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)` Creates a scalar dataset in a file with/without chunking and compression.
    `static H5Group` | H5Group.`create(String name, Group pgroup, long... gplist)` Creates a new group with a name in a group and with the group creation properties specified in gplist.
    `static Dataset` | H5CompoundDS.`create(String name, Group pgroup, long[] dims, long[] maxdims, long[] chunks, int gzip, String[] memberNames, Datatype[] memberDatatypes, int[] memberRanks, long[][] memberDims, Object data)` Creates a simple compound dataset in a file with/without chunking and compression.
    `static Dataset` | H5CompoundDS.`create(String name, Group pgroup, long[] dims, String[] memberNames, Datatype[] memberDatatypes, int[] memberRanks, long[][] memberDims, Object data)` Deprecated. Not for public use in the future. Using `H5CompoundDS.create(String, Group, long[], long[], long[], int, String[], Datatype[], int[], long[][], Object)`
    `static Dataset` | H5CompoundDS.`create(String name, Group pgroup, long[] dims, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)` Deprecated. Not for public use in the future. Using `H5CompoundDS.create(String, Group, long[], long[], long[], int, String[], Datatype[], int[], long[][], Object)`
    `Dataset` | H5File.`createCompoundDS(String name, Group pgroup, long[] dims, long[] maxdims, long[] chunks, int gzip, String[] memberNames, Datatype[] memberDatatypes, int[] memberSizes, Object data)`
    `Group` | H5File.`createGroup(String name, Group pgroup)` Creates a new group with specified name in existing group.
    `Group` | H5File.`createGroup(String name, Group pgroup, long... gplist)` Creates a new group with specified name in existing group and with the group creation properties list, gplist.
    `Dataset` | H5File.`createImage(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, int ncomp, int interlace, Object data)`
    `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.
    `Dataset` | H5File.`createScalarDS(String name, Group pgroup, Datatype type, long[] dims, long[] maxdims, long[] chunks, int gzip, Object fillValue, Object data)`
    `void` | H5File.`reloadTree(Group g)` reload the sub-tree structure from file.

    Constructors in hdf.object.h5 with parameters of type Group
    Constructor and Description
    `H5Group(FileFormat theFile, String name, String path, Group parent)` Constructs an HDF5 group with specific name, path, and parent.
    `H5Group(FileFormat theFile, String name, String path, Group parent, long[] oid)` Deprecated. Not for public use in the future. Using `H5Group.H5Group(FileFormat, String, String, Group)`

Copyright © 2018. All Rights Reserved.