openPMD-api
AbstractIOHandlerImpl.hpp
1 /* Copyright 2018-2020 Fabian Koller
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 #include "openPMD/IO/AbstractIOHandler.hpp"
24 #include "openPMD/IO/IOTask.hpp"
25 
26 #include <future>
27 
28 
29 namespace openPMD
30 {
31 // class AbstractIOHandler;
32 class Writable;
33 
35 {
36 public:
38  : m_handler{handler}
39  { }
40 
41  virtual ~AbstractIOHandlerImpl() = default;
42 
43  virtual std::future< void > flush()
44  {
45  while( !(*m_handler).m_work.empty() )
46  {
47  IOTask& i = (*m_handler).m_work.front();
48  try
49  {
50  switch( i.operation )
51  {
52  using O = Operation;
53  case O::CREATE_FILE:
54  createFile(i.writable, *dynamic_cast< Parameter< Operation::CREATE_FILE >* >(i.parameter.get()));
55  break;
56  case O::CREATE_PATH:
57  createPath(i.writable, *dynamic_cast< Parameter< O::CREATE_PATH >* >(i.parameter.get()));
58  break;
59  case O::CREATE_DATASET:
60  createDataset(i.writable, *dynamic_cast< Parameter< O::CREATE_DATASET >* >(i.parameter.get()));
61  break;
62  case O::EXTEND_DATASET:
63  extendDataset(i.writable, *dynamic_cast< Parameter< O::EXTEND_DATASET >* >(i.parameter.get()));
64  break;
65  case O::OPEN_FILE:
66  openFile(i.writable, *dynamic_cast< Parameter< O::OPEN_FILE >* >(i.parameter.get()));
67  break;
68  case O::OPEN_PATH:
69  openPath(i.writable, *dynamic_cast< Parameter< O::OPEN_PATH >* >(i.parameter.get()));
70  break;
71  case O::OPEN_DATASET:
72  openDataset(i.writable, *dynamic_cast< Parameter< O::OPEN_DATASET >* >(i.parameter.get()));
73  break;
74  case O::DELETE_FILE:
75  deleteFile(i.writable, *dynamic_cast< Parameter< O::DELETE_FILE >* >(i.parameter.get()));
76  break;
77  case O::DELETE_PATH:
78  deletePath(i.writable, *dynamic_cast< Parameter< O::DELETE_PATH >* >(i.parameter.get()));
79  break;
80  case O::DELETE_DATASET:
81  deleteDataset(i.writable, *dynamic_cast< Parameter< O::DELETE_DATASET >* >(i.parameter.get()));
82  break;
83  case O::DELETE_ATT:
84  deleteAttribute(i.writable, *dynamic_cast< Parameter< O::DELETE_ATT >* >(i.parameter.get()));
85  break;
86  case O::WRITE_DATASET:
87  writeDataset(i.writable, *dynamic_cast< Parameter< O::WRITE_DATASET >* >(i.parameter.get()));
88  break;
89  case O::WRITE_ATT:
90  writeAttribute(i.writable, *dynamic_cast< Parameter< O::WRITE_ATT >* >(i.parameter.get()));
91  break;
92  case O::READ_DATASET:
93  readDataset(i.writable, *dynamic_cast< Parameter< O::READ_DATASET >* >(i.parameter.get()));
94  break;
95  case O::READ_ATT:
96  readAttribute(i.writable, *dynamic_cast< Parameter< O::READ_ATT >* >(i.parameter.get()));
97  break;
98  case O::LIST_PATHS:
99  listPaths(i.writable, *dynamic_cast< Parameter< O::LIST_PATHS >* >(i.parameter.get()));
100  break;
101  case O::LIST_DATASETS:
102  listDatasets(i.writable, *dynamic_cast< Parameter< O::LIST_DATASETS >* >(i.parameter.get()));
103  break;
104  case O::LIST_ATTS:
105  listAttributes(i.writable, *dynamic_cast< Parameter< O::LIST_ATTS >* >(i.parameter.get()));
106  break;
107  }
108  } catch (unsupported_data_error&)
109  {
110  (*m_handler).m_work.pop();
111  throw;
112  }
113  (*m_handler).m_work.pop();
114  }
115  return std::future< void >();
116  }
117 
128  virtual void createFile(Writable*, Parameter< Operation::CREATE_FILE > const&) = 0;
136  virtual void createPath(Writable*, Parameter< Operation::CREATE_PATH > const&) = 0;
170  virtual void openFile(Writable*, Parameter< Operation::OPEN_FILE > const&) = 0;
178  virtual void openPath(Writable*, Parameter< Operation::OPEN_PATH > const&) = 0;
199  virtual void deleteFile(Writable*, Parameter< Operation::DELETE_FILE > const&) = 0;
209  virtual void deletePath(Writable*, Parameter< Operation::DELETE_PATH > const&) = 0;
249  virtual void writeAttribute(Writable*, Parameter< Operation::WRITE_ATT > const&) = 0;
292 
293  AbstractIOHandler* m_handler;
294 }; //AbstractIOHandlerImpl
295 } // openPMD
virtual void writeDataset(Writable *, Parameter< Operation::WRITE_DATASET > const &)=0
Write a chunk of data into an existing dataset.
virtual void deleteAttribute(Writable *, Parameter< Operation::DELETE_ATT > const &)=0
Delete an existing attribute.
virtual void writeAttribute(Writable *, Parameter< Operation::WRITE_ATT > const &)=0
Create a single attribute and fill the value, possibly overwriting an existing attribute.
Self-contained description of a single IO operation.
Definition: IOTask.hpp:468
virtual void deleteDataset(Writable *, Parameter< Operation::DELETE_DATASET > const &)=0
Delete an existing dataset.
virtual void createDataset(Writable *, Parameter< Operation::CREATE_DATASET > const &)=0
Create a new dataset of given type, extent and storage properties.
Definition: AbstractIOHandler.hpp:50
virtual void listPaths(Writable *, Parameter< Operation::LIST_PATHS > &)=0
List all paths/sub-groups inside a group, non-recursively.
virtual void createFile(Writable *, Parameter< Operation::CREATE_FILE > const &)=0
Create a new file in physical storage, possibly overriding an existing file.
virtual void extendDataset(Writable *, Parameter< Operation::EXTEND_DATASET > const &)=0
Increase the extent of an existing dataset.
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:68
virtual void deleteFile(Writable *, Parameter< Operation::DELETE_FILE > const &)=0
Delete an existing file from physical storage.
Public definitions of openPMD-api.
Definition: Date.cpp:28
Layer to mirror structure of logical data and persistent data in file.
Definition: Writable.hpp:55
virtual void readDataset(Writable *, Parameter< Operation::READ_DATASET > &)=0
Read a chunk of data from an existing dataset.
virtual void listAttributes(Writable *, Parameter< Operation::LIST_ATTS > &)=0
List all attributes associated with an object.
Typesafe description of all required arguments for a specified Operation.
Definition: IOTask.hpp:103
virtual void openDataset(Writable *, Parameter< Operation::OPEN_DATASET > &)=0
Open an existing dataset and determine its datatype and extent.
virtual void openFile(Writable *, Parameter< Operation::OPEN_FILE > const &)=0
Open an existing file assuming it conforms to openPMD.
virtual void deletePath(Writable *, Parameter< Operation::DELETE_PATH > const &)=0
Delete all objects within an existing path.
virtual void listDatasets(Writable *, Parameter< Operation::LIST_DATASETS > &)=0
List all datasets inside a group, non-recursively.
Definition: AbstractIOHandlerImpl.hpp:34
virtual void createPath(Writable *, Parameter< Operation::CREATE_PATH > const &)=0
Create all necessary groups for a path, possibly recursively.
virtual void readAttribute(Writable *, Parameter< Operation::READ_ATT > &)=0
Read the value of an existing attribute.
Operation
Type of IO operation between logical and persistent data.
Definition: IOTask.hpp:56
virtual void openPath(Writable *, Parameter< Operation::OPEN_PATH > const &)=0
Open all contained groups in a path, possibly recursively.