ROS 2 rclcpp + rcl - rolling  rolling-e7363f10
ROS 2 C++ Client Library with ROS Client Library
node_options.h
Go to the documentation of this file.
1 // Copyright 2019 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 
16 
17 #ifndef RCL__NODE_OPTIONS_H_
18 #define RCL__NODE_OPTIONS_H_
19 
20 #ifdef __cplusplus
21 extern "C"
22 {
23 #endif
24 
25 #include <stdbool.h>
26 
27 #include "rcl/allocator.h"
28 #include "rcl/arguments.h"
29 #include "rcl/domain_id.h"
30 #include "rcl/macros.h"
31 #include "rcl/types.h"
32 #include "rcl/visibility_control.h"
33 
34 #include "rmw/types.h"
35 
37 #define RCL_NODE_OPTIONS_DEFAULT_DOMAIN_ID RCL_DEFAULT_DOMAIN_ID
38 
40 typedef struct rcl_node_options_s
41 {
42  // bool anonymous_name;
43 
44  // rmw_qos_profile_t parameter_qos;
45 
47  // bool no_parameters;
48 
51 
54 
57 
60 
62  rmw_qos_profile_t rosout_qos;
64 
66 
77 RCL_PUBLIC
80 
82 
99 RCL_PUBLIC
100 RCL_WARN_UNUSED
101 rcl_ret_t
103  const rcl_node_options_t * options,
104  rcl_node_options_t * options_out);
105 
107 
124 RCL_PUBLIC
125 RCL_WARN_UNUSED
126 rcl_ret_t
128 
129 #ifdef __cplusplus
130 }
131 #endif
132 
133 #endif // RCL__NODE_OPTIONS_H_
rcutils_allocator_t rcl_allocator_t
Encapsulation of an allocator.
Definition: allocator.h:31
struct rcl_node_options_s rcl_node_options_t
Structure which encapsulates the options for creating a rcl_node_t.
RCL_PUBLIC RCL_WARN_UNUSED rcl_ret_t rcl_node_options_copy(const rcl_node_options_t *options, rcl_node_options_t *options_out)
Copy one options structure into another.
Definition: node_options.c:49
RCL_PUBLIC rcl_node_options_t rcl_node_get_default_options(void)
Return the default node options in a rcl_node_options_t.
Definition: node_options.c:35
RCL_PUBLIC RCL_WARN_UNUSED rcl_ret_t rcl_node_options_fini(rcl_node_options_t *options)
Finalize the given node_options.
Definition: node_options.c:76
Hold output of parsing command line arguments.
Definition: arguments.h:36
Structure which encapsulates the options for creating a rcl_node_t.
Definition: node_options.h:41
bool use_global_arguments
If false then only use arguments in this struct, otherwise use global arguments also.
Definition: node_options.h:53
rmw_qos_profile_t rosout_qos
Middleware quality of service settings for /rosout.
Definition: node_options.h:62
rcl_arguments_t arguments
Command line arguments that apply only to this node.
Definition: node_options.h:56
bool enable_rosout
Flag to enable rosout for this node.
Definition: node_options.h:59
rcl_allocator_t allocator
If true, no parameter infrastructure will be setup.
Definition: node_options.h:50
rmw_ret_t rcl_ret_t
The type that holds an rcl return code.
Definition: types.h:25