Go to the source code of this file.
Namespaces | |
namespace | ros |
namespace | ros::init_options |
Typedefs | |
typedef init_options::InitOption | ros::InitOption |
Enumerations | |
enum | ros::init_options::InitOption { ros::init_options::NoSigintHandler = 1 << 0, ros::init_options::AnonymousName = 1 << 1, ros::init_options::NoRosout = 1 << 2 } |
Flags for ROS initialization. More... | |
Functions | |
ROSCPP_DECL CallbackQueue * | ros::getGlobalCallbackQueue () |
Returns a pointer to the global default callback queue. | |
ROSCPP_DECL void | ros::init (int &argc, char **argv, const std::string &name, uint32_t options=0) |
ROS initialization function. | |
ROSCPP_DECL void | ros::init (const M_string &remappings, const std::string &name, uint32_t options=0) |
alternate ROS initialization function. | |
ROSCPP_DECL void | ros::init (const VP_string &remapping_args, const std::string &name, uint32_t options=0) |
alternate ROS initialization function. | |
ROSCPP_DECL bool | ros::isInitialized () |
Returns whether or not ros::init() has been called. | |
ROSCPP_DECL bool | ros::isShuttingDown () |
Returns whether or not ros::shutdown() has been (or is being) called. | |
ROSCPP_DECL bool | ros::isStarted () |
Returns whether or not the node has been started through ros::start() | |
ROSCPP_DECL bool | ros::ok () |
Check whether it's time to exit. | |
ROSCPP_DECL void | ros::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. Useful if you need to parse your arguments to determine your node name | |
ROSCPP_DECL void | ros::requestShutdown () |
Request that the node shut itself down from within a ROS thread. | |
ROSCPP_DECL void | ros::shutdown () |
Disconnects everything and unregisters from the master. It is generally not necessary to call this function, as the node will automatically shutdown when all NodeHandles destruct. However, if you want to break out of a spin() loop explicitly, this function allows that. | |
ROSCPP_DECL void | ros::spin () |
Enter simple event loop. | |
ROSCPP_DECL void | ros::spin (Spinner &spinner) |
Enter simple event loop. | |
ROSCPP_DECL void | ros::spinOnce () |
Process a single round of callbacks. | |
ROSCPP_DECL void | ros::start () |
Actually starts the internals of the node (spins up threads, starts the network polling and xmlrpc loops, connects to internal subscriptions like /clock, starts internal service servers, etc.). | |
ROSCPP_DECL void | ros::waitForShutdown () |
Wait for this node to be shutdown, whether through Ctrl-C, ros::shutdown(), or similar. |