sub_grid.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_SUB_GRID_H
36 #define NAV_GRID_ITERATORS_SUB_GRID_H
37 
39 #include <nav_core2/bounds.h>
40 
41 namespace nav_grid_iterators
42 {
47 class SubGrid : public BaseIterator<SubGrid>
48 {
49 public:
58  SubGrid(const nav_grid::NavGridInfo* info, unsigned int min_x, unsigned int min_y,
59  unsigned int width, unsigned int height)
60  : SubGrid(info, nav_grid::Index(min_x, min_y), min_x, min_y, width, height) {}
61 
68  : SubGrid(info, bounds.getMinX(), bounds.getMinY(), bounds.getWidth(), bounds.getHeight()) {}
69 
79  SubGrid(const nav_grid::NavGridInfo* info, const nav_grid::Index& index, unsigned int min_x, unsigned int min_y,
80  unsigned int width, unsigned int height);
81 
88  SubGrid(const nav_grid::NavGridInfo* info, const nav_grid::Index& index, const nav_core2::UIntBounds& bounds)
89  : SubGrid(info, index, bounds.getMinX(), bounds.getMinY(), bounds.getWidth(), bounds.getHeight()) {}
90 
93  SubGrid begin() const override;
94  SubGrid end() const override;
95  void increment() override;
96  bool fieldsEqual(const SubGrid& other) override;
99 protected:
100  unsigned int min_x_, min_y_, width_, height_;
101 };
102 } // namespace nav_grid_iterators
103 
104 #endif // NAV_GRID_ITERATORS_SUB_GRID_H
SubGrid(const nav_grid::NavGridInfo *info, const nav_core2::UIntBounds &bounds)
Public Constructor using UIntBounds object.
Definition: sub_grid.h:67
void increment() override
Increase the iterator to the next element.
Definition: sub_grid.cpp:78
bool fieldsEqual(const SubGrid &other) override
Additional check for whether fields of derived iterators are equal.
Definition: sub_grid.cpp:88
SubGrid begin() const override
Helper function for range-style iteration Equivalent to the above constructor.
Definition: sub_grid.cpp:68
GenericIndex< unsigned int > Index
SubGrid end() const override
Helper function for range-style iteration.
Definition: sub_grid.cpp:73
SubGrid(const nav_grid::NavGridInfo *info, const nav_grid::Index &index, const nav_core2::UIntBounds &bounds)
Public constructor using UIntBounds object that takes in an arbitrary index.
Definition: sub_grid.h:88
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:58


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