HDF5 C++ API  1.8.18
 All Classes Namespaces Functions Variables Typedefs Friends Pages
H5Group.h
1 // C++ informative line for the emacs editor: -*- C++ -*-
2 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
3  * Copyright by The HDF Group. *
4  * Copyright by the Board of Trustees of the University of Illinois. *
5  * All rights reserved. *
6  * *
7  * This file is part of HDF5. The full HDF5 copyright notice, including *
8  * terms governing use, modification, and redistribution, is contained in *
9  * the files COPYING and Copyright.html. COPYING can be found at the root *
10  * of the source code distribution tree; Copyright.html can be found at the *
11  * root level of an installed copy of the electronic HDF5 document set and *
12  * is linked from the top-level documents page. It can also be found at *
13  * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
14  * access to either file, you may request a copy from help@hdfgroup.org. *
15  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
16 
17 #ifndef __H5Group_H
18 #define __H5Group_H
19 
20 namespace H5 {
21 
27 class H5_DLLCPP Group : public H5Object, public CommonFG {
28  public:
29  // Close this group.
30  virtual void close();
31 
33  virtual H5std_string fromClass () const { return("Group"); }
34 
35  // Throw group exception.
36  virtual void throwException(const H5std_string& func_name, const H5std_string& msg) const;
37 
38  // for CommonFG to get the file id.
39  virtual hid_t getLocId() const;
40 
41  // Creates a group by way of dereference.
42  Group(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
43  Group(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
44 
45  // default constructor
46  Group();
47 
48  // Copy constructor: makes a copy of the original object
49  Group(const Group& original);
50 
51  // Gets the group id.
52  virtual hid_t getId() const;
53 
54  // Destructor
55  virtual ~Group();
56 
57  // Creates a copy of an existing group using its id.
58  Group( const hid_t group_id );
59 
60  protected:
61 #ifndef DOXYGEN_SHOULD_SKIP_THIS
62  // Sets the group id.
63  virtual void p_setId(const hid_t new_id);
64 #endif // DOXYGEN_SHOULD_SKIP_THIS
65 
66  private:
67  hid_t id; // HDF5 group id
68 
69 };
70 }
71 #endif // __H5Group_H
Class Group represents an HDF5 group.
Definition: H5Group.h:27
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5Group.h:33
Class Attribute operates on HDF5 attributes.
Definition: H5Attribute.h:30
Class H5Object is a bridge between H5Location and DataSet, DataType, and Group.
Definition: H5Object.h:45
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:47
CommonFG is an abstract base class of H5File and H5Group.
Definition: H5CommonFG.h:33


The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois