Statistics
| Branch: | Revision:

root / scout / libscout / src / ButtonControl.cpp @ 6ebee82c

History | View | Annotate | Download (2.55 KB)

1 42e8c915 Leon
/**
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 c492be62 Alex Zirbel
 */
25 42e8c915 Leon
26
27
/**
28
 * @file ButtonControl.cpp
29
 * @brief Contains buttons declarations and functions
30
 * 
31
 * Contains functions and definitions for the use of
32
 * buttons
33
 *
34
 * @author Colony Project, CMU Robotics Club
35
 * @author Priyanka Deo
36
 * @author Leon Zhang
37 b00761a0 Alex Zirbel
 * @author Alex Zirbel
38 42e8c915 Leon
 **/
39
40
#include "ButtonControl.h"
41
42 b00761a0 Alex Zirbel
using namespace std;
43
44
/**
45 42e8c915 Leon
 * @brief Initialize the buttons module of libscout.
46
 *
47
 * Initialize the libscout node as a subscriber of button_event
48
 */
49 b00761a0 Alex Zirbel
ButtonControl::ButtonControl(const ros::NodeHandle& libscout_node,
50
                             string scoutname)
51
    : node(libscout_node)
52 42e8c915 Leon
{
53 b00761a0 Alex Zirbel
    button_event_sub = node.subscribe(scoutname + "/button_event",
54
                                      QUEUE_SIZE,
55
                                      &ButtonControl::event_callback,
56
                                      this);
57 42e8c915 Leon
}
58
59 b00761a0 Alex Zirbel
/**
60 42e8c915 Leon
 * @brief Respond to button events
61
 * Processes message and updates private variables
62
 */
63 6ebee82c Alex
void ButtonControl::event_callback(const ::messages::button_event::ConstPtr& msg)
64 42e8c915 Leon
{
65 b00761a0 Alex Zirbel
    button1_value = msg->button1_pressed;
66
    button2_value = msg->button2_pressed;
67 42e8c915 Leon
}
68
69
/**
70 b00761a0 Alex Zirbel
 * @brief check if button 1 is currently being pressed
71
 * 
72
 * @return true if button is pressed, otherwise false
73
 */
74 42e8c915 Leon
bool ButtonControl::button1_is_pressed()
75
{
76
    return button1_value;
77
}
78
79
/**
80 b00761a0 Alex Zirbel
 * @brief check if button 2 is currently being pressed
81
 * 
82
 * @return true if button is pressed, otherwise false
83
 */
84 42e8c915 Leon
bool ButtonControl::button2_is_pressed()
85
{ 
86
    return button2_value;
87
}