Statistics
| Branch: | Revision:

scoutos / scout / libscout / src / Behavior.cpp @ 93cebb99

History | View | Annotate | Download (3.33 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
 * @defgroup behavior Behavior
37
 * @brief Functions which are accessible by all behaviors.
38
 *
39
 * @{
40
 **/
41

    
42
#include "Behavior.h"
43

    
44
using namespace std;
45

    
46
bool Behavior::keep_running;
47

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

    
68
    loop_rate = new ros::Rate(10);
69
}
70

    
71
/**
72
 * Cleans up after a behavior is killed.
73
 */
74
Behavior::~Behavior()
75
{
76
  motors->set_sides(0, 0, MOTOR_ABSOLUTE);
77
  spinOnce();
78
  delete wl_receiver;
79
  delete loop_rate;
80
}
81

    
82
/**
83
 * Empty callback used as default callback for wireless receiver.
84
 */
85
void Behavior::default_callback(vector<uint8_t> data)
86
{
87
  return;
88
}
89

    
90
/**
91
 * Allows the behavior to check ros::ok(), without being aware of ROS.
92
 */
93
bool Behavior::ok()
94
{
95
    return keep_running;
96
}
97

    
98
/**
99
 * Allows the behavior to call ros::spin(), without being aware of ROS.
100
 */
101
void Behavior::spin()
102
{
103
    ros::spin();
104
    return;
105
}
106

    
107
/**
108
 * Allows the behavior to call ros::spinOnce(), without being aware of ROS.
109
 */
110
void Behavior::spinOnce()
111
{
112
    ros::spinOnce();
113
    return;
114
}
115

    
116
/**
117
 * Calls ros::spinOnce() in a loop until the duration is up.
118
 */
119
void Behavior::wait(float duration)
120
{
121
    ros::Rate r(WAIT_HZ);
122
    int ticks = int(duration * WAIT_HZ);
123
    for (int i = 0; i < ticks; i++)
124
    {
125
        spinOnce();
126
        r.sleep();
127
    }
128
}
129

    
130
/** @} */