ros Namespace Reference

Namespaces
	CallbackQueue
	console
	debug
	file_log
	init_options
	master
	message_operations
	message_traits
	names
	network
	NodeHandle
	package
	param
	Publisher
	serialization
	service
	service_traits
	ServiceClient
	ServiceServer
	ServiceServerLink
	StatisticsLogger
	SteadyTimer
	Subscriber
	SubscriberLink
	Subscription
	SubscriptionQueue
	this_node
	Timer
	TimerManager
	topic
	WallTimer
	xmlrpc
	XMLRPCManager

Classes
struct	AdvertiseOptions
struct	AdvertiseServiceOptions
class	AsyncSpinner
class	AsyncSpinnerImpl
class	ASyncXMLRPCConnection
class	CachedXmlRpcClient
class	CallbackInterface
class	CallbackQueue
class	CallbackQueueInterface
class	ConflictingSubscriptionException
class	Connection
class	ConnectionManager
struct	DefaultMessageCreator
class	Duration
class	DurationBase
class	Exception
class	Header
class	IntraProcessPublisherLink
class	IntraProcessSubscriberLink
class	InvalidNameException
class	InvalidNodeNameException
class	InvalidParameterException
class	InvalidPortException
class	MessageDeserializer
class	MessageEvent
class	MultiThreadedSpinner
class	NodeHandle
class	NodeHandleBackingCollection
class	NoHighPerformanceTimersException
struct	ParameterAdapter
struct	ParameterAdapter< boost::shared_ptr< M > >
struct	ParameterAdapter< boost::shared_ptr< M const > >
struct	ParameterAdapter< const boost::shared_ptr< M > & >
struct	ParameterAdapter< const boost::shared_ptr< M const > & >
struct	ParameterAdapter< const M & >
struct	ParameterAdapter< const ros::MessageEvent< M > & >
struct	ParameterAdapter< const ros::MessageEvent< M const > & >
class	PeerConnDisconnCallback
class	PollManager
class	PollSet
class	Publication
class	Publisher
class	PublisherLink
class	Rate
class	ROSOutAppender
class	SerializedMessage
class	ServiceCallback
class	ServiceCallbackHelper
struct	ServiceCallbackHelperCallParams
class	ServiceCallbackHelperT
class	ServiceClient
class	ServiceClientLink
struct	ServiceClientOptions
class	ServiceEvent
class	ServiceManager
class	ServicePublication
class	ServiceServer
class	ServiceServerLink
struct	ServiceSpec
struct	ServiceSpecCallParams
class	SingleSubscriberPublisher
class	SingleThreadedSpinner
class	Spinner
class	StatisticsLogger
class	SteadyTime
class	SteadyTimer
struct	SteadyTimerEvent
struct	SteadyTimerOptions
struct	SubscribeOptions
class	Subscriber
struct	SubscriberCallbacks
class	SubscriberLink
class	Subscription
class	SubscriptionCallbackHelper
struct	SubscriptionCallbackHelperCallParams
struct	SubscriptionCallbackHelperDeserializeParams
class	SubscriptionCallbackHelperT
class	SubscriptionQueue
class	Time
class	TimeBase
class	TimeNotInitializedException
class	Timer
struct	TimerEvent
class	TimerManager
struct	TimerOptions
class	TopicManager
class	Transport
class	TransportHints
class	TransportPublisherLink
class	TransportSubscriberLink
class	TransportTCP
class	TransportUDP
struct	TransportUDPHeader
class	WallDuration
class	WallRate
class	WallTime
class	WallTimer
struct	WallTimerEvent
struct	WallTimerOptions
class	XMLRPCCallWrapper
class	XMLRPCManager

Typedefs
typedef boost::shared_ptr< AsyncSpinnerImpl >	AsyncSpinnerImplPtr
typedef boost::shared_ptr< ASyncXMLRPCConnection >	ASyncXMLRPCConnectionPtr
typedef boost::shared_ptr< CallbackInterface >	CallbackInterfacePtr
typedef boost::shared_ptr< CallbackQueue >	CallbackQueuePtr
typedef boost::shared_ptr< ConnectionManager >	ConnectionManagerPtr
typedef boost::shared_ptr< Connection >	ConnectionPtr
typedef boost::function< bool(const ConnectionPtr &, const Header &)>	HeaderReceivedFunc
typedef init_options::InitOption	InitOption
typedef TimerManager< SteadyTime, WallDuration, SteadyTimerEvent >	InternalTimerManager
typedef boost::shared_ptr< InternalTimerManager >	InternalTimerManagerPtr
typedef boost::shared_ptr< IntraProcessPublisherLink >	IntraProcessPublisherLinkPtr
typedef boost::shared_ptr< IntraProcessSubscriberLink >	IntraProcessSubscriberLinkPtr
typedef std::list< ServicePublicationPtr >	L_ServicePublication
typedef std::list< ServiceServerLinkPtr >	L_ServiceServerLink
typedef std::list< SubscriptionPtr >	L_Subscription
typedef std::map< std::string, std::string >	M_string
typedef std::map< std::string, std::string >	M_string
typedef boost::shared_ptr< M_string >	M_stringPtr
typedef boost::shared_ptr< MessageDeserializer >	MessageDeserializerPtr
typedef boost::shared_ptr< NodeHandle >	NodeHandlePtr
typedef boost::shared_ptr< std::vector< socket_pollfd > >	pollfd_vector_ptr
typedef boost::shared_ptr< PollManager >	PollManagerPtr
typedef boost::shared_ptr< Publication >	PublicationPtr
typedef boost::weak_ptr< Publication >	PublicationWPtr
typedef boost::shared_ptr< PublisherLink >	PublisherLinkPtr
typedef boost::function< void(const ConnectionPtr &, const boost::shared_array< uint8_t > &, uint32_t, bool)>	ReadFinishedFunc
typedef std::set< ASyncXMLRPCConnectionPtr >	S_ASyncXMLRPCConnection
typedef std::set< ConnectionPtr >	S_Connection
typedef std::set< std::string >	S_string
typedef std::set< SubscriptionPtr >	S_Subscription
typedef boost::shared_ptr< ServiceCallbackHelper >	ServiceCallbackHelperPtr
typedef boost::shared_ptr< ServiceClientLink >	ServiceClientLinkPtr
typedef boost::shared_ptr< ServiceClient >	ServiceClientPtr
typedef boost::shared_ptr< ServiceManager >	ServiceManagerPtr
typedef boost::shared_ptr< ServicePublication >	ServicePublicationPtr
typedef boost::weak_ptr< ServicePublication >	ServicePublicationWPtr
typedef boost::shared_ptr< ServiceServerLink >	ServiceServerLinkPtr
typedef int	signal_fd_t
typedef int	socket_fd_t
typedef struct pollfd	socket_pollfd
typedef boost::function< void(const SteadyTimerEvent &)>	SteadyTimerCallback
typedef std::pair< std::string, std::string >	StringPair
typedef boost::shared_ptr< SubscriberCallbacks >	SubscriberCallbacksPtr
typedef boost::shared_ptr< SubscriberLink >	SubscriberLinkPtr
typedef boost::function< void(const SingleSubscriberPublisher &)>	SubscriberStatusCallback
typedef boost::shared_ptr< SubscriptionCallbackHelper >	SubscriptionCallbackHelperPtr
typedef boost::shared_ptr< SubscriptionCallback >	SubscriptionCallbackPtr
typedef boost::shared_ptr< Subscription >	SubscriptionPtr
typedef boost::shared_ptr< SubscriptionQueue >	SubscriptionQueuePtr
typedef boost::weak_ptr< Subscription >	SubscriptionWPtr
typedef boost::function< void(const TimerEvent &)>	TimerCallback
typedef boost::shared_ptr< TopicManager >	TopicManagerPtr
typedef boost::shared_ptr< Transport >	TransportPtr
typedef boost::shared_ptr< TransportPublisherLink >	TransportPublisherLinkPtr
typedef boost::shared_ptr< TransportSubscriberLink >	TransportSubscriberLinkPtr
typedef boost::shared_ptr< TransportTCP >	TransportTCPPtr
typedef struct ros::TransportUDPHeader	TransportUDPHeader
typedef boost::shared_ptr< TransportUDP >	TransportUDPPtr
typedef std::vector< ConnectionPtr >	V_Connection
typedef std::vector< PublicationPtr >	V_Publication
typedef std::vector< Publisher >	V_Publisher
typedef std::vector< PublisherLinkPtr >	V_PublisherLink
typedef std::vector< ServiceClientLinkPtr >	V_ServiceClientLink
typedef std::vector< ServicePublicationPtr >	V_ServicePublication
typedef std::vector< ServiceServer >	V_ServiceServer
typedef std::vector< std::string >	V_string
typedef std::vector< Subscriber >	V_Subscriber
typedef std::vector< SubscriberLinkPtr >	V_SubscriberLink
typedef std::vector< SubscriptionPtr >	V_Subscription
typedef boost::shared_ptr< void const >	VoidConstPtr
typedef boost::weak_ptr< void const >	VoidConstWPtr
typedef boost::function< void(void)>	VoidFunc
typedef boost::shared_ptr< void >	VoidPtr
typedef boost::signals2::signal< void(void)>	VoidSignal
typedef boost::weak_ptr< void >	VoidWPtr
typedef std::vector< std::pair< std::string, std::string > >	VP_string
typedef boost::function< void(const WallTimerEvent &)>	WallTimerCallback
typedef boost::function< void(const ConnectionPtr &)>	WriteFinishedFunc
typedef boost::shared_ptr< XMLRPCCallWrapper >	XMLRPCCallWrapperPtr
typedef boost::function< void(XmlRpc::XmlRpcValue &, XmlRpc::XmlRpcValue &)>	XMLRPCFunc
typedef boost::shared_ptr< XMLRPCManager >	XMLRPCManagerPtr

Functions
ROSCPP_DECL void	add_socket_to_watcher (int epfd, int fd)
void	atexitCallback ()
void	basicSigintHandler (int sig)
void	check_ipv6_environment ()
void	checkForShutdown ()
void	clockCallback (const rosgraph_msgs::Clock::ConstPtr &msg)
void	close_signal_pair (signal_fd_t signal_pair[2])
ROSCPP_DECL int	close_socket (socket_fd_t &socket)
ROSCPP_DECL void	close_socket_watcher (int fd)
bool	closeAllConnections (roscpp::Empty::Request &, roscpp::Empty::Response &)
void	closeTransport (const TransportUDPPtr &trans)
ROSCPP_DECL int	create_signal_pair (signal_fd_t signal_pair[2])
ROSCPP_DECL int	create_socket_watcher ()
ROS_DEPRECATED boost::shared_ptr< M >	defaultMessageCreateFunction ()
boost::shared_ptr< M >	defaultServiceCreateFunction ()
ROSCPP_DECL void	del_socket_from_watcher (int epfd, int fd)
const Duration	DURATION_MAX (std::numeric_limits< int32_t >::max(), 999999999)
const Duration	DURATION_MIN (std::numeric_limits< int32_t >::min(), 0)
static bool	g_initialized (false)
static bool	g_stopped (false)
static bool	g_use_sim_time (true)
bool	get_environment_variable (std::string &str, const char *environment_variable)
const ROSCPP_DECL std::string &	getDefaultMasterURI ()
ROSCPP_DECL CallbackQueue *	getGlobalCallbackQueue ()
CallbackQueuePtr	getInternalCallbackQueue ()
ROSCPP_DECL InternalTimerManagerPtr	getInternalTimerManager ()
bool	getLoggers (roscpp::GetLoggers::Request &, roscpp::GetLoggers::Response &resp)
void	getPid (const XmlRpcValue &params, XmlRpcValue &result)
ROSCPP_DECL std::string	getROSArg (int argc, const char *const *argv, const std::string &arg)
ROSCPP_DECL void	init (const M_string &remappings, const std::string &name, uint32_t options=0)
ROSCPP_DECL void	init (const VP_string &remapping_args, const std::string &name, uint32_t options=0)
ROSCPP_DECL void	init (int &argc, char **argv, const std::string &name, uint32_t options=0)
ROSCPP_DECL void	initInternalTimerManager ()
void	internalCallbackQueueThreadFunc ()
ROSCPP_DECL int	is_async_connected (socket_fd_t &socket, int &err)
ROSCPP_DECL bool	isInitialized ()
ROSCPP_DECL bool	isShuttingDown ()
ROSCPP_DECL bool	isStarted ()
ROSCPP_DECL int	last_socket_error ()
ROSCPP_DECL bool	last_socket_error_is_would_block ()
const ROSCPP_DECL char *	last_socket_error_string ()
bool	md5sumsMatch (const std::string &lhs, const std::string &rhs)
ROSTIME_DECL void	normalizeSecNSec (uint32_t &sec, uint32_t &nsec)
ROSTIME_DECL void	normalizeSecNSec (uint64_t &sec, uint64_t &nsec)
ROSTIME_DECL void	normalizeSecNSecSigned (int32_t &sec, int32_t &nsec)
ROSTIME_DECL void	normalizeSecNSecSigned (int64_t &sec, int64_t &nsec)
ROSTIME_DECL void	normalizeSecNSecUnsigned (int64_t &sec, int64_t &nsec)
ROSCPP_DECL bool	ok ()
::ros::Duration	operator* (const ::ros::Duration &val1, const ::ros::Duration &val2)
	Multiply two durations. The units of the result are [s^2]. More...
