All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Namespaces | Classes | Typedefs | Enumerations | Functions
gazebo Namespace Reference

Forward declarations for the common classes. More...

Namespaces

 common
 Common namespace.
 
 event
 Event namespace.
 
 math
 Math namespace.
 
 msgs
 Messages namespace.
 
 physics
 namespace for physics
 
 rendering
 Rendering namespace.
 
 sensors
 Sensors namespace.
 
 transport
 
 util
 

Classes

class  Master
 A manager that directs topic connections, enables each gazebo network client to locate one another for peer-to-peer communication. More...
 
class  ModelPlugin
 A plugin with access to physics::Model. More...
 
class  PluginT
 A class which all plugins must inherit from. More...
 
class  SensorPlugin
 A plugin with access to physics::Sensor. More...
 
class  Server
 
class  SystemPlugin
 A plugin loaded within the gzserver on startup. More...
 
class  VisualPlugin
 A plugin loaded within the gzserver on startup. More...
 
class  WorldPlugin
 A plugin with access to physics::World. More...
 

Typedefs

typedef boost::shared_ptr
< GUIPlugin > 
GUIPluginPtr
 
typedef boost::shared_ptr
< ModelPlugin
ModelPluginPtr
 
typedef boost::shared_ptr
< SensorPlugin
SensorPluginPtr
 
typedef boost::shared_ptr
< SystemPlugin
SystemPluginPtr
 
typedef boost::shared_ptr
< VisualPlugin
VisualPluginPtr
 
typedef boost::shared_ptr
< WorldPlugin
WorldPluginPtr
 

Enumerations

enum  PluginType {
  WORLD_PLUGIN, MODEL_PLUGIN, SENSOR_PLUGIN, SYSTEM_PLUGIN,
  VISUAL_PLUGIN
}
 Used to specify the type of plugin. More...
 

Functions

GAZEBO_VISIBLE void add_plugin (const std::string &_filename) GAZEBO_DEPRECATED(2.3)
 Deprecated. More...
 
GAZEBO_VISIBLE void addPlugin (const std::string &_filename)
 Add a system plugin. More...
 
GAZEBO_VISIBLE std::string find_file (const std::string &_file) GAZEBO_DEPRECATED(2.3)
 Not implemented. More...
 
GAZEBO_VISIBLE void fini () GAZEBO_DEPRECATED(2.3)
 Deprecated. More...
 
GAZEBO_VISIBLE bool init () GAZEBO_DEPRECATED(2.3)
 Deprecated. More...
 
GAZEBO_VISIBLE bool load (int _argc=0, char **_argv=0) GAZEBO_DEPRECATED(2.3)
 Deprecated. More...
 
GAZEBO_VISIBLE
gazebo::physics::WorldPtr 
loadWorld (const std::string &_worldFile)
 Create and load a new world from an SDF world file. More...
 
GAZEBO_VISIBLE void print_version () GAZEBO_DEPRECATED(2.3)
 Deprecated. More...
 
GAZEBO_VISIBLE void printVersion ()
 Output version information to the terminal. More...
 
GAZEBO_VISIBLE void run () GAZEBO_DEPRECATED(2.3)
 Deprecated. More...
 
GAZEBO_VISIBLE void runWorld (gazebo::physics::WorldPtr _world, unsigned int _iterations)
 Run a world for a specific number of iterations. More...
 
GAZEBO_VISIBLE bool setupClient (int _argc=0, char **_argv=0)
 Start a gazebo client. More...
 
GAZEBO_VISIBLE bool setupServer (int _argc=0, char **_argv=0)
 Start a gazebo server. More...
 
GAZEBO_VISIBLE bool shutdown ()
 Stop and cleanup simulation. More...
 
GAZEBO_VISIBLE void stop () GAZEBO_DEPRECATED(2.3)
 Deprecated. More...
 

Detailed Description

Forward declarations for the common classes.

Forward declarations for the util classes.

Typedef Documentation

typedef boost::shared_ptr<GUIPlugin> gazebo::GUIPluginPtr
typedef boost::shared_ptr<ModelPlugin> gazebo::ModelPluginPtr
typedef boost::shared_ptr<SensorPlugin> gazebo::SensorPluginPtr
typedef boost::shared_ptr<SystemPlugin> gazebo::SystemPluginPtr
typedef boost::shared_ptr<VisualPlugin> gazebo::VisualPluginPtr
typedef boost::shared_ptr<WorldPlugin> gazebo::WorldPluginPtr

Function Documentation

GAZEBO_VISIBLE void gazebo::add_plugin ( const std::string &  _filename)

Deprecated.

See Also
gazebo::addPlugin.
GAZEBO_VISIBLE void gazebo::addPlugin ( const std::string &  _filename)

Add a system plugin.

Parameters
[in]_filenamePath to the plugin.
GAZEBO_VISIBLE std::string gazebo::find_file ( const std::string &  _file)

Not implemented.

See Also
gazebo::common::findFile.
GAZEBO_VISIBLE void gazebo::fini ( )

Deprecated.

See Also
gazebo::shutdown.
GAZEBO_VISIBLE bool gazebo::init ( )
GAZEBO_VISIBLE bool gazebo::load ( int  _argc = 0,
char **  _argv = 0 
)
GAZEBO_VISIBLE gazebo::physics::WorldPtr gazebo::loadWorld ( const std::string &  _worldFile)

Create and load a new world from an SDF world file.

Parameters
[in]_worldFileThe world file to load from.
Returns
Pointer to the created world. NULL on error.
GAZEBO_VISIBLE void gazebo::print_version ( )

Deprecated.

See Also
gazebo::printVersion.
GAZEBO_VISIBLE void gazebo::printVersion ( )

Output version information to the terminal.

GAZEBO_VISIBLE void gazebo::run ( )
GAZEBO_VISIBLE void gazebo::runWorld ( gazebo::physics::WorldPtr  _world,
unsigned int  _iterations 
)

Run a world for a specific number of iterations.

Parameters
[in]_worldPointer to a world.
[in]_iterationsNumber of iterations to execute.
GAZEBO_VISIBLE bool gazebo::setupClient ( 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]_argcNumber of commandline arguments.
[in]_argvThe commandline arguments.
Returns
True on success
GAZEBO_VISIBLE bool gazebo::setupServer ( int  _argc = 0,
char **  _argv = 0 
)

Start a gazebo server.

This starts transportation, and makes it possible to create worlds.

Parameters
[in]_argcNumber of commandline arguments.
[in]_argvThe commandline arguments.
Returns
True on success
GAZEBO_VISIBLE bool gazebo::shutdown ( )

Stop and cleanup simulation.

Returns
True if the simulation is shutdown; false otherwise.

Referenced by gazebo::transport::Connection::ConnectToShutdown(), and gazebo::transport::Connection::DisconnectShutdown().

GAZEBO_VISIBLE void gazebo::stop ( )