Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

DriverTable Class Reference

#include <drivertable.h>

List of all members.


Detailed Description

List of available driver classes.

This class maintains a list of driver names and factory functions; it is used to instantiate drivers at run-time.


Public Member Functions

 DriverTable ()
 ~DriverTable ()
int AddDriver (char *name, DriverInitFn initfunc)
 Add a driver class to the table.

DriverEntryGetDriverEntry (const char *name)
 Lookup a driver entry by name.

int Size ()
 Get the number of registered driver classes.

char * GetDriverName (int idx)
 Lookup a driver name by index.

char ** SortDrivers ()
 Sort drivers, based on name.


Constructor & Destructor Documentation

DriverTable::DriverTable  ) 
 

DriverTable::~DriverTable  ) 
 


Member Function Documentation

int DriverTable::AddDriver char *  name,
DriverInitFn  initfunc
 

Add a driver class to the table.

Parameters:
name Driver name (as it appears in the configuration file).
initfunc Driver factory function.

DriverEntry* DriverTable::GetDriverEntry const char *  name  ) 
 

Lookup a driver entry by name.

Parameters:
name Driver name.

int DriverTable::Size  )  [inline]
 

Get the number of registered driver classes.

char* DriverTable::GetDriverName int  idx  ) 
 

Lookup a driver name by index.

Parameters:
idx Index in list.
Returns:
Returns NULL if there is no matching driver.

char** DriverTable::SortDrivers  ) 
 

Sort drivers, based on name.

Returns:
Returns a pointer to newly malloc()ed memory, which the user should free().


The documentation for this class was generated from the following file:
Generated on Tue May 3 14:15:49 2005 for Player by doxygen 1.3.6