Gazebo

Sensor Class Reference
[Sensors]

#include <Sensor.hh>

Inheritance diagram for Sensor:

Entity CameraSensor RaySensor SensorStub

List of all members.


Detailed Description

Base class for sensors

Public Member Functions

 Sensor (Body *body)
virtual ~Sensor ()
virtual void Load (XMLConfigNode *node)
void Init ()
void Update (UpdateParams &params)
void Fini ()
void SetActive (bool value)

Protected Member Functions

virtual void LoadChild (XMLConfigNode *)
virtual void InitChild ()
virtual void UpdateChild (UpdateParams &)
virtual void FiniChild ()

Protected Attributes

Bodybody
 The body this sensor is attached to.
Controllercontroller
bool active

Constructor & Destructor Documentation

Sensor ( Body body  ) 

Constructor

virtual ~Sensor (  )  [virtual]

Destructor


Member Function Documentation

virtual void Load ( XMLConfigNode node  )  [virtual]

Load the sensor

Parameters:
node XMLConfigNode pointer

void Init (  ) 

Initialize the sensor

void Update ( UpdateParams params  ) 

Update the sensor

void Fini (  ) 

Finalize the sensor

void SetActive ( bool  value  ) 

Set whether the sensor is active or not

virtual void LoadChild ( XMLConfigNode  )  [inline, protected, virtual]

Load the child sensor

Reimplemented in CameraSensor, RaySensor, and SensorStub.

virtual void InitChild (  )  [inline, protected, virtual]

Initialize the child

Reimplemented in CameraSensor, RaySensor, and SensorStub.

virtual void UpdateChild ( UpdateParams  )  [inline, protected, virtual]

Update the child

Reimplemented in CameraSensor, RaySensor, and SensorStub.

virtual void FiniChild (  )  [inline, protected, virtual]

Finalize the child

Reimplemented in CameraSensor, RaySensor, and SensorStub.


Member Data Documentation

Controller* controller [protected]

Pointer to the controller of the sensor

bool active [protected]

True if active


The documentation for this class was generated from the following file:

Last updated Aug 04 2007