sub_grid.cpp
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 
36 
37 namespace nav_grid_iterators
38 {
40 {
42 }
43 
45 {
47 }
48 
50 {
51  ++index_.x;
52  if (index_.x >= min_x_ + width_)
53  {
54  index_.x = min_x_;
55  ++index_.y;
56  }
57 }
58 
59 bool SubGrid::fieldsEqual(const SubGrid& other)
60 {
61  return min_x_ == other.min_x_ && min_y_ == other.min_y_ && width_ == other.width_ && height_ == other.height_;
62 }
63 
64 } // namespace nav_grid_iterators
void increment() override
Increase the iterator to the next element.
Definition: sub_grid.cpp:49
bool fieldsEqual(const SubGrid &other) override
Additional check for whether fields of derived iterators are equal.
Definition: sub_grid.cpp:59
SubGrid begin() const override
Helper function for range-style iteration Equivalent to the above constructor.
Definition: sub_grid.cpp:39
const nav_grid::NavGridInfo * info_
SubGrid end() const override
Helper function for range-style iteration.
Definition: sub_grid.cpp:44
Iterator for looping through every index within an aligned rectangular portion of the grid...
Definition: sub_grid.h:47
SubGrid(const nav_grid::NavGridInfo *info, unsigned int min_x, unsigned int min_y, unsigned int width, unsigned int height)
Public Constructor.
Definition: sub_grid.h:61


nav_grid_iterators
Author(s):
autogenerated on Wed Jun 26 2019 20:06:20