rclcpp
master
C++ ROS Client Library API
include
rclcpp
event.hpp
Go to the documentation of this file.
1
// Copyright 2016 Open Source Robotics Foundation, Inc.
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
// http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14
15
#ifndef RCLCPP__EVENT_HPP_
16
#define RCLCPP__EVENT_HPP_
17
18
#include <atomic>
19
#include <memory>
20
21
#include "
rclcpp/macros.hpp
"
22
#include "
rclcpp/visibility_control.hpp
"
23
24
namespace
rclcpp
25
{
26
27
class
Event
28
{
29
public
:
30
RCLCPP_SMART_PTR_DEFINITIONS_NOT_COPYABLE
(
Event
)
31
32
33
36
RCLCPP_PUBLIC
37
Event
();
38
40
43
RCLCPP_PUBLIC
44
bool
45
set
();
46
48
51
RCLCPP_PUBLIC
52
bool
53
check
();
54
56
59
RCLCPP_PUBLIC
60
bool
61
check_and_clear
();
62
63
private
:
64
RCLCPP_DISABLE_COPY
(
Event
)
65
66
std::atomic_bool state_;
67
};
68
69
}
// namespace rclcpp
70
71
#endif // RCLCPP__EVENT_HPP_
rclcpp::Event::set
bool set()
Set the Event state value to true.
RCLCPP_DISABLE_COPY
#define RCLCPP_DISABLE_COPY(...)
Definition:
macros.hpp:26
rclcpp
This header provides the get_node_base_interface() template function.
Definition:
allocator_common.hpp:24
RCLCPP_PUBLIC
#define RCLCPP_PUBLIC
Definition:
visibility_control.hpp:50
macros.hpp
rclcpp::Event::Event
Event()
Default construct.
rclcpp::Event::check
bool check()
Get the state value of the Event.
visibility_control.hpp
rclcpp::Event::check_and_clear
bool check_and_clear()
Get the state value of the Event and set to false.
RCLCPP_SMART_PTR_DEFINITIONS_NOT_COPYABLE
#define RCLCPP_SMART_PTR_DEFINITIONS_NOT_COPYABLE(...)
Definition:
macros.hpp:51
rclcpp::Event
Definition:
event.hpp:27
Generated by
1.8.17