From 26f6b4208e36584dbdf5d75eb8ffb59746dfb04f Mon Sep 17 00:00:00 2001 From: oruebel Date: Thu, 8 Aug 2024 22:37:01 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh=5Fpages=20from=20@=20Neurod?= =?UTF-8?q?ataWithoutBorders/aqnwb@42d3320b3a60f4067a5335318b4c66b8c64d425?= =?UTF-8?q?4=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _h_d_f5_i_o_8hpp_source.html | 210 +++++++++--------- ...s_a_q_n_w_b_1_1_h_d_f5_1_1_h_d_f5_i_o.html | 1 + 2 files changed, 106 insertions(+), 105 deletions(-) diff --git a/_h_d_f5_i_o_8hpp_source.html b/_h_d_f5_i_o_8hpp_source.html index eb1bb7e1..25ad0e71 100644 --- a/_h_d_f5_i_o_8hpp_source.html +++ b/_h_d_f5_i_o_8hpp_source.html @@ -135,115 +135,115 @@
30public:
34 HDF5IO();
35
-
40 HDF5IO(const std::string& fileName, const bool disableSWMRMode = false);
-
41
-
45 ~HDF5IO();
+
45 HDF5IO(const std::string& fileName, const bool disableSWMRMode = false);
46
-
51 std::string getFileName() override;
-
52
-
57 Status open() override;
-
58
-
64 Status open(bool newfile) override;
-
65
-
70 Status close() override;
-
71
-
81 Status createAttribute(const BaseDataType& type,
-
82 const void* data,
-
83 const std::string& path,
-
84 const std::string& name,
-
85 const SizeType& size = 1) override;
-
86
-
94 Status createAttribute(const std::string& data,
-
95 const std::string& path,
-
96 const std::string& name) override;
-
97
-
105 Status createAttribute(const std::vector<std::string>& data,
-
106 const std::string& path,
-
107 const std::string& name) override;
-
108
-
117 Status createAttribute(const std::vector<const char*>& data,
-
118 const std::string& path,
-
119 const std::string& name,
-
120 const SizeType& maxSize) override;
-
121
-
129 Status createReferenceAttribute(const std::string& referencePath,
-
130 const std::string& path,
-
131 const std::string& name) override;
-
132
-
138 Status createGroup(const std::string& path) override;
-
139
-
147 Status createLink(const std::string& path,
-
148 const std::string& reference) override;
-
149
-
156 Status createStringDataSet(const std::string& path,
-
157 const std::string& value) override;
-
158
-
165 Status createStringDataSet(const std::string& path,
-
166 const std::vector<std::string>& values) override;
-
167
-
175 Status createReferenceDataSet(
-
176 const std::string& path,
-
177 const std::vector<std::string>& references) override;
-
178
-
183 Status startRecording() override;
-
184
-
189 Status stopRecording() override;
-
190
-
197 bool canModifyObjects() override;
-
198
-
208 std::unique_ptr<BaseRecordingData> createArrayDataSet(
-
209 const BaseDataType& type,
-
210 const SizeArray& size,
-
211 const SizeArray& chunking,
-
212 const std::string& path) override;
-
213
-
219 std::unique_ptr<BaseRecordingData> getDataSet(
-
220 const std::string& path) override;
-
221
-
227 H5O_type_t getObjectType(const std::string& path);
-
228
-
234 static H5::DataType getNativeType(BaseDataType type);
-
235
-
241 static H5::DataType getH5Type(BaseDataType type);
-
242
-
243protected:
-
244 std::string filename;
-
245
-
251 Status createGroupIfDoesNotExist(const std::string& path) override;
-
252
-
253private:
-
254 std::unique_ptr<H5::H5File> file;
-
255 bool disableSWMRMode; // when set do not use SWMR mode when opening the HDF5
-
256 // file
-
257};
+
50 ~HDF5IO();
+
51
+
56 std::string getFileName() override;
+
57
+
62 Status open() override;
+
63
+
69 Status open(bool newfile) override;
+
70
+
75 Status close() override;
+
76
+
86 Status createAttribute(const BaseDataType& type,
+
87 const void* data,
+
88 const std::string& path,
+
89 const std::string& name,
+
90 const SizeType& size = 1) override;
+
91
+
99 Status createAttribute(const std::string& data,
+
100 const std::string& path,
+
101 const std::string& name) override;
+
102
+
110 Status createAttribute(const std::vector<std::string>& data,
+
111 const std::string& path,
+
112 const std::string& name) override;
+
113
+
122 Status createAttribute(const std::vector<const char*>& data,
+
123 const std::string& path,
+
124 const std::string& name,
+
125 const SizeType& maxSize) override;
+
126
+
134 Status createReferenceAttribute(const std::string& referencePath,
+
135 const std::string& path,
+
136 const std::string& name) override;
+
137
+
143 Status createGroup(const std::string& path) override;
+
144
+
152 Status createLink(const std::string& path,
+
153 const std::string& reference) override;
+
154
+
161 Status createStringDataSet(const std::string& path,
+
162 const std::string& value) override;
+
163
+
170 Status createStringDataSet(const std::string& path,
+
171 const std::vector<std::string>& values) override;
+
172
+
180 Status createReferenceDataSet(
+
181 const std::string& path,
+
182 const std::vector<std::string>& references) override;
+
183
+
188 Status startRecording() override;
+
189
+
194 Status stopRecording() override;
+
195
+
202 bool canModifyObjects() override;
+
203
+
213 std::unique_ptr<BaseRecordingData> createArrayDataSet(
+
214 const BaseDataType& type,
+
215 const SizeArray& size,
+
216 const SizeArray& chunking,
+
217 const std::string& path) override;
+
218
+
224 std::unique_ptr<BaseRecordingData> getDataSet(
+
225 const std::string& path) override;
+
226
+
232 H5O_type_t getObjectType(const std::string& path);
+
233
+
239 static H5::DataType getNativeType(BaseDataType type);
+
240
+
246 static H5::DataType getH5Type(BaseDataType type);
+
247
+
248protected:
+
249 std::string filename;
+
250
+
256 Status createGroupIfDoesNotExist(const std::string& path) override;
+
257
+
258private:
+
259 std::unique_ptr<H5::H5File> file;
+
260 bool disableSWMRMode; // when set do not use SWMR mode when opening the HDF5
+
261 // file
+
262};
-
258
-
-
266class HDF5RecordingData : public BaseRecordingData
-
267{
-
268public:
-
273 HDF5RecordingData(std::unique_ptr<H5::DataSet> data);
-
274
-
278 HDF5RecordingData(const HDF5RecordingData&) = delete;
+
263
+
+
271class HDF5RecordingData : public BaseRecordingData
+
272{
+
273public:
+
278 HDF5RecordingData(std::unique_ptr<H5::DataSet> data);
279
-
283 HDF5RecordingData& operator=(const HDF5RecordingData&) = delete;
+
283 HDF5RecordingData(const HDF5RecordingData&) = delete;
284
-
288 ~HDF5RecordingData();
+
288 HDF5RecordingData& operator=(const HDF5RecordingData&) = delete;
289
-
298 Status writeDataBlock(const std::vector<SizeType>& dataShape,
-
299 const std::vector<SizeType>& positionOffset,
-
300 const BaseDataType& type,
-
301 const void* data);
-
302
-
307 const H5::DataSet* getDataSet();
-
308
-
309private:
-
313 std::unique_ptr<H5::DataSet> dSet;
-
314
-
318 Status checkStatus(int status);
-
319};
+
293 ~HDF5RecordingData();
+
294
+
303 Status writeDataBlock(const std::vector<SizeType>& dataShape,
+
304 const std::vector<SizeType>& positionOffset,
+
305 const BaseDataType& type,
+
306 const void* data);
+
307
+
312 const H5::DataSet* getDataSet();
+
313
+
314private:
+
318 std::unique_ptr<H5::DataSet> dSet;
+
319
+
323 Status checkStatus(int status);
+
324};
-
320} // namespace AQNWB::HDF5
+
325} // namespace AQNWB::HDF5
BaseIO.hpp
SizeType
AQNWB::Types::SizeType SizeType
Definition BaseIO.hpp:16
@@ -273,8 +273,8 @@
AQNWB::HDF5::HDF5IO::getObjectType
H5O_type_t getObjectType(const std::string &path)
Returns the HDF5 type of object at a given path.
Definition HDF5IO.cpp:501
AQNWB::HDF5::HDF5IO::open
Status open() override
Opens an existing file or creates a new file for writing.
Definition HDF5IO.cpp:37
AQNWB::HDF5::HDF5IO::createGroupIfDoesNotExist
Status createGroupIfDoesNotExist(const std::string &path) override
Creates a new group if it does not exist.
Definition HDF5IO.cpp:292
-
AQNWB::HDF5::HDF5IO::filename
std::string filename
Definition HDF5IO.hpp:244
-
AQNWB::HDF5::HDF5RecordingData
Represents an HDF5 Dataset that can be extended indefinitely in blocks.
Definition HDF5IO.hpp:267
+
AQNWB::HDF5::HDF5IO::filename
std::string filename
Definition HDF5IO.hpp:249
+
AQNWB::HDF5::HDF5RecordingData
Represents an HDF5 Dataset that can be extended indefinitely in blocks.
Definition HDF5IO.hpp:272
AQNWB::HDF5::HDF5RecordingData::getDataSet
const H5::DataSet * getDataSet()
Gets a const pointer to the HDF5 dataset.
Definition HDF5IO.cpp:719
AQNWB::HDF5::HDF5RecordingData::HDF5RecordingData
HDF5RecordingData(const HDF5RecordingData &)=delete
Deleted copy constructor to prevent construction-copying.
AQNWB::HDF5::HDF5RecordingData::writeDataBlock
Status writeDataBlock(const std::vector< SizeType > &dataShape, const std::vector< SizeType > &positionOffset, const BaseDataType &type, const void *data)
Writes a block of data to the HDF5 dataset.
Definition HDF5IO.cpp:651
diff --git a/class_a_q_n_w_b_1_1_h_d_f5_1_1_h_d_f5_i_o.html b/class_a_q_n_w_b_1_1_h_d_f5_1_1_h_d_f5_i_o.html index 19c45666..00898e35 100644 --- a/class_a_q_n_w_b_1_1_h_d_f5_1_1_h_d_f5_i_o.html +++ b/class_a_q_n_w_b_1_1_h_d_f5_1_1_h_d_f5_i_o.html @@ -304,6 +304,7 @@

Parameters
+
fileNameThe name of the HDF5 file.
disableSWMRModeDisable recording of data in Single Writer Multiple Reader (SWMR) mode. Using SWMR ensures that the HDF5 file remains valid and readable at all times during the recording process (but does not allow for new objects (Groups or Datasets) to be created.