Revision 3a73516c
Added doxygen documentation to many files.
scout/buttons/src/buttons.cpp | ||
---|---|---|
27 | 27 |
* @file buttons.cpp |
28 | 28 |
* @brief Contains code to control the buttons. |
29 | 29 |
* |
30 |
* @defgroup buttons Buttons |
|
31 |
* @brief Functions for using the buttons |
|
32 |
* |
|
30 | 33 |
* @author Colony Project, CMU Robotics Club |
31 | 34 |
* @author Priyanka Deo |
32 | 35 |
* @author Alex Zirbel |
33 | 36 |
* |
34 |
* @defgroup buttons Buttons |
|
35 |
* @brief Functions for using the buttons |
|
36 |
* |
|
37 | 37 |
* @{ |
38 | 38 |
**/ |
39 | 39 |
|
scout/encoders/src/encoders.cpp | ||
---|---|---|
27 | 27 |
* @file encoders.cpp |
28 | 28 |
* @brief Encoders |
29 | 29 |
* |
30 |
* Implementation of functions for encoder use. |
|
30 |
* @defgroup encoders Encoders |
|
31 |
* @brief Functions for using the encoders |
|
31 | 32 |
* |
32 | 33 |
* @author Colony Project, CMU Robotics Club |
33 | 34 |
* @author Alex Zirbel |
34 | 35 |
* @author Tom Mullins |
35 | 36 |
|
36 |
* @defgroup encoders Encoders |
|
37 |
* @brief Functions for using the encoders |
|
38 |
* |
|
39 | 37 |
* @{ |
40 | 38 |
**/ |
41 | 39 |
|
scout/libscout/src/Behavior.cpp | ||
---|---|---|
32 | 32 |
* @author Colony Project, CMU Robotics Club |
33 | 33 |
* @author Priyanka Deo |
34 | 34 |
* @author Alex Zirbel |
35 |
* |
|
36 |
* @defgroup behavior Behavior |
|
37 |
* @brief Functions which are accessible by all behaviors. |
|
38 |
* |
|
39 |
* @{ |
|
35 | 40 |
**/ |
36 | 41 |
|
37 | 42 |
#include "Behavior.h" |
... | ... | |
120 | 125 |
r.sleep(); |
121 | 126 |
} |
122 | 127 |
} |
128 |
|
|
129 |
/** @} */ |
scout/libscout/src/ButtonControl.cpp | ||
---|---|---|
28 | 28 |
* @file ButtonControl.cpp |
29 | 29 |
* @brief Contains buttons declarations and functions |
30 | 30 |
* |
31 |
* Contains functions and definitions for the use of |
|
32 |
* buttons |
|
31 |
* @defgroup buttoncontrol ButtonControl |
|
32 |
* @brief Functions which a behavior can use to control the buttons. |
|
33 |
* @ingroup behavior |
|
33 | 34 |
* |
34 | 35 |
* @author Colony Project, CMU Robotics Club |
35 | 36 |
* @author Priyanka Deo |
36 | 37 |
* @author Leon Zhang |
37 | 38 |
* @author Alex Zirbel |
39 |
* |
|
40 |
* @{ |
|
38 | 41 |
**/ |
39 | 42 |
|
40 | 43 |
#include "ButtonControl.h" |
... | ... | |
85 | 88 |
{ |
86 | 89 |
return button2_value; |
87 | 90 |
} |
91 |
|
|
92 |
/** @} */ |
scout/libscout/src/CliffsensorControl.cpp | ||
---|---|---|
27 | 27 |
* @file CliffsensorControl.cpp |
28 | 28 |
* @brief Contains code to control the cliffsensor. |
29 | 29 |
* |
30 |
* Implementation of functions for cliffsensor use. |
|
30 |
* @defgroup motorcontrol MotorControl |
|
31 |
* @brief Functions which a behavior can use to control the motors. |
|
32 |
* @ingroup behavior |
|
31 | 33 |
* |
32 | 34 |
* @author Colony Project, CMU Robotics Club |
33 | 35 |
* @author Priyanka Deo |
34 | 36 |
* @author Leon Zhang |
37 |
* |
|
38 |
* @{ |
|
35 | 39 |
**/ |
36 | 40 |
|
37 | 41 |
#include "ros/ros.h" |
... | ... | |
107 | 111 |
{ |
108 | 112 |
return (front_raw || left_raw || right_raw); |
109 | 113 |
} |
114 |
|
|
115 |
/** @} */ |
scout/libscout/src/EncodersControl.cpp | ||
---|---|---|
26 | 26 |
/** |
27 | 27 |
* @file EncodersControl.cpp |
28 | 28 |
* @brief Contains encoder function implementation |
29 |
* |
|
30 |
* @defgroup encoderscontrol EncodersControl |
|
31 |
* @brief Functions which a behavior can use to control the encoders. |
|
32 |
* @ingroup behavior |
|
29 | 33 |
* |
30 | 34 |
* @author Colony Project, CMU Robotics Club |
31 | 35 |
* @author Alex Zirbel |
... | ... | |
82 | 86 |
ROS_ERROR("EncodersControl reset failed."); |
83 | 87 |
} |
84 | 88 |
} |
89 |
|
|
90 |
/** @} */ |
scout/libscout/src/HeadlightControl.cpp | ||
---|---|---|
27 | 27 |
* @file HeadlightControl.cpp |
28 | 28 |
* @brief Contains headlights declarations and functions |
29 | 29 |
* |
30 |
* Contains functions and definitions for the use of |
|
31 |
* headlights |
|
30 |
* @defgroup headlightcontrol HeadlightControl |
|
31 |
* @brief Functions which a behavior can use to control the headlights. |
|
32 |
* @ingroup behavior |
|
32 | 33 |
* |
33 | 34 |
* @author Colony Project, CMU Robotics Club |
34 | 35 |
* @author Ben Wasserman |
... | ... | |
116 | 117 |
set_headlights_pub.publish(msg); |
117 | 118 |
ros::spinOnce(); |
118 | 119 |
} |
120 |
|
|
121 |
/** @} */ |
scout/libscout/src/LinesensorControl.cpp | ||
---|---|---|
26 | 26 |
/** |
27 | 27 |
* @file LinesensorControl.cpp |
28 | 28 |
* @brief Contains line following function implementation |
29 |
* |
|
30 |
* @defgroup linesensorcontrol LinesensorControl |
|
31 |
* @brief Functions which a behavior can use to control the line sensor. |
|
32 |
* @ingroup behavior |
|
29 | 33 |
* |
30 | 34 |
* @author Colony Project, CMU Robotics Club |
31 | 35 |
* @author Alex Zirbel |
36 |
* |
|
37 |
* @{ |
|
32 | 38 |
*/ |
33 | 39 |
|
34 | 40 |
#include "LinesensorControl.h" |
... | ... | |
148 | 154 |
} |
149 | 155 |
return false; |
150 | 156 |
} |
157 |
|
|
158 |
/** @} */ |
scout/libscout/src/MotorControl.cpp | ||
---|---|---|
27 | 27 |
* @file MotorControl.cpp |
28 | 28 |
* @brief Contains motor declarations and functions |
29 | 29 |
* |
30 |
* Contains functions and definitions for the use of |
|
31 |
* motors |
|
30 |
* @defgroup motorcontrol MotorControl |
|
31 |
* @brief Functions which a behavior can use to control the motors. |
|
32 |
* @ingroup behavior |
|
32 | 33 |
* |
33 | 34 |
* @author Colony Project, CMU Robotics Club |
34 | 35 |
* @author Ben Wasserman |
35 | 36 |
* @author Alex Zirbel |
37 |
* |
|
38 |
* @{ |
|
36 | 39 |
**/ |
37 | 40 |
|
38 | 41 |
#include "MotorControl.h" |
... | ... | |
298 | 301 |
return abs_speed; |
299 | 302 |
} |
300 | 303 |
} |
304 |
|
|
305 |
/** @} */ |
scout/libscout/src/SonarControl.cpp | ||
---|---|---|
27 | 27 |
* @file SonarControl.cpp |
28 | 28 |
* @brief Contains sonar function implementation |
29 | 29 |
* |
30 |
* Contains functions for the use of sonar control. |
|
30 |
* @defgroup sonarcontrol SonarControl |
|
31 |
* @brief Functions which a behavior can use to control the sonar. |
|
32 |
* @ingroup behavior |
|
31 | 33 |
* |
32 | 34 |
* @author Colony Project, CMU Robotics Club |
33 | 35 |
* @author Priyanka Deo |
34 | 36 |
* @author Alex Zirbel |
37 |
* |
|
38 |
* @{ |
|
35 | 39 |
**/ |
36 | 40 |
|
37 | 41 |
#include "SonarControl.h" |
... | ... | |
220 | 224 |
//TODO implement later based on sonar readings |
221 | 225 |
// return distance; |
222 | 226 |
//} |
227 |
|
|
228 |
/** @} */ |
scout/libscout/src/WirelessReceiver.cpp | ||
---|---|---|
28 | 28 |
* @file WirelessReceiver.cpp |
29 | 29 |
* @brief Contains wireless declarations and functions |
30 | 30 |
* |
31 |
* Contains functions and definitions for the use of |
|
32 |
* XBee wireless |
|
31 |
* @defgroup wirelessreceiver WirelessReceiver |
|
32 |
* @brief Contains functions and definitions for the use of XBee wireless |
|
33 |
* @ingroup behavior |
|
33 | 34 |
* |
34 | 35 |
* @author Colony Project, CMU Robotics Club |
35 | 36 |
* @author Tom Mullins |
37 |
* |
|
38 |
* @{ |
|
36 | 39 |
**/ |
37 | 40 |
|
38 | 41 |
#include "WirelessReceiver.h" |
... | ... | |
79 | 82 |
void WirelessReceiver::dummy(std::vector<uint8_t> data) { |
80 | 83 |
ROS_WARN("Warning: Ignored wireless packet."); |
81 | 84 |
} |
85 |
|
|
86 |
/** @} */ |
scout/libscout/src/WirelessSender.cpp | ||
---|---|---|
23 | 23 |
* OTHER DEALINGS IN THE SOFTWARE. |
24 | 24 |
*/ |
25 | 25 |
|
26 |
|
|
27 | 26 |
/** |
28 | 27 |
* @file WirelessSender.cpp |
29 | 28 |
* @brief Contains wireless declarations and functions |
30 | 29 |
* |
31 |
* Contains functions and definitions for the use of |
|
32 |
* XBee wireless |
|
30 |
* @defgroup wirelesssender WirelessSender |
|
31 |
* @brief Contains functions and definitions for the use of XBee wireless |
|
32 |
* @ingroup behavior |
|
33 | 33 |
* |
34 | 34 |
* @author Colony Project, CMU Robotics Club |
35 | 35 |
* @author Tom Mullins |
36 |
* |
|
37 |
* @{ |
|
36 | 38 |
**/ |
37 | 39 |
|
38 | 40 |
#include "WirelessSender.h" |
... | ... | |
81 | 83 |
packet.data = data; |
82 | 84 |
pub.publish(packet); |
83 | 85 |
} |
86 |
|
|
87 |
/** @} */ |
scout/libscout/src/test_behaviors/danger_marking.cpp | ||
---|---|---|
26 | 26 |
#include "danger_marking.h" |
27 | 27 |
|
28 | 28 |
#define THRESH 200 |
29 |
#define min(x,y) ((x < y) ? x : y) |
|
29 | 30 |
|
30 | 31 |
using namespace std; |
31 | 32 |
|
... | ... | |
45 | 46 |
while (true) |
46 | 47 |
{ |
47 | 48 |
int *readings = sonar->get_sonar_readings(); |
48 |
dist = readings[36];
|
|
49 |
dist = min(readings[35], min(readings[36], readings[37]));
|
|
49 | 50 |
|
50 | 51 |
ROS_INFO("Dist: %d.", dist); |
51 | 52 |
|
scout/motors/src/motors.cpp | ||
---|---|---|
27 | 27 |
* @file motors.cpp |
28 | 28 |
* @brief Contains code to control the motors. |
29 | 29 |
* |
30 |
* Implementation of functions for motor use. |
|
30 |
* @defgroup motors Motors |
|
31 |
* @brief Functions for using the motors |
|
31 | 32 |
* |
32 | 33 |
* @author Colony Project, CMU Robotics Club |
33 | 34 |
* @author Ben Wasserman |
34 | 35 |
* @author Tom Mullins |
35 |
|
|
36 |
* @defgroup motors Motors |
|
37 |
* @brief Functions for using the motors |
|
38 | 36 |
* |
39 | 37 |
* @{ |
40 | 38 |
*/ |
scout/power/src/power.cpp | ||
---|---|---|
27 | 27 |
* @file power.cpp |
28 | 28 |
* @brief Contains code to monitor and regulate power systems |
29 | 29 |
* |
30 |
* Implementation of power monitor and control |
|
30 |
* @defgroup power Power |
|
31 |
* @brief Functions for monitoring and regulating the power systems |
|
31 | 32 |
* |
32 | 33 |
* @author Colony Project, CMU Robotics Club |
33 | 34 |
* @author Jeff Cooper |
34 |
|
|
35 |
* @defgroup power Power |
|
36 |
* @brief Functions for monitoring and regulating the power systems |
|
37 | 35 |
* |
38 | 36 |
* @{ |
39 | 37 |
**/ |
scout/scoutsim/src/ghost_scout.cpp | ||
---|---|---|
45 | 45 |
* OTHER DEALINGS IN THE SOFTWARE. |
46 | 46 |
*/ |
47 | 47 |
|
48 |
/** |
|
49 |
* @file ghost_scout.cpp |
|
50 |
* |
|
51 |
* @ingroup scoutsim |
|
52 |
* @{ |
|
53 |
*/ |
|
54 |
|
|
48 | 55 |
#include "ghost_scout.h" |
49 | 56 |
|
50 | 57 |
#include <wx/wx.h> |
... | ... | |
157 | 164 |
is_visible = vis; |
158 | 165 |
} |
159 | 166 |
} |
167 |
|
|
168 |
/** @} */ |
scout/scoutsim/src/noise_gen.cpp | ||
---|---|---|
27 | 27 |
* @file noise_gen.c |
28 | 28 |
* @brief Contains functions that generate noise for scoutsim sensor data |
29 | 29 |
* |
30 |
* @ingroup scoutsim |
|
31 |
* |
|
30 | 32 |
* Uses central limit theorem to generate gaussian noise. |
31 | 33 |
* |
32 | 34 |
* @author Colony Project, CMU Robotics Club |
33 | 35 |
* @author Priyanka Deo |
36 |
* @{ |
|
34 | 37 |
**/ |
35 | 38 |
|
36 | 39 |
#include "noise_gen.h" |
... | ... | |
66 | 69 |
sum *= 2.0/(float)n; |
67 | 70 |
return sum; |
68 | 71 |
} |
72 |
|
|
73 |
/** @} */ |
scout/scoutsim/src/scout.cpp | ||
---|---|---|
45 | 45 |
* OTHER DEALINGS IN THE SOFTWARE. |
46 | 46 |
*/ |
47 | 47 |
|
48 |
/** |
|
49 |
* @file scout.cpp |
|
50 |
* |
|
51 |
* @ingroup scoutsim |
|
52 |
* @{ |
|
53 |
*/ |
|
54 |
|
|
48 | 55 |
#include "scout.h" |
49 | 56 |
|
50 | 57 |
#include <wx/wx.h> |
... | ... | |
57 | 64 |
|
58 | 65 |
namespace scoutsim |
59 | 66 |
{ |
67 |
/** |
|
68 |
* The scout object, which is responsible for refreshing itself and |
|
69 |
* updating its position and simulated sensors. |
|
70 |
* |
|
71 |
* @ingroup scoutsim |
|
72 |
*/ |
|
60 | 73 |
Scout::Scout(const ros::NodeHandle& nh, |
61 | 74 |
const wxImage& scout_image, |
62 | 75 |
const Vector2& pos, |
... | ... | |
559 | 572 |
sonar_visual_on = on; |
560 | 573 |
} |
561 | 574 |
} |
575 |
|
|
576 |
/** @} */ |
scout/scoutsim/src/scout_constants.h | ||
---|---|---|
45 | 45 |
* OTHER DEALINGS IN THE SOFTWARE. |
46 | 46 |
*/ |
47 | 47 |
|
48 |
/** |
|
49 |
* @file scout_constants.h |
|
50 |
* |
|
51 |
* @ingroup scoutsim |
|
52 |
* @{ |
|
53 |
*/ |
|
54 |
|
|
48 | 55 |
#ifndef _SCOUTSIM_SCOUT_CONSTANTS_ |
49 | 56 |
#define _SCOUTSIM_SCOUT_CONSTANTS_ |
50 | 57 |
|
... | ... | |
91 | 98 |
} |
92 | 99 |
|
93 | 100 |
#endif |
101 |
|
|
102 |
/** @} */ |
scout/scoutsim/src/scoutsim.cpp | ||
---|---|---|
43 | 43 |
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
44 | 44 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
45 | 45 |
* OTHER DEALINGS IN THE SOFTWARE. |
46 |
* |
|
47 |
* @defgroup scoutsim Scoutsim |
|
48 |
* @{ |
|
46 | 49 |
*/ |
47 | 50 |
|
48 | 51 |
#include <wx/app.h> |
... | ... | |
139 | 142 |
|
140 | 143 |
DECLARE_APP(ScoutApp); |
141 | 144 |
IMPLEMENT_APP(ScoutApp); |
145 |
|
|
146 |
/** @} */ |
scout/scoutsim/src/scoutsim_internal.h | ||
---|---|---|
1 |
/** |
|
2 |
* @file scoutsim_internal.h |
|
3 |
* |
|
4 |
* @ingroup scoutsim |
|
5 |
* @{ |
|
6 |
*/ |
|
1 | 7 |
|
2 | 8 |
#ifndef _SCOUTSIM_INTERNAL_ |
3 | 9 |
#define _SCOUTSIM_INTERNAL_ |
... | ... | |
15 | 21 |
} world_state; |
16 | 22 |
|
17 | 23 |
#endif /* _SCOUTSIM_INTERNAL_ */ |
24 |
|
|
25 |
/** @} */ |
scout/scoutsim/src/sim_frame.cpp | ||
---|---|---|
45 | 45 |
* OTHER DEALINGS IN THE SOFTWARE. |
46 | 46 |
*/ |
47 | 47 |
|
48 |
/** |
|
49 |
* @file sim_frame.cpp |
|
50 |
* |
|
51 |
* @ingroup scoutsim |
|
52 |
* @{ |
|
53 |
*/ |
|
54 |
|
|
48 | 55 |
#include "sim_frame.h" |
49 | 56 |
|
50 | 57 |
#include <stdio.h> |
... | ... | |
611 | 618 |
wireless_receive.publish(msg); |
612 | 619 |
} |
613 | 620 |
} |
621 |
|
|
622 |
/** @} */ |
Also available in: Unified diff