My Project 1.10.7
H5DataSet.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 COPYING file, which can be found at the root of the source code *
10 * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
11 * If you do not have access to either file, you may request a copy from *
12 * help@hdfgroup.org. *
13 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
14
15#ifndef __H5DataSet_H
16#define __H5DataSet_H
17
18namespace H5 {
19
27// Inheritance: multiple H5Object/AbstractDs -> H5Location -> IdComponent
28class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
29 public:
30
31 // Close this dataset.
32 virtual void close();
33
34 // Extends the dataset with unlimited dimension.
35 void extend(const hsize_t* size) const;
36
37 // Fills a selection in memory with a value
38 void fillMemBuf(const void *fill, const DataType& fill_type, void *buf, const DataType& buf_type, const DataSpace& space) const;
39 //void fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace& 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, const DSetMemXferPropList& xfer_plist, void* buf);
72 static void vlenReclaim(void *buf, const DataType& type, const DataSpace& space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT);
73
74 // Reads the data of this dataset and stores it in the provided buffer.
75 // The memory and file dataspaces and the transferring property list
76 // can be defaults.
77 void read(void* buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT) const;
78 void read(H5std_string& buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT) const;
79
80 // Writes the buffered data to this dataset.
81 // The memory and file dataspaces and the transferring property list
82 // can be defaults.
83 void write(const void* buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT) const;
84 void write(const H5std_string& buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT) const;
85
86 // Iterates the selected elements in the specified dataspace - not implemented in C++ style yet
87 int iterateElems(void* buf, const DataType& type, const DataSpace& space, H5D_operator_t op, void* op_data = NULL);
88
90 virtual H5std_string fromClass () const { return("DataSet"); }
91
92 // Creates a dataset by way of dereference.
93 DataSet(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
94 DataSet(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
95
96 // Default constructor.
97 DataSet();
98
99 // Copy constructor - same as the original DataSet.
100 DataSet(const DataSet& original);
101
102 // Creates a copy of an existing DataSet using its id.
103 DataSet(const hid_t existing_id);
104
105 // Gets the dataset id.
106 virtual hid_t getId() const;
107
108 // Destructor: properly terminates access to this dataset.
109 virtual ~DataSet();
110
111 protected:
112#ifndef DOXYGEN_SHOULD_SKIP_THIS
113 // Sets the dataset id.
114 virtual void p_setId(const hid_t new_id);
115#endif // DOXYGEN_SHOULD_SKIP_THIS
116
117 private:
118 hid_t id; // HDF5 dataset id
119
120 // This function contains the common code that is used by
121 // getTypeClass and various API functions getXxxType
122 // defined in AbstractDs for generic datatype and specific
123 // sub-types
124 virtual hid_t p_get_type() const;
125
126 // Reads variable or fixed len strings from this dataset.
127 void p_read_fixed_len(const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id, const hid_t xfer_plist_id, H5std_string& strg) const;
128 void p_read_variable_len(const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id, const hid_t xfer_plist_id, H5std_string& strg) const;
129
130 // Friend function to set DataSet id. For library use only.
131 friend void f_DataSet_setId(DataSet* dset, hid_t new_id);
132
133}; // end of DataSet
134} // namespace H5
135
136#endif // __H5DataSet_H
AbstractDs is an abstract base class, inherited by Attribute and DataSet.
Definition: H5AbstractDs.h:36
Class Attribute operates on HDF5 attributes.
Definition: H5Attribute.h:29
Class DSetAccPropList inherits from LinkAccPropList and provides wrappers for the HDF5 dataset access...
Definition: H5DaccProp.h:25
Class DSetCreatPropList inherits from ObjCreatPropList and provides wrappers for the HDF5 dataset cre...
Definition: H5DcreatProp.h:29
Class DSetCreatPropList inherits from PropList and provides wrappers for the HDF5 dataset memory and ...
Definition: H5DxferProp.h:25
static const DSetMemXferPropList & DEFAULT
Default dataset memory and transfer property list.
Definition: H5DxferProp.h:28
Class DataSet operates on HDF5 datasets.
Definition: H5DataSet.h:28
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5DataSet.h:90
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:25
static const DataSpace & ALL
Default DataSpace objects.
Definition: H5DataSpace.h:28
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:31
Class H5Object is a bridge between H5Location and DataSet, DataType, and Group.
Definition: H5Object.h:69
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.
Definition: H5PropList.h:25
static const PropList & DEFAULT
Default property list.
Definition: H5PropList.h:28
Definition: H5AbstractDs.cpp:34


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