rclcpp  master
C++ ROS Client Library API
future_return_code.hpp
Go to the documentation of this file.
1 // Copyright 2014 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__FUTURE_RETURN_CODE_HPP_
16 #define RCLCPP__FUTURE_RETURN_CODE_HPP_
17 
18 #include <iostream>
19 #include <string>
20 
22 
23 namespace rclcpp
24 {
25 
27 
34 
38 operator<<(std::ostream & os, const FutureReturnCode & future_return_code);
39 
43 to_string(const FutureReturnCode & future_return_code);
44 
45 namespace executor
46 {
47 
48 using FutureReturnCode [[deprecated("use rclcpp::FutureReturnCode instead")]] = FutureReturnCode;
49 
50 [[deprecated("use rclcpp::to_string(const rclcpp::FutureReturnCode &) instead")]]
51 inline
53 to_string(const rclcpp::FutureReturnCode & future_return_code)
54 {
55  return rclcpp::to_string(future_return_code);
56 }
57 
58 } // namespace executor
59 } // namespace rclcpp
60 
61 #endif // RCLCPP__FUTURE_RETURN_CODE_HPP_
rclcpp::FutureReturnCode
FutureReturnCode
Return codes to be used with spin_until_future_complete.
Definition: future_return_code.hpp:33
std::string
rclcpp::operator<<
std::ostream & operator<<(std::ostream &os, const FutureReturnCode &future_return_code)
Stream operator for FutureReturnCode.
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
rclcpp::FutureReturnCode::SUCCESS
@ SUCCESS
std::ostream
rclcpp::FutureReturnCode::TIMEOUT
@ TIMEOUT
rclcpp::FutureReturnCode::INTERRUPTED
@ INTERRUPTED
rclcpp::to_string
std::string to_string(const FutureReturnCode &future_return_code)
String conversion function for FutureReturnCode.
Definition: future_return_code.hpp:53
visibility_control.hpp
rclcpp::executor::FutureReturnCode
FutureReturnCode FutureReturnCode
Definition: future_return_code.hpp:48
rclcpp::executor::to_string
std::string to_string(const rclcpp::FutureReturnCode &future_return_code)
String conversion function for FutureReturnCode.
Definition: future_return_code.hpp:53