rcl  master
C API providing common ROS client library functionality.
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 "rcl/allocator.h"
26 #include "rcl/arguments.h"
27 
28 #include "rcl/domain_id.h"
29 
31 #define RCL_NODE_OPTIONS_DEFAULT_DOMAIN_ID RCL_DEFAULT_DOMAIN_ID
32 
34 typedef struct rcl_node_options_t
35 {
36  // bool anonymous_name;
37 
38  // rmw_qos_profile_t parameter_qos;
39 
41  // bool no_parameters;
42 
45 
48 
51 
54 
58 
60 
71 RCL_PUBLIC
74 
76 
93 RCL_PUBLIC
94 RCL_WARN_UNUSED
97  const rcl_node_options_t * options,
98  rcl_node_options_t * options_out);
99 
101 
118 RCL_PUBLIC
119 RCL_WARN_UNUSED
120 rcl_ret_t
122 
123 #ifdef __cplusplus
124 }
125 #endif
126 
127 #endif // RCL__NODE_OPTIONS_H_
rcl_node_options_t::allocator
rcl_allocator_t allocator
If true, no parameter infrastructure will be setup.
Definition: node_options.h:44
domain_id.h
rcl_ret_t
rmw_ret_t rcl_ret_t
The type that holds an rcl return code.
Definition: types.h:23
rcl_node_options_fini
rcl_ret_t rcl_node_options_fini(rcl_node_options_t *options)
Finalize the given node_options.
rcl_node_options_t
Structure which encapsulates the options for creating a rcl_node_t.
Definition: node_options.h:34
rcl_node_options_t
struct rcl_node_options_t rcl_node_options_t
Structure which encapsulates the options for creating a rcl_node_t.
rcl_node_options_copy
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.
rcl_node_options_t::use_global_arguments
bool use_global_arguments
If false then only use arguments in this struct, otherwise use global arguments also.
Definition: node_options.h:47
rcl_arguments_t
Hold output of parsing command line arguments.
Definition: arguments.h:35
arguments.h
rcl_node_options_t::arguments
rcl_arguments_t arguments
Command line arguments that apply only to this node.
Definition: node_options.h:50
rcl_node_get_default_options
rcl_node_options_t rcl_node_get_default_options(void)
Return the default node options in a rcl_node_options_t.
rcutils_allocator_t
allocator.h
rcl_node_options_t::rosout_qos
rmw_qos_profile_t rosout_qos
Middleware quality of service settings for /rosout.
Definition: node_options.h:56
rcl_node_options_t::enable_rosout
bool enable_rosout
Flag to enable rosout for this node.
Definition: node_options.h:53
rmw_qos_profile_t