Gazebo

Frontpage

Contents

User

Installation

User Guide

Reference Guide

Class List

Class Hierarchy

Console-mode Server

Interactive Server

Working with Player

Worldfile Syntax

Using libgazebo

ToDo list

Online

Homepage

Download

Project

Bugs

Help

simulator
[libgazebo]

Classes
struct	gz_sim_data
	Common simulator data. More...
struct	gz_sim
	Simulator interface. More...
Typedefs
typedef gz_sim_data	gz_sim_data_t
	Common simulator data.
typedef gz_sim	gz_sim_t
	Simulator interface.
Functions
gz_sim_t *	gz_sim_alloc ()
	Create an interface.
void	gz_sim_free (gz_sim_t *self)
	Destroy an interface.
int	gz_sim_create (gz_sim_t *self, gz_server_t *server, const char *id)
int	gz_sim_destroy (gz_sim_t *self)
int	gz_sim_open (gz_sim_t *self, gz_client_t *client, const char *id)
	Open an existing interface.
int	gz_sim_close (gz_sim_t *self)
	Close the interface.
int	gz_sim_lock (gz_sim_t *self, int blocking)
void	gz_sim_unlock (gz_sim_t *self)
	Unlock the interface.

---

Detailed Description

The simulator interface provides access to certain global properties of the server, such as the current simulation time-step.

---

Typedef Documentation

typedef struct gz_sim_data gz_sim_data_t

Common simulator data.

typedef struct gz_sim gz_sim_t

Simulator interface.

---

Function Documentation

gz_sim_t* gz_sim_alloc (   )

Create an interface.

void gz_sim_free (  gz_sim_t *  self  )

Destroy an interface.

int gz_sim_create (  gz_sim_t *  self, gz_server_t *  server, const char *  id )

For internal use only. Create the interface (used by Gazebo server) Parameters: self  Point to itself. server  Pointer to the server. id  Dummy id; set this to "default".

int gz_sim_destroy (  gz_sim_t *  self  )

For internal use only. Destroy the interface (server)

int gz_sim_open (  gz_sim_t *  self, gz_client_t *  client, const char *  id )

Open an existing interface. Parameters: self  Pointer to itself. client  Pointer to the client. id  Dummy id; set this to "default"

int gz_sim_close (  gz_sim_t *  self  )

Close the interface.

int gz_sim_lock (  gz_sim_t *  self, int  blocking )

Lock the interface. Set blocking to 1 if the caller should block until the lock is acquired. Returns 0 if the lock is acquired.

void gz_sim_unlock (  gz_sim_t *  self  )

Unlock the interface.

---

Last updated 12 September 2005 21:38:45