init.h
Go to the documentation of this file.
1 #include "sick_scan/sick_scan_base.h" /* Base definitions included in all header files, added by add_sick_scan_base_header.py. Do not edit this line. */
2 /*
3  * Software License Agreement (BSD License)
4  *
5  * Copyright (c) 2009, Willow Garage, Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of Willow Garage, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #ifndef ROSCPP_INIT_H
37 #define ROSCPP_INIT_H
38 
39 #include "ros/forwards.h"
40 #include "ros/spinner.h"
41 #include "common.h"
42 
43 namespace roswrap
44 {
45 
46 namespace init_options
47 {
52 {
57  NoSigintHandler = 1 << 0,
60  AnonymousName = 1 << 1,
64  NoRosout = 1 << 2,
65 };
66 }
68 
84 ROSCPP_DECL void init(int &argc, char **argv, const std::string& name, uint32_t options = 0);
85 
94 ROSCPP_DECL void init(const M_string& remappings, const std::string& name, uint32_t options = 0);
95 
104 ROSCPP_DECL void init(const VP_string& remapping_args, const std::string& name, uint32_t options = 0);
105 
114 
125 ROSCPP_DECL void spin();
126 
139 ROSCPP_DECL void spin(Spinner& spinner);
148 ROSCPP_DECL void spinOnce();
149 
154 
161 ROSCPP_DECL bool ok();
168 ROSCPP_DECL void shutdown();
169 
176 
185 ROSCPP_DECL void start();
189 ROSCPP_DECL bool isStarted();
190 
198 
207 ROSCPP_DECL std::string getROSArg(int argc, const char* const* argv, const std::string& arg);
208 
217 ROSCPP_DECL void removeROSArgs(int argc, const char* const* argv, V_string& args_out);
218 
219 }
220 
221 #endif
roswrap::spin
ROSCPP_DECL void spin()
Enter simple event loop.
Definition: rossimu.cpp:260
roswrap::requestShutdown
ROSCPP_DECL void requestShutdown()
Request that the node shut itself down from within a ROS thread.
roswrap::init_options::NoRosout
@ NoRosout
Don't broadcast rosconsole output to the /rosout topic.
Definition: init.h:64
roswrap::removeROSArgs
ROSCPP_DECL void removeROSArgs(int argc, const char *const *argv, V_string &args_out)
returns a vector of program arguments that do not include any ROS remapping arguments....
roswrap::M_string
std::map< std::string, std::string > M_string
Definition: datatypes.h:46
roswrap::shutdown
ROSCPP_DECL void shutdown()
Disconnects everything and unregisters from the master. It is generally not necessary to call this fu...
Definition: rossimu.cpp:269
roswrap::isStarted
ROSCPP_DECL bool isStarted()
Returns whether or not the node has been started through ros::start()
roswrap::init_options::InitOption
InitOption
Flags for ROS initialization.
Definition: init.h:51
roswrap::getGlobalCallbackQueue
ROSCPP_DECL CallbackQueue * getGlobalCallbackQueue()
Returns a pointer to the global default callback queue.
roswrap::spinOnce
ROSCPP_DECL void spinOnce()
Process a single round of callbacks.
Definition: rossimu.cpp:255
api.setup.name
name
Definition: python/api/setup.py:12
roswrap::init_options::NoSigintHandler
@ NoSigintHandler
Definition: init.h:57
roswrap::init_options::AnonymousName
@ AnonymousName
Anonymize the node name. Adds a random number to the end of your node's name, to make it unique.
Definition: init.h:60
roswrap::CallbackQueue
This is the default implementation of the ros::CallbackQueueInterface.
Definition: callback_queue.h:58
roswrap
Definition: param_modi.cpp:41
roswrap::getROSArg
ROSCPP_DECL std::string getROSArg(int argc, const char *const *argv, const std::string &arg)
searches the command line arguments for the given arg parameter. In case this argument is not found a...
roswrap::isShuttingDown
ROSCPP_DECL bool isShuttingDown()
Returns whether or not ros::shutdown() has been (or is being) called.
Definition: rossimu.cpp:277
common.h
roswrap::Spinner
Abstract interface for classes which spin on a callback queue.
Definition: spinner.h:45
roswrap::VP_string
std::vector< std::pair< std::string, std::string > > VP_string
Definition: datatypes.h:43
roswrap::InitOption
init_options::InitOption InitOption
Definition: init.h:67
sick_scan_base.h
roswrap::isInitialized
ROSCPP_DECL bool isInitialized()
Returns whether or not ros::init() has been called.
ROSCPP_DECL
#define ROSCPP_DECL
Definition: roswrap/src/cfgsimu/sick_scan/ros/common.h:63
roswrap::ok
ROSCPP_DECL bool ok()
Check whether it's time to exit.
Definition: rossimu.cpp:273
roswrap::start
ROSCPP_DECL void start()
Actually starts the internals of the node (spins up threads, starts the network polling and xmlrpc lo...
roswrap::waitForShutdown
ROSCPP_DECL void waitForShutdown()
Wait for this node to be shutdown, whether through Ctrl-C, ros::shutdown(), or similar.
roswrap::init
ROSCPP_DECL void init(int &argc, char **argv, const std::string &name, uint32_t options=0)
ROS initialization function.
roswrap::V_string
std::vector< std::string > V_string
Definition: datatypes.h:44


sick_scan_xd
Author(s): Michael Lehning , Jochen Sprickerhof , Martin Günther
autogenerated on Fri Oct 25 2024 02:47:08