Chaste  Release::3.4
AbstractHdf5Access.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef ABSTRACTHDF5ACCESS_HPP_
37 #define ABSTRACTHDF5ACCESS_HPP_
38 
39 #ifndef H5_USE_16_API
40 #define H5_USE_16_API 1
41 #endif
42 
43 #include <hdf5.h>
44 #include <string>
45 #include "FileFinder.hpp"
46 
47 
48 const unsigned MAX_STRING_SIZE = 100;
49 
56 {
57 
58 protected:
59  std::string mBaseName;
60  std::string mDatasetName;
62  static const unsigned DATASET_DIMS=3;
68  std::vector<unsigned> mIncompleteNodeIndices;
70  hid_t mFileId;
81  bool DoesDatasetExist(const std::string& rDatasetName);
82 
90  void SetUnlimitedDatasetId();
91 
105 
106 
107 public:
116  AbstractHdf5Access(const std::string& rDirectory,
117  const std::string& rBaseName,
118  const std::string& rDatasetName,
119  bool makeAbsolute = true);
120 
128  AbstractHdf5Access(const FileFinder& rDirectory,
129  const std::string& rBaseName,
130  const std::string& rDatasetName);
131 
135  virtual ~AbstractHdf5Access();
136 
142  bool IsDataComplete();
143 
147  std::vector<unsigned> GetIncompleteNodeMap();
148 
152  std::string GetUnlimitedDimensionName();
153 
157  std::string GetUnlimitedDimensionUnit();
158 
159 
160 };
161 
162 #endif // ABSTRACTHDF5ACCESS_HPP_
std::string GetUnlimitedDimensionUnit()
std::string mUnlimitedDimensionName
std::string mUnlimitedDimensionUnit
bool DoesDatasetExist(const std::string &rDatasetName)
hsize_t mDatasetDims[DATASET_DIMS]
std::string GetUnlimitedDimensionName()
AbstractHdf5Access(const std::string &rDirectory, const std::string &rBaseName, const std::string &rDatasetName, bool makeAbsolute=true)
std::vector< unsigned > mIncompleteNodeIndices
static const unsigned DATASET_DIMS
std::vector< unsigned > GetIncompleteNodeMap()