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