Gazebo logo

factory
[libgazebo]


Classes

struct  gz_factory_data
 Factory interface. More...
struct  gz_factory
 The position interface. More...

Typedefs

typedef gz_factory_data gz_factory_data_t
 Factory interface.
typedef gz_factory gz_factory_t
 The position interface.

Functions

gz_factory_tgz_factory_alloc ()
 Create an interface.
void gz_factory_free (gz_factory_t *self)
 Destroy an interface.
int gz_factory_create (gz_factory_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_factory_destroy (gz_factory_t *self)
int gz_factory_open (gz_factory_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_factory_close (gz_factory_t *self)
 Close the interface (client).
int gz_factory_lock (gz_factory_t *self, int blocking)
void gz_factory_unlock (gz_factory_t *self)
 Unlock the interface.

Detailed Description

The factory interface allows clients to send XML strings to a factory in order to dynamically create models.

Typedef Documentation

typedef struct gz_factory_data gz_factory_data_t
 

Factory interface.

typedef struct gz_factory gz_factory_t
 

The position interface.


Function Documentation

gz_factory_t* gz_factory_alloc  ) 
 

Create an interface.

void gz_factory_free gz_factory_t self  ) 
 

Destroy an interface.

int gz_factory_create gz_factory_t self,
gz_server_t server,
const char *  id,
const char *  model_type,
int  model_id,
int  parent_model_id
 

For internal use only.

Create the interface (used by Gazebo server)

int gz_factory_destroy gz_factory_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_factory_open gz_factory_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_factory_close gz_factory_t self  ) 
 

Close the interface (client).

int gz_factory_lock gz_factory_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_factory_unlock gz_factory_t self  ) 
 

Unlock the interface.


Last updated 12 September 2005 21:38:45