Gazebo

User

Frontpage

Installation

Worldfile Syntax

GUI

Media Resources

Tutorials

Model Creation

Sensor Creation

Controller Creation

Using Player

Using Terrains

Creating Custom Meshes

API

Code Reference

Class List

Class Hierarchy

Controller

---

Detailed Description

Classes to handle reading and writing gazebo interfaces, via libgazebo.

Modules
	bandit_actarray
	Bandit Actuator Array controller.
	audio
	Audio controller.
	generic camera
	Generic camera controller.
	stereo camera
	Stereo camera controller.
	controller_stub
	A stubbed out controller.
	factory
	Factory used for dynamic construction of models.
	pioneer2_gripper
	Pioneer 2 DX Position2D controller.
	sicklms200
	Sick LMS 200 laser controller.
	pioneer2dx_position2d
	Pioneer 2 DX Position2D controller.
	car_position2d
	Ackermann steering of four wheels Position2D controller.
	steering_position2d
	General steering controller for any number of wheels.
	generic ptz
	Generic pan-tilt-zoom controller.
Classes
class	Controller
	Base class for all controllers. More...
class	ControllerFactory
	The controller factory; the class is just for namespacing purposes. More...
Defines
#define	GZ_REGISTER_STATIC_CONTROLLER(name, classname)
	Static controller registration macro.
#define	GZ_REGISTER_DYNAMIC_CONTROLLER(name, classname)
	Dynamic controller registration macro.
Typedefs
typedef Controller *(*)	ControllerFactoryFn (Entity *parent)
	Prototype for controller factory functions.
Functions
virtual	~Generic_Camera ()
	Destructor.
virtual void	LoadChild (XMLConfigNode *node)
	Load the controller.
virtual void	InitChild ()
	Init the controller.
virtual void	UpdateChild (UpdateParams &params)
	Update the controller.
virtual void	FiniChild ()
	Finalize the controller.
virtual	~Stereo_Camera ()
	Destructor.
virtual void	LoadChild (XMLConfigNode *node)
	Load the controller.
virtual void	InitChild ()
	Init the controller.
virtual void	UpdateChild (UpdateParams &params)
	Update the controller.
virtual void	FiniChild ()
	Finalize the controller.
virtual	~SickLMS200_Laser ()
	Destructor.
virtual void	LoadChild (XMLConfigNode *node)
	Load the controller.
virtual void	InitChild ()
	Init the controller.
virtual void	UpdateChild (UpdateParams &params)
	Update the controller.
virtual void	FiniChild ()
	Finalize the controller.
virtual	~Generic_PTZ ()
	Destructor.
virtual void	LoadChild (XMLConfigNode *node)
	Load the controller.
virtual void	InitChild ()
	Init the controller.
virtual void	UpdateChild (UpdateParams &params)
	Update the controller.
virtual void	FiniChild ()
	Finalize the controller.
virtual void	ResetChild ()
	Reset the controller.

---

Define Documentation

#define GZ_REGISTER_DYNAMIC_CONTROLLER	(	name,
		classname		)

Value:

Controller *New##classname(Entity *entity) \
{ \
  return new classname(entity); \
} \
extern "C" void RegisterPluginController(); \
void RegisterPluginController() \
{\
  ControllerFactory::RegisterController("dynamic", name, New##classname);\
}

Dynamic controller registration macro.

Use this macro to register plugin controllers with the server.

Parameters:

	name	Controller type name, as it appears in the world file.
	classname	C++ class name for the controller.

#define GZ_REGISTER_STATIC_CONTROLLER	(	name,
		classname		)

Value:

Controller *New##classname(Entity *entity) \
{ \
  return new classname(entity); \
} \
void Register##classname() \
{\
  ControllerFactory::RegisterController("static", name, New##classname);\
}\
StaticPluginRegister Registered##classname (Register##classname);

Static controller registration macro.

Use this macro to register controllers with the server.

Parameters:

	name	Controller type name, as it appears in the world file.
	classname	C++ class name for the controller.

---

Function Documentation

virtual void FiniChild

(

)

[protected, virtual, inherited]

Finalize the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void FiniChild

(

)

[protected, virtual, inherited]

Finalize the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void FiniChild

(

)

[protected, virtual, inherited]

Finalize the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void InitChild

(

)

[protected, virtual, inherited]

Init the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void InitChild

(

)

[protected, virtual, inherited]

Init the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void InitChild

(

)

[protected, virtual, inherited]

Init the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void LoadChild

(

XMLConfigNode *

node

)

[protected, virtual, inherited]

Load the controller.

Parameters:

node

XML config node

Reimplemented from Controller.

virtual void LoadChild

(

XMLConfigNode *

node

)

[protected, virtual, inherited]

Load the controller.

Parameters:

node

XML config node

Returns:

0 on success

Reimplemented from Controller.

virtual void LoadChild

(

XMLConfigNode *

node

)

[protected, virtual, inherited]

Load the controller.

Parameters:

node

XML config node

Returns:

0 on success

Reimplemented from Controller.

virtual void LoadChild

(

XMLConfigNode *

node

)

[protected, virtual, inherited]

Load the controller.

Parameters:

node

XML config node

Returns:

0 on success

Reimplemented from Controller.

virtual void UpdateChild

(

UpdateParams &

params

)

[protected, virtual, inherited]

Update the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void UpdateChild

(

UpdateParams &

params

)

[protected, virtual, inherited]

Update the controller.

Returns:

0 on success

Reimplemented from Controller.

virtual void UpdateChild

(

UpdateParams &

params

)

[protected, virtual, inherited]

Update the controller.

Returns:

0 on success

Reimplemented from Controller.

---

Last updated Aug 04 2007