abstract_line_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_LINE_ABSTRACT_LINE_ITERATOR_H
36 #define NAV_GRID_ITERATORS_LINE_ABSTRACT_LINE_ITERATOR_H
37 
38 #include <nav_grid/index.h>
39 
40 namespace nav_grid_iterators
41 {
49 {
50 public:
55 
60  const nav_grid::SignedIndex& operator*() const { return index_; }
61 
62  virtual nav_grid::SignedIndex getFinalIndex() const = 0;
63 
64  bool isFinished()
65  {
66  return getFinalIndex() == index_;
67  }
68 
72  virtual void increment() = 0;
73 
74 protected:
80 };
81 
82 } // namespace nav_grid_iterators
83 
84 #endif // NAV_GRID_ITERATORS_LINE_ABSTRACT_LINE_ITERATOR_H
virtual nav_grid::SignedIndex getFinalIndex() const =0
Abstract class for iterating over lines.
AbstractLineIterator(nav_grid::SignedIndex index)
Protected Constructor - takes arbitrary index.
const nav_grid::SignedIndex & operator*() const
Dereference the iterator.
virtual void increment()=0
Increase the iterator to the next element.


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