My Project 1.10.10
Loading...
Searching...
No Matches
H5DataSet.h
1// C++ informative line for the emacs editor: -*- C++ -*-
2/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
3 * Copyright by The HDF Group. *
4 * All rights reserved. *
5 * *
6 * This file is part of HDF5. The full HDF5 copyright notice, including *
7 * terms governing use, modification, and redistribution, is contained in *
8 * the COPYING file, which can be found at the root of the source code *
9 * distribution tree, or in https://www.hdfgroup.org/licenses. *
10 * If you do not have access to either file, you may request a copy from *
11 * help@hdfgroup.org. *
12 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
13
14#ifndef H5DataSet_H
15#define H5DataSet_H
16
17namespace H5 {
18
26// Inheritance: multiple H5Object/AbstractDs -> H5Location -> IdComponent
27class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
28 public:
29 // Close this dataset.
30 virtual void close();
31
32 // Extends the dataset with unlimited dimension.
33 void extend(const hsize_t *size) const;
34
35 // Fills a selection in memory with a value
36 void fillMemBuf(const void *fill, const DataType &fill_type, void *buf, const DataType &buf_type,
37 const DataSpace &space) const;
38 // void fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace&
39 // space); // removed from 1.8.18 and 1.10.1
40
41 // Fills a selection in memory with zero
42 void fillMemBuf(void *buf, const DataType &buf_type, const DataSpace &space) const;
43 // void fillMemBuf(void *buf, DataType& buf_type, DataSpace& space); // removed from 1.8.18 and 1.10.1
44
45 // Gets the creation property list of this dataset.
46 DSetCreatPropList getCreatePlist() const;
47
48 // Gets the access property list of this dataset.
49 DSetAccPropList getAccessPlist() const;
50
51 // Returns the address of this dataset in the file.
52 haddr_t getOffset() const;
53
54 // Gets the dataspace of this dataset.
55 virtual DataSpace getSpace() const;
56
57 // Determines whether space has been allocated for a dataset.
58 void getSpaceStatus(H5D_space_status_t &status) const;
59
60 // Returns the amount of storage size required for this dataset.
61 virtual hsize_t getStorageSize() const;
62
63 // Returns the in memory size of this attribute's data.
64 virtual size_t getInMemDataSize() const;
65
66 // Returns the number of bytes required to store VL data.
67 hsize_t getVlenBufSize(const DataType &type, const DataSpace &space) const;
68 // hsize_t getVlenBufSize(DataType& type, DataSpace& space) const; // removed from 1.8.18 and 1.10.1
69
70 // Reclaims VL datatype memory buffers.
71 static void vlenReclaim(const DataType &type, const DataSpace &space,
72 const DSetMemXferPropList &xfer_plist, void *buf);
73 static void vlenReclaim(void *buf, const DataType &type, const DataSpace &space = DataSpace::ALL,
74 const DSetMemXferPropList &xfer_plist = DSetMemXferPropList::DEFAULT);
75
76 // Reads the data of this dataset and stores it in the provided buffer.
77 // The memory and file dataspaces and the transferring property list
78 // can be defaults.
79 void read(void *buf, const DataType &mem_type, const DataSpace &mem_space = DataSpace::ALL,
80 const DataSpace &file_space = DataSpace::ALL,
81 const DSetMemXferPropList &xfer_plist = DSetMemXferPropList::DEFAULT) const;
82 void read(H5std_string &buf, const DataType &mem_type, const DataSpace &mem_space = DataSpace::ALL,
83 const DataSpace &file_space = DataSpace::ALL,
84 const DSetMemXferPropList &xfer_plist = DSetMemXferPropList::DEFAULT) const;
85
86 // Writes the buffered data to this dataset.
87 // The memory and file dataspaces and the transferring property list
88 // can be defaults.
89 void write(const void *buf, const DataType &mem_type, const DataSpace &mem_space = DataSpace::ALL,
90 const DataSpace &file_space = DataSpace::ALL,
91 const DSetMemXferPropList &xfer_plist = DSetMemXferPropList::DEFAULT) const;
92 void write(const H5std_string &buf, const DataType &mem_type, const DataSpace &mem_space = DataSpace::ALL,
93 const DataSpace &file_space = DataSpace::ALL,
94 const DSetMemXferPropList &xfer_plist = DSetMemXferPropList::DEFAULT) const;
95
96 // Iterates the selected elements in the specified dataspace - not implemented in C++ style yet
97 int iterateElems(void *buf, const DataType &type, const DataSpace &space, H5D_operator_t op,
98 void *op_data = NULL);
99
101 virtual H5std_string
102 fromClass() const
103 {
104 return ("DataSet");
105 }
106
107 // Creates a dataset by way of dereference.
108 DataSet(const H5Location &loc, const void *ref, H5R_type_t ref_type = H5R_OBJECT,
109 const PropList &plist = PropList::DEFAULT);
110 DataSet(const Attribute &attr, const void *ref, H5R_type_t ref_type = H5R_OBJECT,
111 const PropList &plist = PropList::DEFAULT);
112
113 // Default constructor.
114 DataSet();
115
116 // Copy constructor - same as the original DataSet.
117 DataSet(const DataSet &original);
118
119 // Assignment operator
120 DataSet &operator=(const DataSet &original);
121
122 // Creates a copy of an existing DataSet using its id.
123 DataSet(const hid_t existing_id);
124
125 // Gets the dataset id.
126 virtual hid_t getId() const;
127
128 // Destructor: properly terminates access to this dataset.
129 virtual ~DataSet();
130
131 protected:
132#ifndef DOXYGEN_SHOULD_SKIP_THIS
133 // Sets the dataset id.
134 virtual void p_setId(const hid_t new_id);
135#endif // DOXYGEN_SHOULD_SKIP_THIS
136
137 private:
138 hid_t id; // HDF5 dataset id
139
140 // This function contains the common code that is used by
141 // getTypeClass and various API functions getXxxType
142 // defined in AbstractDs for generic datatype and specific
143 // sub-types
144 virtual hid_t p_get_type() const;
145
146 // Reads variable or fixed len strings from this dataset.
147 void p_read_fixed_len(const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id,
148 const hid_t xfer_plist_id, H5std_string &strg) const;
149 void p_read_variable_len(const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id,
150 const hid_t xfer_plist_id, H5std_string &strg) const;
151
152 // Friend function to set DataSet id. For library use only.
153 friend void f_DataSet_setId(DataSet *dset, hid_t new_id);
154
155}; // end of DataSet
156} // namespace H5
157
158#endif // H5DataSet_H
AbstractDs is an abstract base class, inherited by Attribute and DataSet.
Definition H5AbstractDs.h:35
Class Attribute operates on HDF5 attributes.
Definition H5Attribute.h:28
Class DSetAccPropList inherits from LinkAccPropList and provides wrappers for the HDF5 dataset access...
Definition H5DaccProp.h:24
Class DSetCreatPropList inherits from ObjCreatPropList and provides wrappers for the HDF5 dataset cre...
Definition H5DcreatProp.h:28
Class DSetCreatPropList inherits from PropList and provides wrappers for the HDF5 dataset memory and ...
Definition H5DxferProp.h:24
Class DataSet operates on HDF5 datasets.
Definition H5DataSet.h:27
virtual H5std_string fromClass() const
Returns this class name.
Definition H5DataSet.h:102
friend void f_DataSet_setId(DataSet *dset, hid_t new_id)
Class DataSpace inherits from IdComponent and provides wrappers for the HDF5's dataspaces.
Definition H5DataSpace.h:24
Class DataType provides generic operations on HDF5 datatypes.
Definition H5DataType.h:27
H5Location is an abstract base class, added in version 1.8.12.
Definition H5Location.h:30
Class H5Object is a bridge between H5Location and DataSet, DataType, and Group.
Definition H5Object.h:64
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.
Definition H5PropList.h:24
Definition H5AbstractDs.cpp:33


The HDF Group Help Desk:
  Copyright by The HDF Group