MIRA
IgnoreInterval.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_IGNOREINTERVAL_H_
48 #define _MIRA_IGNOREINTERVAL_H_
49 
50 #include <math/Angle.h>
51 
52 #include <utils/IsCheapToCopy.h>
53 
54 namespace mira { namespace robot {
55 
57 
65 {
66 public:
69 
72 
78  IgnoreInterval(const SignedAnglef& iStart, const SignedAnglef& iEnd) :
79  start(iStart), end(iEnd) {}
80 
82  template<typename Reflector>
83  void reflect(Reflector& r)
84  {
85  r.property("Start", start, "Start of the interval [deg]");
86  r.property("End", end, "End of the interval [deg]");
87  }
88 
90 
91 public:
97  bool operator<(const IgnoreInterval& other) const
98  {
99  return start.rad() < other.start.rad();
100  }
101 
102 public:
105 
108 };
109 
111 
112 } // namespace robot
113 
114 template <>
115 class IsCheapToCopy<robot::IgnoreInterval> : public std::true_type {};
116 
118 
119 } // namespace mira
120 
121 #endif
SignedAnglef end
The end of the interval.
Definition: IgnoreInterval.h:107
Specifies an interval of start and end angle that will be ignored in a range scan.
Definition: IgnoreInterval.h:64
IgnoreInterval(const SignedAnglef &iStart, const SignedAnglef &iEnd)
Construct a new ignore interval given by start and end.
Definition: IgnoreInterval.h:78
IgnoreInterval()
The default constructor.
Definition: IgnoreInterval.h:71
bool operator<(const IgnoreInterval &other) const
The < operator.
Definition: IgnoreInterval.h:97
SignedAnglef start
The start of the interval.
Definition: IgnoreInterval.h:104
void reflect(Reflector &r)
The refect method.
Definition: IgnoreInterval.h:83