HDF5 C++ API  1.8.20
 All Classes Namespaces Functions Variables Typedefs Friends Pages
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 
18 namespace H5 {
19 
27 // Inheritance: multiple H5Object/AbstractDs -> H5Location -> IdComponent
28 class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
29  public:
30  // Close this dataset.
31  virtual void close();
32 
33  // Extends the dataset with unlimited dimension.
34  void extend(const hsize_t* size) const;
35 
36  // Fills a selection in memory with a value
37  void fillMemBuf(const void *fill, const DataType& fill_type, void *buf, const DataType& buf_type, const DataSpace& space) const;
38  //void fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace& space); // removed from 1.8.18 and 1.10.1
39 
40  // Fills a selection in memory with zero
41  void fillMemBuf(void *buf, const DataType& buf_type, const DataSpace& space) const;
42  //void fillMemBuf(void *buf, DataType& buf_type, DataSpace& space); // removed from 1.8.18 and 1.10.1
43 
44  // Gets the creation property list of this dataset.
45  DSetCreatPropList getCreatePlist() const;
46 
47  // Returns the address of this dataset in the file.
48  haddr_t getOffset() const;
49 
50  // Gets the dataspace of this dataset.
51  virtual DataSpace getSpace() const;
52 
53  // Determines whether space has been allocated for a dataset.
54  void getSpaceStatus(H5D_space_status_t& status) const;
55 
56  // Returns the amount of storage size required for this dataset.
57  virtual hsize_t getStorageSize() const;
58 
59  // Returns the in memory size of this attribute's data.
60  virtual size_t getInMemDataSize() const;
61 
62  // Returns the number of bytes required to store VL data.
63  hsize_t getVlenBufSize(const DataType& type, const DataSpace& space) const;
64  //hsize_t getVlenBufSize(DataType& type, DataSpace& space) const; // removed from 1.8.18 and 1.10.1
65 
66  // Reclaims VL datatype memory buffers.
67  static void vlenReclaim(const DataType& type, const DataSpace& space, const DSetMemXferPropList& xfer_plist, void* buf);
68  static void vlenReclaim(void *buf, const DataType& type, const DataSpace& space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT);
69 
70  // Reads the data of this dataset and stores it in the provided buffer.
71  // The memory and file dataspaces and the transferring property list
72  // can be defaults.
73  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;
74  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;
75 
76  // Writes the buffered data to this dataset.
77  // The memory and file dataspaces and the transferring property list
78  // can be defaults.
79  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;
80  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;
81 
82  // Iterates the selected elements in the specified dataspace - not implemented in C++ style yet
83  int iterateElems(void* buf, const DataType& type, const DataSpace& space, H5D_operator_t op, void* op_data = NULL);
84 
86  virtual H5std_string fromClass () const { return("DataSet"); }
87 
88  // Creates a dataset by way of dereference.
89  DataSet(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
90  DataSet(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
91 
92  // Default constructor.
93  DataSet();
94 
95  // Copy constructor.
96  DataSet(const DataSet& original);
97 
98  // Creates a copy of an existing DataSet using its id.
99  DataSet(const hid_t existing_id);
100 
101  // Gets the dataset id.
102  virtual hid_t getId() const;
103 
104  // Destructor: properly terminates access to this dataset.
105  virtual ~DataSet();
106 
107  protected:
108 #ifndef DOXYGEN_SHOULD_SKIP_THIS
109  // Sets the dataset id.
110  virtual void p_setId(const hid_t new_id);
111 #endif // DOXYGEN_SHOULD_SKIP_THIS
112 
113  private:
114  hid_t id; // HDF5 dataset id
115 
116  // This function contains the common code that is used by
117  // getTypeClass and various API functions getXxxType
118  // defined in AbstractDs for generic datatype and specific
119  // sub-types
120  virtual hid_t p_get_type() const;
121 
122  // Reads variable or fixed len strings from this dataset.
123  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;
124  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;
125 
126  // Friend function to set DataSet id. For library use only.
127  friend void f_DataSet_setId(DataSet* dset, hid_t new_id);
128 
129 }; // end of DataSet
130 } // namespace H5
131 
132 #endif // __H5DataSet_H
Class DataSpace inherits from IdComponent and provides wrappers for the HDF5's dataspaces.
Definition: H5DataSpace.h:25
Class Attribute operates on HDF5 attributes.
Definition: H5Attribute.h:29
Class DSetCreatPropList inherits from ObjCreatPropList and provides wrappers for the HDF5 dataset cre...
Definition: H5DcreatProp.h:28
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
Class H5Object is a bridge between H5Location and DataSet, DataType, and Group.
Definition: H5Object.h:37
H5Location is an abstract base class, providing a collection of wrappers of the C functions that take...
Definition: H5Location.h:42
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5DataSet.h:86
AbstractDs is an abstract base class, inherited by Attribute and DataSet.
Definition: H5AbstractDs.h:38
Class DataSet operates on HDF5 datasets.
Definition: H5DataSet.h:28
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
static const DataSpace & ALL
Default DataSpace objects.
Definition: H5DataSpace.h:28


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