h5cpp  0.5.0
A modern C++ wrapper for the HDF5 C library
recursive_node_iterator.hpp
Go to the documentation of this file.
1 //
2 // (c) Copyright 2017 DESY,ESS
3 //
4 // This file is part of h5cpp.
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: Nov 17, 2017
24 //
25 #pragma once
26 
27 #include <functional>
28 #include <h5cpp/node/group.hpp>
30 #include <h5cpp/core/windows.hpp>
31 
32 namespace hdf5 {
33 namespace node {
34 
64 {
65  public:
66  using value_type = Node;
67  using pointer = value_type*;
69  using difference_type = ssize_t;
70  using iterator_category = std::forward_iterator_tag;
71 
77  RecursiveNodeIterator() = delete;
78 
89  static RecursiveNodeIterator begin(const Group &current_group);
90 
101  static RecursiveNodeIterator end(const Group &current_group);
102 
109  Node operator*() const;
110 
117  Node *operator->();
118 
133  RecursiveNodeIterator &operator++();
134 
153  RecursiveNodeIterator operator++(int);
154 
155  bool operator==(const RecursiveNodeIterator &rhs) const;
156 
157  bool operator!=(const RecursiveNodeIterator &rhs) const;
158 
159  private:
160  RecursiveNodeIterator(const Group &current_group,
161  RecursiveNodeIterator parent_iterator);
162  RecursiveNodeIterator(const Group &current_group);
163 
164  using IteratorPointer = std::shared_ptr<RecursiveNodeIterator>;
165 
170  Group current_group_;
171 
175  NodeIterator current_iterator_;
176 
177 #ifdef _MSC_VER
178 #pragma warning(push)
179 #pragma warning(disable: 4251)
180 #endif
181  IteratorPointer parent_iterator_;
185 #ifdef _MSC_VER
186 #pragma warning(pop)
187 #endif
188 
189 
190 
191 };
192 
193 } // namespace node
194 } // namespace hdf5
hdf5::node::NodeIterator
bidirectional NodeIterator
Definition: node_iterator.hpp:52
hdf5::node::RecursiveNodeIterator
recursive node iterator
Definition: recursive_node_iterator.hpp:63
hdf5::node::RecursiveNodeIterator::iterator_category
std::forward_iterator_tag iterator_category
Definition: recursive_node_iterator.hpp:70
group.hpp
hdf5::node::Node
Definition: node.hpp:39
hdf5::node::Group
Definition: group.hpp:50
windows.hpp
hdf5::node::RecursiveNodeIterator::difference_type
ssize_t difference_type
Definition: recursive_node_iterator.hpp:69
hdf5::node::operator!=
bool operator!=(const Link &lhs, const Link &rhs)
DLL_EXPORT
#define DLL_EXPORT
Definition: windows.hpp:29
node_iterator.hpp
hdf5
top-level namespace of the entire library
Definition: attribute.hpp:45
hdf5::node::operator==
bool operator==(const Node &lhs, const Node &rhs)