root / scout / libscout / src / ButtonControl.cpp @ c492be62
History | View | Annotate | Download (2.4 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 |
/**
|
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 |
**/
|
38 |
|
39 |
#include "ButtonControl.h" |
40 |
|
41 |
/*!
|
42 |
* @brief Initialize the buttons module of libscout.
|
43 |
*
|
44 |
* Initialize the libscout node as a subscriber of button_event
|
45 |
*/
|
46 |
ButtonControl::ButtonControl(const ros::NodeHandle& libscout_node) : node(libscout_node)
|
47 |
{ |
48 |
button_event_sub = node.subscribe("button_event", QUEUE_SIZE, event_button);
|
49 |
} |
50 |
|
51 |
/*!*
|
52 |
* @brief Respond to button events
|
53 |
* Sends out button events if buttons are pressed.
|
54 |
* Processes message and updates private variables
|
55 |
*
|
56 |
* @param subscription to button_event message
|
57 |
*/
|
58 |
void ButtonControl::event_button(const buttons::button_event::ConstPtr& msg) |
59 |
{ |
60 |
button1_pressed = msg.button1_pressed; |
61 |
button2_pressed = msg.button2_pressed; |
62 |
} |
63 |
|
64 |
/**
|
65 |
*@brief check if button 1 is currently being pressed
|
66 |
*
|
67 |
*@return true if button is pressed, otherwise false
|
68 |
*/
|
69 |
bool ButtonControl::button1_is_pressed()
|
70 |
{ |
71 |
return button1_value;
|
72 |
} |
73 |
|
74 |
/**
|
75 |
*@brief check if button 2 is currently being pressed
|
76 |
*
|
77 |
*@return true if button is pressed, otherwise false
|
78 |
*/
|
79 |
bool ButtonControl::button2_is_pressed()
|
80 |
{ |
81 |
return button2_value;
|
82 |
} |