::ros::WallDuration	operator* (const ::ros::WallDuration &val1, const ::ros::WallDuration &val2)
	Multiply two durations. The units of the result are [s^2]. More...
::ros::Duration	operator/ (const ::ros::Duration &numerator, const ::ros::Duration &denominator)
	Divide duration val1 by val2. The result is unitless. More...
::ros::WallDuration	operator/ (const ::ros::WallDuration &numerator, const ::ros::WallDuration &denominator)
	Divide duration val1 by val2. The result is unitless. More...
ROSTIME_DECL std::ostream &	operator<< (std::ostream &os, const Duration &rhs)
ROSTIME_DECL std::ostream &	operator<< (std::ostream &os, const SteadyTime &rhs)
ROSTIME_DECL std::ostream &	operator<< (std::ostream &os, const Time &rhs)
ROSTIME_DECL std::ostream &	operator<< (std::ostream &os, const WallDuration &rhs)
ROSTIME_DECL std::ostream &	operator<< (std::ostream &os, const WallTime &rhs)
bool	operator== (const ::ros::Rate &r1, const ::ros::Rate &r2)
	Test two rates for equality. More...
bool	operator== (const ::ros::WallRate &r1, const ::ros::WallRate &r2)
	Test two rates for equality. More...
ROSCPP_DECL pollfd_vector_ptr	poll_sockets (int epfd, socket_pollfd *fds, nfds_t nfds, int timeout)
ssize_t	read_signal (const signal_fd_t &signal, void *buffer, const size_t &nbyte)
ROSCPP_DECL void	removeROSArgs (int argc, const char *const *argv, V_string &args_out)
ROSCPP_DECL void	requestShutdown ()
int	ros_nanosleep (const uint32_t &sec, const uint32_t &nsec)
ROSTIME_DECL void	ros_steadytime (uint32_t &sec, uint32_t &nsec)
bool	ros_wallsleep (uint32_t sec, uint32_t nsec)
ROSTIME_DECL void	ros_walltime (uint32_t &sec, uint32_t &nsec)
ROSCPP_DECL void	set_events_on_socket (int epfd, int fd, int events)
ROSCPP_DECL int	set_non_blocking (socket_fd_t &socket)
bool	setLoggerLevel (roscpp::SetLoggerLevel::Request &req, roscpp::SetLoggerLevel::Response &)
ROSCPP_DECL void	shutdown ()
void	shutdownCallback (XmlRpc::XmlRpcValue &params, XmlRpc::XmlRpcValue &result)
const ROSCPP_DECL char *	socket_error_string (int err)
ROSCPP_DECL void	spin ()
ROSCPP_DECL void	spin (Spinner &spinner)
ROSCPP_DECL void	spinOnce ()
void	spinThread ()
ROSCPP_DECL void	start ()
const Time	TIME_MAX (std::numeric_limits< uint32_t >::max(), 999999999)
bool	urisEqual (const std::string &uri1, const std::string &uri2)
ROSCPP_DECL void	waitForShutdown ()
ssize_t	write_signal (const signal_fd_t &signal, const void *buffer, const size_t &nbyte)

