Project

General

Profile

Statistics
| Branch: | Revision:

root / scout / scoutsim / src / scout.h @ 9b3564f3

History | View | Annotate | Download (5.11 KB)

1 c492be62 Alex Zirbel
/**
2
 * The code in this package was developed using the structure of Willow
3
 * Garage's turtlesim package.  It was modified by the CMU Robotics Club
4
 * to be used as a simulator for the Colony Scout robot.
5 266ae7f2 Alex Zirbel
 *
6 c492be62 Alex Zirbel
 * All redistribution of this code is limited to the terms of Willow Garage's
7
 * licensing terms, as well as under permission from the CMU Robotics Club.
8
 * 
9
 * Copyright (c) 2011 Colony Project
10
 * 
11
 * Permission is hereby granted, free of charge, to any person
12
 * obtaining a copy of this software and associated documentation
13
 * files (the "Software"), to deal in the Software without
14
 * restriction, including without limitation the rights to use,
15
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
16
 * copies of the Software, and to permit persons to whom the
17
 * Software is furnished to do so, subject to the following
18
 * conditions:
19
 * 
20
 * The above copyright notice and this permission notice shall be
21
 * included in all copies or substantial portions of the Software.
22
 * 
23
 * Copyright (c) 2009, Willow Garage, Inc.
24 266ae7f2 Alex Zirbel
 * All rights reserved.
25 c492be62 Alex Zirbel
 * 
26
 * Redistribution and use in source and binary forms, with or without
27
 * modification, are permitted provided that the following conditions are met:
28
 * 
29
 *    Redistributions of source code must retain the above copyright
30
 *       notice, this list of conditions and the following disclaimer.
31
 *    Redistributions in binary form must reproduce the above copyright
32
 *       notice, this list of conditions and the following disclaimer in the
33
 *       documentation and/or other materials provided with the distribution.
34
 *    Neither the name of the Willow Garage, Inc. nor the names of its
35
 *       contributors may be used to endorse or promote products derived from
36
 *       this software without specific prior written permission.
37
 * 
38
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
39
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
40
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
41
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
42
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
43
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
44
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
45
 * OTHER DEALINGS IN THE SOFTWARE.
46 266ae7f2 Alex Zirbel
 */
47
48 144137a1 Alex Zirbel
#ifndef _SCOUTSIM_SCOUT_H_
49
#define _SCOUTSIM_SCOUT_H_
50 266ae7f2 Alex Zirbel
51
#include <ros/ros.h>
52
#include <boost/shared_ptr.hpp>
53
54 a8480867 Alex Zirbel
#include <motors/set_motors.h>
55 9f547ef7 Alex Zirbel
#include <encoders/query_encoders.h>
56 a8480867 Alex Zirbel
57 266ae7f2 Alex Zirbel
#include <scoutsim/Pose.h>
58
#include <scoutsim/SetPen.h>
59
#include <scoutsim/Color.h>
60
61
#include <wx/wx.h>
62
63 94a3af93 Priya
//#include "scout_constants.h"
64 c492be62 Alex Zirbel
65 266ae7f2 Alex Zirbel
#define PI 3.14159265
66 c492be62 Alex Zirbel
67 144137a1 Alex Zirbel
/// The scale factor so the speed of scout robots is reasonable for the sim
68
#define SPEED_SCALE_FACTOR 0.05
69 266ae7f2 Alex Zirbel
70
namespace scoutsim
71
{
72
    struct Vector2
73
    {
74
        Vector2()
75
            : x(0.0)
76
              , y(0.0)
77
        {}
78
79 144137a1 Alex Zirbel
        Vector2(float new_x, float new_y)
80
            : x(new_x)
81
              , y(new_y)
82 266ae7f2 Alex Zirbel
        {}
83
84
        bool operator==(const Vector2& rhs)
85
        {
86
            return x == rhs.x && y == rhs.y;
87
        }
88
89
        bool operator!=(const Vector2& rhs)
90
        {
91
            return x != rhs.x || y != rhs.y;
92
        }
93
94
        float x;
95
        float y;
96
    };
97
98
    class Scout
99
    {
100
        public:
101
            Scout(const ros::NodeHandle& nh, const wxImage& scout_image,
102
                  const Vector2& pos, float orient);
103
104 9b3564f3 Alex Zirbel
            geometry_msgs::Pose2D update(double dt, wxMemoryDC& path_dc,
105
                                         const wxImage& path_image,
106
                                         wxColour background_color,
107
                                         world_state state);
108 266ae7f2 Alex Zirbel
            void paint(wxDC& dc);
109
110
        private:
111 a8480867 Alex Zirbel
            void setMotors(const motors::set_motors::ConstPtr& msg);
112 c492be62 Alex Zirbel
            float getSonar(float angle);
113 266ae7f2 Alex Zirbel
            bool setPenCallback(scoutsim::SetPen::Request&,
114
                                scoutsim::SetPen::Response&);
115 9f547ef7 Alex Zirbel
            bool query_encoders_callback(encoders::query_encoders::Request&,
116
                                         encoders::query_encoders::Response&);
117 266ae7f2 Alex Zirbel
118 144137a1 Alex Zirbel
            ros::NodeHandle node;
119 266ae7f2 Alex Zirbel
120 144137a1 Alex Zirbel
            wxImage scout_image;
121
            wxBitmap scout;
122 266ae7f2 Alex Zirbel
123 144137a1 Alex Zirbel
            Vector2 pos;
124
            float orient;
125 266ae7f2 Alex Zirbel
126 9f547ef7 Alex Zirbel
            /// @todo should these be an array or something?
127
128 a8480867 Alex Zirbel
            // Keep track of the last commanded speeds sent to the sim
129 144137a1 Alex Zirbel
            int motor_fl_speed;
130
            int motor_fr_speed;
131
            int motor_bl_speed;
132
            int motor_br_speed;
133 a8480867 Alex Zirbel
134 9f547ef7 Alex Zirbel
            // Keep track of encoder ticks for each motor
135
            unsigned int fl_ticks;
136
            unsigned int fr_ticks;
137
            unsigned int bl_ticks;
138
            unsigned int br_ticks;
139
140 c492be62 Alex Zirbel
            // Each scout has a unique id number, which is also displayed on its image.
141
            int scout_id;
142
143 144137a1 Alex Zirbel
            bool pen_on;
144
            wxPen pen;
145 266ae7f2 Alex Zirbel
146 144137a1 Alex Zirbel
            ros::Subscriber motors_sub;
147
            ros::Publisher pose_pub;
148
            ros::Publisher color_pub;
149
            ros::ServiceServer set_pen_srv;
150 9f547ef7 Alex Zirbel
            ros::ServiceServer query_encoders_srv;
151 266ae7f2 Alex Zirbel
152 144137a1 Alex Zirbel
            ros::WallTime last_command_time;
153 266ae7f2 Alex Zirbel
154 144137a1 Alex Zirbel
            float meter;
155 266ae7f2 Alex Zirbel
156
    };
157
    typedef boost::shared_ptr<Scout> ScoutPtr;
158
159 4612f7e4 Alex Zirbel
}
160 266ae7f2 Alex Zirbel
161
#endif