gazebo::client Namespace Reference

Functions
GAZEBO_VISIBLE void	addPlugin (const std::string &_filename)
	Add a system plugin. More...
GAZEBO_VISIBLE void	printVersion ()
	Output version information to the terminal. More...
GAZEBO_VISIBLE bool	setup (int _argc=0, char **_argv=0)
	Start a gazebo client. More...
GAZEBO_VISIBLE bool	setup (const std::vector< std::string > &_args)
	Start a gazebo client. More...
GAZEBO_VISIBLE bool	shutdown ()
	Stop and cleanup simulation. More...

Function Documentation

addPlugin()

GAZEBO_VISIBLE void gazebo::client::addPlugin

(

const std::string &

_filename

)

Add a system plugin.

Parameters

[in]

_filename

Path to the plugin.

printVersion()

GAZEBO_VISIBLE void gazebo::client::printVersion

(

)

Output version information to the terminal.

setup() [1/2]

GAZEBO_VISIBLE bool gazebo::client::setup	(	int	_argc = 0,
		char **	_argv = 0
	)

Start a gazebo client.

This starts transportation, and makes it possible to connect to a running simulation.

Parameters

[in]	_argc	Number of commandline arguments.
[in]	_argv	The commandline arguments.

Returns

True on success.

setup() [2/2]

GAZEBO_VISIBLE bool gazebo::client::setup

(

const std::vector< std::string > &

_args

)

Start a gazebo client.

This starts transportation, and makes it possible to connect to a running simulation.

Parameters

[in]

_args

Vector of arguments only parsed by the system plugins. Note that when you run gazebo/gzserver, all the options (–version, –server-plugin, etc.) are parsed but when using Gazebo as a library, the arguments are only parsed by the system plugins.

See also

gazebo::SystemPlugin::Load()

Returns

True on success.

shutdown()

GAZEBO_VISIBLE bool gazebo::client::shutdown

(

)

Stop and cleanup simulation.

Returns

True if the simulation is shutdown; false otherwise.