abstract_line_iterator.h
Go to the documentation of this file.
00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2018, Locus Robotics
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions
00009  *  are met:
00010  *
00011  *   * Redistributions of source code must retain the above copyright
00012  *     notice, this list of conditions and the following disclaimer.
00013  *   * Redistributions in binary form must reproduce the above
00014  *     copyright notice, this list of conditions and the following
00015  *     disclaimer in the documentation and/or other materials provided
00016  *     with the distribution.
00017  *   * Neither the name of the copyright holder nor the names of its
00018  *     contributors may be used to endorse or promote products derived
00019  *     from this software without specific prior written permission.
00020  *
00021  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025  *  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032  *  POSSIBILITY OF SUCH DAMAGE.
00033  */
00034 
00035 #ifndef NAV_GRID_ITERATORS_LINE_ABSTRACT_LINE_ITERATOR_H
00036 #define NAV_GRID_ITERATORS_LINE_ABSTRACT_LINE_ITERATOR_H
00037 
00038 #include <nav_grid/index.h>
00039 
00040 namespace nav_grid_iterators
00041 {
00048 class AbstractLineIterator
00049 {
00050 public:
00054   AbstractLineIterator() {}
00055 
00060   const nav_grid::SignedIndex& operator*() const { return index_; }
00061 
00062   virtual nav_grid::SignedIndex getFinalIndex() const = 0;
00063 
00064   bool isFinished()
00065   {
00066     return getFinalIndex() == index_;
00067   }
00068 
00072   virtual void increment() = 0;
00073 
00074 protected:
00078   explicit AbstractLineIterator(nav_grid::SignedIndex index) : index_(index) {}
00079   nav_grid::SignedIndex index_;
00080 };
00081 
00082 }  // namespace nav_grid_iterators
00083 
00084 #endif  // NAV_GRID_ITERATORS_LINE_ABSTRACT_LINE_ITERATOR_H


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