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 | #ifndef H5_NO_NAMESPACE |
---|
21 | namespace H5 { |
---|
22 | #endif |
---|
23 | |
---|
24 | class H5_DLLCPP Group : public H5Object, public CommonFG { |
---|
25 | public: |
---|
26 | // Close this group. |
---|
27 | virtual void close(); |
---|
28 | |
---|
29 | #ifndef H5_NO_DEPRECATED_SYMBOLS |
---|
30 | // Retrieves the type of object that an object reference points to. |
---|
31 | H5G_obj_t getObjType(void *ref, H5R_type_t ref_type = H5R_OBJECT) const; |
---|
32 | #endif /* H5_NO_DEPRECATED_SYMBOLS */ |
---|
33 | |
---|
34 | // Retrieves a dataspace with the region pointed to selected. |
---|
35 | DataSpace getRegion(void *ref, H5R_type_t ref_type = H5R_DATASET_REGION) const; |
---|
36 | |
---|
37 | // Returns this class name |
---|
38 | virtual H5std_string fromClass () const { return("Group"); } |
---|
39 | |
---|
40 | // Throw group exception. |
---|
41 | virtual void throwException(const H5std_string& func_name, const H5std_string& msg) const; |
---|
42 | |
---|
43 | // for CommonFG to get the file id. |
---|
44 | virtual hid_t getLocId() const; |
---|
45 | |
---|
46 | // Creates a group by way of dereference. |
---|
47 | Group(H5Object& obj, void* ref); |
---|
48 | Group(H5File& obj, void* ref); |
---|
49 | |
---|
50 | // default constructor |
---|
51 | Group(); |
---|
52 | |
---|
53 | // Copy constructor: makes a copy of the original object |
---|
54 | Group(const Group& original); |
---|
55 | |
---|
56 | // Gets the group id. |
---|
57 | virtual hid_t getId() const; |
---|
58 | virtual void setId(const hid_t new_id); |
---|
59 | |
---|
60 | // Destructor |
---|
61 | virtual ~Group(); |
---|
62 | |
---|
63 | // Creates a copy of an existing group using its id. |
---|
64 | Group( const hid_t group_id ); |
---|
65 | |
---|
66 | private: |
---|
67 | hid_t id; // HDF5 group id |
---|
68 | }; |
---|
69 | #ifndef H5_NO_NAMESPACE |
---|
70 | } |
---|
71 | #endif |
---|
72 | #endif |
---|