Variables
const ROSTIME_DECL Duration	DURATION_MAX
const ROSTIME_DECL Duration	DURATION_MIN
static bool	g_atexit_registered
CallbackQueuePtr	g_global_queue
static uint32_t	g_init_options
static bool	g_initialized
static CallbackQueuePtr	g_internal_callback_queue
static boost::thread	g_internal_queue_thread
int32_t	g_nh_refcount
boost::mutex	g_nh_refcount_mutex
bool	g_node_started_by_nh
static bool	g_ok
ROSOutAppender *	g_rosout_appender
static bool	g_shutdown_registered
static bool	g_shutdown_requested
static volatile bool	g_shutting_down
static boost::recursive_mutex	g_shutting_down_mutex
static Time	g_sim_time (0, 0)
static boost::mutex	g_sim_time_mutex
static boost::mutex	g_start_mutex
static bool	g_started
static InternalTimerManagerPtr	g_timer_manager
const ROSTIME_DECL Time	TIME_MAX
const ROSTIME_DECL Time	TIME_MIN
const Time	TIME_MIN (0, 1)

Function Documentation

operator*() [1/2]

::ros::Duration ros::operator*	(	const ::ros::Duration &	val1,
		const ::ros::Duration &	val2
	)

Multiply two durations. The units of the result are [s^2].

Parameters

[in]	val1	Duration to multiply.
[in]	val2	Duration to multiply.

Returns

The multiple.

Note

This function will throw an exception if the result is out of bounds of the standard ROS duration range.

operator*() [2/2]

::ros::WallDuration ros::operator*	(	const ::ros::WallDuration &	val1,
		const ::ros::WallDuration &	val2
	)

Multiply two durations. The units of the result are [s^2].

Parameters

[in]	val1	Duration to multiply.
[in]	val2	Duration to multiply.

Returns

The multiple.

Note

This function will throw an exception if the result is out of bounds of the standard ROS duration range.

operator/() [1/2]

::ros::Duration ros::operator/	(	const ::ros::Duration &	numerator,
		const ::ros::Duration &	denominator
	)

Divide duration val1 by val2. The result is unitless.

Parameters

[in]	numerator	Duration to multiply.
[in]	denominator	Duration to multiply.

Returns

The fraction.

Note

This function will throw an exception if the result is out of bounds of the standard ROS duration range.

operator/() [2/2]

::ros::WallDuration ros::operator/	(	const ::ros::WallDuration &	numerator,
		const ::ros::WallDuration &	denominator
	)

Divide duration val1 by val2. The result is unitless.

Parameters

[in]	numerator	Duration to multiply.
[in]	denominator	Duration to multiply.

Returns

The fraction.

Note

This function will throw an exception if the result is out of bounds of the standard ROS duration range.

operator==() [1/2]

bool ros::operator==	(	const ::ros::Rate &	r1,
		const ::ros::Rate &	r2
	)

Test two rates for equality.

Parameters

[in]	r1	First rate.
[in]	r2	Second rate.

Returns

Whether the rates are exactly equal.

operator==() [2/2]

bool ros::operator==	(	const ::ros::WallRate &	r1,
		const ::ros::WallRate &	r2
	)

Test two rates for equality.

Parameters

[in]	r1	First rate.
[in]	r2	Second rate.

Returns

Whether the rates are exactly equal.