base_iterator.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2018, Locus Robotics
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef NAV_GRID_ITERATORS_BASE_ITERATOR_H
36 #define NAV_GRID_ITERATORS_BASE_ITERATOR_H
37 
38 #include <nav_grid/nav_grid_info.h>
39 #include <nav_grid/index.h>
40 
42 {
43 template<class Derived>
45 {
46 public:
51  explicit BaseIterator(const nav_grid::NavGridInfo* info) : BaseIterator(info, nav_grid::Index(0, 0)) {}
52 
57  explicit BaseIterator(const nav_grid::NavGridInfo& info) : BaseIterator(&info, nav_grid::Index(0, 0)) {}
58 
62  virtual ~BaseIterator() = default;
63 
69  virtual Derived begin() const = 0;
70 
75  virtual Derived end() const = 0;
76 
83  bool operator==(const Derived& other) { return info_ == other.info_ && index_ == other.index_ && fieldsEqual(other); }
84 
88  bool operator!=(const Derived& other) { return !(*this == other); }
89 
95  virtual bool fieldsEqual(const Derived& other) { return true; }
96 
101  const nav_grid::Index& operator*() const { return index_; }
102 
107  Derived& operator++()
108  {
109  increment();
110  return *static_cast<Derived*>(this);
111  }
112 
116  virtual void increment() = 0;
117 
118  using self_type = Derived;
122  using iterator_category = std::input_iterator_tag;
123  using difference_type = int;
124 
125 
126 protected:
132  BaseIterator(const nav_grid::NavGridInfo* info, const nav_grid::Index& index) : info_(info), index_(index) {}
133 
136 };
137 } // namespace nav_grid_iterators
138 
139 #endif // NAV_GRID_ITERATORS_BASE_ITERATOR_H
const nav_grid::Index & operator*() const
Dereference the iterator.
virtual Derived begin() const =0
Helper function for range-style iteration Equivalent to the above constructor.
virtual void increment()=0
Increase the iterator to the next element.
virtual Derived end() const =0
Helper function for range-style iteration.
GenericIndex< unsigned int > Index
virtual ~BaseIterator()=default
Destructor.
const nav_grid::NavGridInfo * info_
BaseIterator(const nav_grid::NavGridInfo &info)
Public Constructor. Takes in a reference to the info and starts at the minimum index.
Definition: base_iterator.h:57
BaseIterator(const nav_grid::NavGridInfo *info)
Public Constructor. Takes in a pointer to the info and starts at the minimum index.
Definition: base_iterator.h:51
bool operator==(const Derived &other)
Test if two iterators are equivalent.
Definition: base_iterator.h:83
BaseIterator(const nav_grid::NavGridInfo *info, const nav_grid::Index &index)
Protected constructor that takes in an arbitrary index.
Iterates over all of the valid indexes that lie within an arbitrary polygon in row major order...
Definition: polygon_fill.h:49
bool operator!=(const Derived &other)
Test if two iterators are not equivalent - required for testing if iterator is at the end...
Definition: base_iterator.h:88
Derived & operator++()
Increase the iterator to the next element.
virtual bool fieldsEqual(const Derived &other)
Additional check for whether fields of derived iterators are equal.
Definition: base_iterator.h:95


nav_grid_iterators
Author(s):
autogenerated on Sun Jan 10 2021 04:08:42