Home
FAQ
Player
Utilities
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

fiducial
[libgazebo]


Classes

struct  gz_fiducial_fid
 Data for a single fiducial. More...
struct  gz_fiducial_data
 Fiducial data. More...
struct  gz_fiducial
 The fiducial interface. More...

Defines

#define GZ_FIDUCIAL_MAX_FIDS   401

Typedefs

typedef gz_fiducial_fid gz_fiducial_fid_t
 Data for a single fiducial.
typedef gz_fiducial_data gz_fiducial_data_t
 Fiducial data.
typedef gz_fiducial gz_fiducial_t
 The fiducial interface.

Functions

gz_fiducial_tgz_fiducial_alloc ()
 Create an interface.
void gz_fiducial_free (gz_fiducial_t *self)
 Destroy an interface.
int gz_fiducial_create (gz_fiducial_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_fiducial_destroy (gz_fiducial_t *self)
int gz_fiducial_open (gz_fiducial_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_fiducial_close (gz_fiducial_t *self)
 Close the interface (client).
int gz_fiducial_lock (gz_fiducial_t *self, int blocking)
void gz_fiducial_unlock (gz_fiducial_t *self)
 Unlock the interface.
int gz_fiducial_post (gz_fiducial_t *self)
 Tell clients that new data is available.

Detailed Description

The fiducial interface allows clients to determine the identity, range, bearing and orientation (relative to some sensor) of objects in the world. For example, this interface is used by the SickLMS200 model to return data from simulated retro-reflective barcodes.

Define Documentation

#define GZ_FIDUCIAL_MAX_FIDS   401
 


Typedef Documentation

typedef struct gz_fiducial_fid gz_fiducial_fid_t
 

Data for a single fiducial.

typedef struct gz_fiducial_data gz_fiducial_data_t
 

Fiducial data.

typedef struct gz_fiducial gz_fiducial_t
 

The fiducial interface.


Function Documentation

gz_fiducial_t* gz_fiducial_alloc  ) 
 

Create an interface.

void gz_fiducial_free gz_fiducial_t self  ) 
 

Destroy an interface.

int gz_fiducial_create gz_fiducial_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_fiducial_destroy gz_fiducial_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_fiducial_open gz_fiducial_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_fiducial_close gz_fiducial_t self  ) 
 

Close the interface (client).

int gz_fiducial_lock gz_fiducial_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_fiducial_unlock gz_fiducial_t self  ) 
 

Unlock the interface.

int gz_fiducial_post gz_fiducial_t self  ) 
 

Tell clients that new data is available.



Last updated $Date: 2004/12/21 01:49:15 $
Generated on Sun May 22 18:39:09 2005 for Gazebo by doxygen 1.4.2