MIRA
MileageTask.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_MILEAGETASK_H_
48 #define _MIRA_MILEAGETASK_H_
49 
50 #include <navigation/Task.h>
51 
52 namespace mira { namespace navigation {
53 
55 
60 class MileageTask : public SubTask
61 {
62  MIRA_OBJECT(MileageTask);
63 public:
64 
67  mileage(0.0f) {}
68 
73  MileageTask(float m) :
74  mileage(m)
75  {}
76 
78  template<typename Reflector>
79  void reflect(Reflector& r)
80  {
82  r.property("Mileage", mileage, "The requested mileage.");
83  }
84 
85 public:
87  float mileage;
88 };
89 
91 
92 }}
93 
94 #endif
#define MIRA_REFLECT_BASE(reflector, BaseClass)
MileageTask(float m)
Constructs a mileage task with given mileage.
Definition: MileageTask.h:73
MileageTask()
Constructs a mileage task with mileage 0.
Definition: MileageTask.h:66
float mileage
The requested mileage.
Definition: MileageTask.h:87
Subtask that has purpose to drive at least a given mileage before the task is done.
Definition: MileageTask.h:60
Interface for sub tasks to be added to a navigation task.
Definition: Task.h:63
Base classes and interfaces for navigation tasks.
void reflect(Reflector &r)
The reflect method.
Definition: MileageTask.h:79