H5File.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c), 2017, Adrien Devresse <adrien.devresse@epfl.ch>
3  *
4  * Distributed under the Boost Software License, Version 1.0.
5  * (See accompanying file LICENSE_1_0.txt or copy at
6  * http://www.boost.org/LICENSE_1_0.txt)
7  *
8  */
9 #ifndef H5FILE_HPP
10 #define H5FILE_HPP
11 
12 #include <string>
13 
14 #include "H5FileDriver.hpp"
15 #include "H5Object.hpp"
16 
18 #include "bits/H5Node_traits.hpp"
19 
20 namespace HighFive {
21 
25 class File : public Object,
26  public NodeTraits<File>,
27  public AnnotateTraits<File> {
28  public:
30  static const int ReadOnly = 0x00;
32  static const int ReadWrite = 0x01;
34  static const int Truncate = 0x02;
36  static const int Excl = 0x04;
38  static const int Debug = 0x08;
40  static const int Create = 0x10;
42  static const int Overwrite = Truncate;
44  static const int OpenOrCreate = ReadWrite | Create;
45 
46 
53  explicit File(const std::string& filename, int openFlags = ReadOnly,
54  const Properties& fileAccessProps = FileDriver());
55 
59  const std::string& getName() const;
60 
66  void flush();
67 
68  private:
69  std::string _filename;
70 };
71 } // namespace HighFive
72 
73 #include "bits/H5File_misc.hpp"
74 
75 #endif // H5FILE_HPP
76 
HighFive::File::Overwrite
static const int Overwrite
Derived open flag: common write mode (=ReadWrite | Create | Truncate)
Definition: H5File.hpp:42
HighFive::File::getName
const std::string & getName() const
Return the name of the file.
Definition: H5File_misc.hpp:79
HighFive::File::ReadOnly
static const int ReadOnly
Open flag: Read only access.
Definition: H5File.hpp:30
H5Object.hpp
HighFive::AnnotateTraits
Definition: H5Annotate_traits.hpp:23
HighFive::File::OpenOrCreate
static const int OpenOrCreate
Derived open flag: Opens RW or exclusivelly creates.
Definition: H5File.hpp:44
HighFive::File::File
File(const std::string &filename, int openFlags=ReadOnly, const Properties &fileAccessProps=FileDriver())
File.
Definition: H5File_misc.hpp:41
HighFive::File::Debug
static const int Debug
Open flag: Open in debug mode.
Definition: H5File.hpp:38
HighFive::Object
Definition: H5Object.hpp:21
HighFive::NodeTraits
Definition: H5Node_traits.hpp:23
H5FileDriver.hpp
H5File_misc.hpp
HighFive::File::Create
static const int Create
Open flag: Create non existing file.
Definition: H5File.hpp:40
scripts.normalize_multiple.filename
filename
Definition: normalize_multiple.py:60
H5Node_traits.hpp
HighFive::FileDriver
file driver base concept
Definition: H5FileDriver.hpp:19
H5Annotate_traits.hpp
HighFive::File
File class.
Definition: H5File.hpp:25
HighFive::File::Excl
static const int Excl
Open flag: Open will fail if file already exist.
Definition: H5File.hpp:36
HighFive::File::flush
void flush()
flush
Definition: H5File_misc.hpp:83
HighFive::Properties
Generic HDF5 property List.
Definition: H5PropertyList.hpp:21
HighFive::File::ReadWrite
static const int ReadWrite
Open flag: Read Write access.
Definition: H5File.hpp:32
HighFive::File::Truncate
static const int Truncate
Open flag: Truncate a file if already existing.
Definition: H5File.hpp:34
HighFive
Definition: H5Annotate_traits.hpp:14
HighFive::File::_filename
std::string _filename
Definition: H5File.hpp:69


lvr2
Author(s): Thomas Wiemann , Sebastian Pütz , Alexander Mock , Lars Kiesow , Lukas Kalbertodt , Tristan Igelbrink , Johan M. von Behren , Dominik Feldschnieders , Alexander Löhr
autogenerated on Wed Mar 2 2022 00:37:23