Statistics
| Branch: | Revision:

scoutos / scout / libscout / src / Behavior.cpp @ 4026134b

History | View | Annotate | Download (3.17 KB)

1
/**
2
 * Copyright (c) 2011 Colony Project
3
 * 
4
 * Permission is hereby granted, free of charge, to any person
5
 * obtaining a copy of this software and associated documentation
6
 * files (the "Software"), to deal in the Software without
7
 * restriction, including without limitation the rights to use,
8
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the
10
 * Software is furnished to do so, subject to the following
11
 * conditions:
12
 * 
13
 * The above copyright notice and this permission notice shall be
14
 * included in all copies or substantial portions of the Software.
15
 * 
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
18
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23
 * OTHER DEALINGS IN THE SOFTWARE.
24
 */
25

    
26
/**
27
 * @file Behavior.cpp
28
 * @brief Contains basic functions for the structure of all behaviors.
29
 * 
30
 * Contains function implementations needed for all behavior.
31
 *
32
 * @author Colony Project, CMU Robotics Club
33
 * @author Priyanka Deo
34
 * @author Alex Zirbel
35
 **/
36

    
37
#include "Behavior.h"
38

    
39
using namespace std;
40

    
41
bool Behavior::keep_running;
42

    
43
/**
44
 * Constructs a behavior and sets up all control classes.
45
 *
46
 * This constructor is used by all behaviors which inherit the Behavior
47
 * class, so that it is easy to create a behavior with access to ROS
48
 * functionality through the control classes.
49
 *
50
 * @param scoutname If nonempty, specifies which scout in the simulator
51
 *                  will be controlled by this behavior.
52
 */
53
Behavior::Behavior(string scoutname, string my_name, Sensors * sensors)
54
{
55
    name = my_name;
56
    keep_running = true;
57
    sensors->init(&motors, &buttons, &sonar, &encoders, &linesensor,
58
                        &wl_sender, &wl_receiver);
59
    wl_receiver->register_callback(std::bind(&Behavior::default_callback,
60
        this, std::placeholders::_1));
61

    
62
    loop_rate = new ros::Rate(10);
63
}
64

    
65
/**
66
 * Cleans up after a behavior is killed.
67
 */
68
Behavior::~Behavior()
69
{
70
  motors->set_sides(0, 0, MOTOR_ABSOLUTE);
71
  spinOnce();
72
  delete wl_receiver;
73
  delete loop_rate;
74
}
75

    
76
/**
77
 * Empty callback used as default callback for wireless receiver.
78
 */
79
void Behavior::default_callback(vector<uint8_t> data)
80
{
81
  return;
82
}
83

    
84
/**
85
 * Allows the behavior to check ros::ok(), without being aware of ROS.
86
 */
87
bool Behavior::ok()
88
{
89
    return keep_running;
90
}
91

    
92
/**
93
 * Allows the behavior to call ros::spin(), without being aware of ROS.
94
 */
95
void Behavior::spin()
96
{
97
    ros::spin();
98
    return;
99
}
100

    
101
/**
102
 * Allows the behavior to call ros::spinOnce(), without being aware of ROS.
103
 */
104
void Behavior::spinOnce()
105
{
106
    ros::spinOnce();
107
    return;
108
}
109

    
110
/**
111
 * Calls ros::spinOnce() in a loop until the duration is up.
112
 */
113
void Behavior::wait(float duration)
114
{
115
    ros::Rate r(WAIT_HZ);
116
    int ticks = int(duration * 100);
117
    for (int i = 0; i < ticks; i++)
118
    {
119
        spinOnce();
120
        r.sleep();
121
    }
122
}