line.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_H
36 #define NAV_GRID_ITERATORS_LINE_H
37 
40 #include <memory>
41 
42 namespace nav_grid_iterators
43 {
48 class Line : public BaseIterator<Line>
49 {
50 public:
60  Line(const nav_grid::NavGridInfo* info, double x0, double y0, double x1, double y1,
61  bool include_last_index = true, bool bresenham = true);
62 
67  Line(const Line& other);
68 
73  Line& operator=(const Line& other);
74 
77  Line begin() const override;
78  Line end() const override;
79  void increment() override;
80  bool fieldsEqual(const Line& other) override;
83 protected:
96  Line(const nav_grid::NavGridInfo* info, const nav_grid::Index& index, double x0, double y0, double x1, double y1,
97  bool include_last_index, bool bresenham, nav_grid::Index start_index, nav_grid::Index end_index);
98 
99  void constructIterator();
100 
104  bool inBounds(const nav_grid::SignedIndex& sindex);
105 
106  std::unique_ptr<AbstractLineIterator> internal_iterator_;
107  double x0_, y0_, x1_, y1_;
112 };
113 } // namespace nav_grid_iterators
114 
115 #endif // NAV_GRID_ITERATORS_LINE_H
nav_grid::Index start_index_
Definition: line.h:111
Line begin() const override
Helper function for range-style iteration Equivalent to the above constructor.
Definition: line.cpp:136
nav_grid::Index end_index_
Definition: line.h:111
std::unique_ptr< AbstractLineIterator > internal_iterator_
Definition: line.h:106
void increment() override
Increase the iterator to the next element.
Definition: line.cpp:146
Line end() const override
Helper function for range-style iteration.
Definition: line.cpp:141
Iterates over all of the valid indexes of a line.
Definition: line.h:48
bool fieldsEqual(const Line &other) override
Additional check for whether fields of derived iterators are equal.
Definition: line.cpp:161
Line & operator=(const Line &other)
Assignment Operator Required to ensure unique_ptr is set properly.
Definition: line.cpp:96
Line(const nav_grid::NavGridInfo *info, double x0, double y0, double x1, double y1, bool include_last_index=true, bool bresenham=true)
Public Constructor.
Definition: line.cpp:42
bool inBounds(const nav_grid::SignedIndex &sindex)
Check if a SignedIndex is within the bounds of the NavGrid.
Definition: line.cpp:131


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