Revision 7db6cf9f
Changed all TODO and @TODO to @todo to conform to doxygen.
scout/libscout/launch/helper_nodes.launch | ||
---|---|---|
1 | 1 |
<launch> |
2 | 2 |
<node name="motors" pkg="motors" type="motors_node" /> |
3 | 3 |
<node name="encoders" pkg="encoders" type="encoders_node" /> |
4 |
<!-- TODO add more -->
|
|
4 |
<!-- @todo add more -->
|
|
5 | 5 |
</launch> |
scout/libscout/launch/rosscout.launch | ||
---|---|---|
7 | 7 |
<launch> |
8 | 8 |
<include file="$(find scout_avr)/launch/rosserial.launch" /> |
9 | 9 |
<include file="$(find libscout)/launch/helper_nodes.launch" /> |
10 |
<!-- TODO launch a top-level libscout behavior -->
|
|
10 |
<!-- @todo launch a top-level libscout behavior -->
|
|
11 | 11 |
</launch> |
scout/libscout/src/MotorControl.cpp | ||
---|---|---|
215 | 215 |
* Sends a request to the query_motors service which will reply with the |
216 | 216 |
* current speed of each motor. |
217 | 217 |
* |
218 |
* @TODO Change so we can get multiple motor speeds with one call
|
|
218 |
* @todo Change so we can get multiple motor speeds with one call
|
|
219 | 219 |
* |
220 | 220 |
* @param which A bitmask that will specify which motor speed should be |
221 | 221 |
* returned |
scout/libscout/src/SonarControl.cpp | ||
---|---|---|
208 | 208 |
**/ |
209 | 209 |
//float sonar_to_dist(float sonar_value) |
210 | 210 |
//{ |
211 |
//TODO impelement later based on sonar readings
|
|
211 |
//@todo impelement later based on sonar readings
|
|
212 | 212 |
// return sonar_value; |
213 | 213 |
//} |
214 | 214 |
|
... | ... | |
220 | 220 |
**/ |
221 | 221 |
//float dist_to_sonar(float distance) |
222 | 222 |
//{ |
223 |
//TODO implement later based on sonar readings
|
|
223 |
//@todo implement later based on sonar readings
|
|
224 | 224 |
// return distance; |
225 | 225 |
//} |
scout/libscout/src/behaviors/navigationMap.cpp | ||
---|---|---|
219 | 219 |
//sets the current state to the state associated with the turn made |
220 | 220 |
if(GET_EDGE_DIR(possible_edges[i]) == turn_made) |
221 | 221 |
{ |
222 |
//TODO: get actual speed
|
|
222 |
//@todo: get actual speed
|
|
223 | 223 |
int speed = 10; |
224 | 224 |
curr_state = GET_EDGE_STATE(possible_edges[i]); |
225 | 225 |
Duration travel_time(GET_EDGE_DIST(possible_edges[i])/speed); |
scout/libscout/src/helper_classes/PQWrapper.cpp | ||
---|---|---|
69 | 69 |
/** @Brief: Remove and return an Order from the array if 0 <= index < arrContents. */ |
70 | 70 |
Order PQWrapper::remove(unsigned int index) |
71 | 71 |
{ |
72 |
if (index >= arrContents) return minElems[-1];//TODO: can I return null?
|
|
72 |
if (index >= arrContents) return minElems[-1];// @todo: can I return null?
|
|
73 | 73 |
Order toDelete = minElems[index]; |
74 | 74 |
for (unsigned int i = index; i < arrContents - 1; i++) |
75 | 75 |
{ |
... | ... | |
92 | 92 |
{ |
93 | 93 |
if (index >= arrContents) |
94 | 94 |
{ |
95 |
return minElems[-1];//TODO: can I return null?
|
|
95 |
return minElems[-1];// @todo: can I return null?
|
|
96 | 96 |
} |
97 | 97 |
else |
98 | 98 |
{ |
scout/libscout/src/test_behaviors/Scheduler.cpp | ||
---|---|---|
100 | 100 |
|
101 | 101 |
Time end_time = order.get_start_time() - order.get_est_time(); |
102 | 102 |
|
103 |
if(end_time.toSec() + MAX_WAIT_TIME < time) //TODO: use another function
|
|
103 |
if(end_time.toSec() + MAX_WAIT_TIME < time) //@todo: use another function
|
|
104 | 104 |
{ |
105 | 105 |
//best = ℴ |
106 | 106 |
best_index = i; |
scout/libscout/src/test_behaviors/WH_Robot.cpp | ||
---|---|---|
124 | 124 |
|
125 | 125 |
follow_path(new_path); |
126 | 126 |
|
127 |
//TODO: forklift yaaaay
|
|
127 |
//@todo: forklift yaaaay
|
|
128 | 128 |
|
129 | 129 |
int did_task_complete; |
130 | 130 |
|
scout/libscout/src/test_behaviors/maze_solve.cpp | ||
---|---|---|
44 | 44 |
#define LEFT 3 |
45 | 45 |
#define WALL_LIMIT 500 |
46 | 46 |
|
47 |
// TODO This is bad! It's defined globally across all files. Please put it inside a good scope. -Alex
|
|
47 |
// @todo This is bad! It's defined globally across all files. Please put it inside a good scope. -Alex
|
|
48 | 48 |
Duration sonar_update_time(1.5); |
49 | 49 |
|
50 | 50 |
void maze_solve::run() |
51 | 51 |
{ |
52 |
// TODO:first initialize map to all 0's
|
|
52 |
// @todo:first initialize map to all 0's
|
|
53 | 53 |
ROS_INFO("Starting to solve the maze"); |
54 | 54 |
// Go up to the first line. |
55 | 55 |
follow_line(); |
scout/libscout/src/test_behaviors/smart_runaround.cpp | ||
---|---|---|
76 | 76 |
return output; |
77 | 77 |
} |
78 | 78 |
|
79 |
// TODO This is bad! It's defined globally across all behaviors. Please fix this. -Alex
|
|
79 |
// @todo This is bad! It's defined globally across all behaviors. Please fix this. -Alex
|
|
80 | 80 |
Duration sonar_update_time2(1.5); |
81 | 81 |
|
82 | 82 |
// THIS VERSION MODIFIED BY ZANE |
... | ... | |
152 | 152 |
* and turns the scout to the intended direction |
153 | 153 |
*/ |
154 | 154 |
void smart_runaround::turn_from_to(int current_dir, int intended_dir) { |
155 |
switch ((4 + intended_dir - current_dir) % 4) // TODO: Try without "4 +" at start
|
|
155 |
switch ((4 + intended_dir - current_dir) % 4) // @todo: Try without "4 +" at start
|
|
156 | 156 |
{ |
157 | 157 |
case 0: |
158 | 158 |
turn_straight(intended_dir); |
... | ... | |
274 | 274 |
return true; |
275 | 275 |
} |
276 | 276 |
|
277 |
// TODO: test this function
|
|
277 |
// @todo: test this function
|
|
278 | 278 |
// return true iff the map has been completely explored |
279 | 279 |
// and only true if it "returned" to home destination after solving |
280 | 280 |
bool smart_runaround::at_destination() |
... | ... | |
306 | 306 |
return false; |
307 | 307 |
} |
308 | 308 |
|
309 |
// TODO: test these functions to make sure robot moves well
|
|
309 |
// @todo: test these functions to make sure robot moves well
|
|
310 | 310 |
// move forward one block in direction "dir" |
311 | 311 |
void smart_runaround::turn_straight(int dir) |
312 | 312 |
{ |
313 |
// TODO: try to use motor encoder values to move forward enough
|
|
313 |
// @todo: try to use motor encoder values to move forward enough
|
|
314 | 314 |
motors->set_sides(BASESPEED, BASESPEED, MOTOR_ABSOLUTE); |
315 | 315 |
spinOnce(); |
316 | 316 |
Duration moveTime(1.0); |
scout/messages/msg/bom.msg | ||
---|---|---|
2 | 2 |
int8 send_dir |
3 | 3 |
int8 recv_dir |
4 | 4 |
|
5 |
# TODO these may need to be changed
|
|
5 |
# @todo these may need to be changed
|
|
6 | 6 |
int8 FRONT = 0 |
7 | 7 |
int8 LEFT = 1 |
8 | 8 |
int8 BACK = 2 |
scout/painter/src/paint-i2c.cpp | ||
---|---|---|
67 | 67 |
* This function opens communication to I2C. |
68 | 68 |
*/ |
69 | 69 |
void i2c_start(void) { |
70 |
/* TODO error check */
|
|
70 |
/* @todo error check */
|
|
71 | 71 |
fd = open("/dev/i2c-3", O_RDWR); |
72 | 72 |
ioctl(fd, I2C_SLAVE, TRACKING_ID); |
73 | 73 |
} |
scout/power/src/power.cpp | ||
---|---|---|
50 | 50 |
|
51 | 51 |
/** @todo Fix types: static */ |
52 | 52 |
|
53 |
/** @TODO figure out if we can get things like the current draw from the AVR. */
|
|
54 |
/** @TODO More generally, figure out how we get info from the AVR (avrbridge
|
|
53 |
/** @todo figure out if we can get things like the current draw from the AVR. */
|
|
54 |
/** @todo More generally, figure out how we get info from the AVR (avrbridge
|
|
55 | 55 |
* node?) */ |
56 | 56 |
|
57 | 57 |
uint32_t voltage; /**< the current voltage */ |
58 | 58 |
uint32_t percentage; /**< current percentage of power remaining */ |
59 | 59 |
uint32_t draw; /**< the current draw in mW */ |
60 |
/** @TODO: figure out if these have to be uint8_t's to play nice with ROS */
|
|
60 |
/** @todo: figure out if these have to be uint8_t's to play nice with ROS */
|
|
61 | 61 |
bool externalpower; /**< are we on external power? */ |
62 | 62 |
bool warning; /**< is the battery reporting a warning state? */ |
63 | 63 |
bool critical; /**< is the battery reporting a critical state? */ |
... | ... | |
85 | 85 |
} |
86 | 86 |
|
87 | 87 |
|
88 |
/** @TODO: implement a function to send a message about the power state when
|
|
88 |
/** @todo: implement a function to send a message about the power state when
|
|
89 | 89 |
* it's critical. can't do much with this until I have some way of reading the |
90 | 90 |
* power state from the AVR, I don't believe. */ |
91 | 91 |
|
scout/scoutsim/GUI.py | ||
---|---|---|
133 | 133 |
def terminateOldBehavior(self): |
134 | 134 |
if self.process != None: |
135 | 135 |
# now terminate the process |
136 |
self.process.kill() #TODO: this kills the process
|
|
136 |
self.process.kill() # @todo: this kills the process
|
|
137 | 137 |
# but maybe not the rosnode |
138 | 138 |
# change to "rosnode kill" instead |
139 | 139 |
# make sure old behavior is terminated before we run the new one |
scout/scoutsim/src/scout.cpp | ||
---|---|---|
418 | 418 |
|
419 | 419 |
/// Sends back the position of this scout so scoutsim can save |
420 | 420 |
/// the world state |
421 |
/// TODO remove dt param
|
|
421 |
/// @todo remove dt param
|
|
422 | 422 |
geometry_msgs::Pose2D Scout::update(double dt, wxMemoryDC& path_dc, |
423 | 423 |
wxMemoryDC& sonar_dc, |
424 | 424 |
const wxImage& path_image, |
scout/scoutsim/src/scout_constants.h | ||
---|---|---|
50 | 50 |
|
51 | 51 |
#include <messages/set_motors.h> |
52 | 52 |
|
53 |
/// TODO put these in a utility file somewhere?
|
|
53 |
/// @todo put these in a utility file somewhere?
|
|
54 | 54 |
#define min(x,y) ((x < y) ? x : y) |
55 | 55 |
#define max(x,y) ((x > y) ? x : y) |
56 | 56 |
|
Also available in: Unified diff