h5cpp  0.3.3
A modern C++ wrapper for the HDF5 C library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
functions.hpp
Go to the documentation of this file.
1 //
2 // (c) Copyright 2017 DESY,ESS
3 //
4 // This file is part of h5pp.
5 //
6 // This library is free software; you can redistribute it and/or modify it
7 // under the terms of the GNU Lesser General Public License as published
8 // by the Free Software Foundation; either version 2.1 of the License, or
9 // (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful, but
12 // WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY
13 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
14 // License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public License
17 // along with this library; if not, write to the
18 // Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
19 // Boston, MA 02110-1301 USA
20 // ===========================================================================
21 //
22 // Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
23 // Created on: Sep 8, 2017
24 //
25 #pragma once
26 
27 #include <h5cpp/file/file.hpp>
28 #include <h5cpp/file/types.hpp>
31 #include <h5cpp/core/windows.hpp>
32 
33 namespace hdf5 {
34 namespace file {
35 
49 DLL_EXPORT File create(const boost::filesystem::path &path,
51  const property::FileCreationList &fcpl = property::FileCreationList(),
52  const property::FileAccessList &fapl = property::FileAccessList());
53 DLL_EXPORT File create(const boost::filesystem::path &path,
54  AccessFlagsBase flags,
55  const property::FileCreationList &fcpl = property::FileCreationList(),
56  const property::FileAccessList &fapl = property::FileAccessList());
57 
69 DLL_EXPORT File open(const boost::filesystem::path &path,
71  const property::FileAccessList &fapl = property::FileAccessList());
72 DLL_EXPORT File open(const boost::filesystem::path &path,
73  AccessFlagsBase flags,
74  const property::FileAccessList &fapl = property::FileAccessList());
75 
83 DLL_EXPORT bool is_hdf5_file(const boost::filesystem::path &path);
84 
85 } // namespace file
86 } // namespace hdf5
87 
88 
89 
90 
DLL_EXPORT File open(const boost::filesystem::path &path, AccessFlags flags=AccessFlags::READONLY, const property::FileAccessList &fapl=property::FileAccessList())
open an existing file
Definition: attribute.hpp:43
DLL_EXPORT bool is_hdf5_file(const boost::filesystem::path &path)
check if the file reference by the path is an HDF5 file
std::underlying_type< AccessFlags >::type AccessFlagsBase
Definition: types.hpp:49
#define DLL_EXPORT
Definition: windows.hpp:35
AccessFlags
flags controlling file opening and creation
Definition: types.hpp:37
DLL_EXPORT File create(const boost::filesystem::path &path, AccessFlags flags=AccessFlags::EXCLUSIVE, const property::FileCreationList &fcpl=property::FileCreationList(), const property::FileAccessList &fapl=property::FileAccessList())
create a new file