openPMD-api
Access.hpp
1 /* Copyright 2017-2021 Fabian Koller and Franz Poeschel
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 namespace openPMD
24 {
27 enum class Access
28 {
29  READ_ONLY,
30  READ_WRITE,
31  CREATE
32 }; // Access
33 
34 // deprecated name (used prior to 0.12.0)
35 // note: "using old [[deprecated(msg)]] = new;" is still badly supported, thus
36 // using typedef
37 // https://en.cppreference.com/w/cpp/language/attributes/deprecated
38 // - NVCC < 11.0.167 works but noisy "warning: attribute does not apply to any
39 // entity"
40 // Nvidia bug report: 2991260
41 // - Intel C++ 19.1.0.20200306 bug report: 04651484
42 [[deprecated("AccessType is deprecated, use Access instead.")]] typedef Access
43  AccessType;
44 } // namespace openPMD
open existing series as writable
Access
File access mode to use during IO.
Definition: Access.hpp:27
create new series and truncate existing (files)
Public definitions of openPMD-api.
Definition: Date.cpp:28
open series as read-only, fails if series is not found