Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends
karto::SensorRegistry Class Reference

#include <SensorRegistry.h>

Inheritance diagram for karto::SensorRegistry:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void Clear ()
SensorGetSensorByName (const Identifier &rName)
template<class C >
C * GetSensorByName (const Identifier &rName)
 SensorRegistry ()
virtual ~SensorRegistry ()

Static Public Member Functions

static SensorRegistryGetInstance ()
static void Validate (Sensor *pSensor)

Private Member Functions

void RegisterSensor (Sensor *pSensor)
void UnregisterSensor (Sensor *pSensor)

Private Attributes

SensorRegistryPrivatem_pSensorRegistryPrivate

Friends

class Sensor

Detailed Description

Sensors registry. Manages all sensors in Karto and is used internally by Karto. This class is subject to change and it is not recommend to call any of the SensorRegistry's methods.

Definition at line 43 of file SensorRegistry.h.


Constructor & Destructor Documentation

Default constructor

Definition at line 46 of file SensorRegistry.cpp.

Destructor

Definition at line 51 of file SensorRegistry.cpp.


Member Function Documentation

Clears the registry

Definition at line 139 of file SensorRegistry.cpp.

Gets singleton instance of SensorRegistry

Definition at line 57 of file SensorRegistry.cpp.

Gets the sensor with the given name

Parameters:
rNamename of sensor
Returns:
sensor

Definition at line 121 of file SensorRegistry.cpp.

template<class C >
C* karto::SensorRegistry::GetSensorByName ( const Identifier rName) [inline]

Gets the sensor with the given name

Parameters:
rNamename of sensor
Returns:
sensor

Definition at line 78 of file SensorRegistry.h.

void karto::SensorRegistry::RegisterSensor ( Sensor pSensor) [private]

Registers a sensor. The sensor name must be unique; if not, an exception will be thrown

Parameters:
pSensorsensor to register

Definition at line 68 of file SensorRegistry.cpp.

void karto::SensorRegistry::UnregisterSensor ( Sensor pSensor) [private]

Unregisters the given sensor

Parameters:
pSensorsensor to unregister

Definition at line 94 of file SensorRegistry.cpp.

void karto::SensorRegistry::Validate ( Sensor pSensor) [static]

Checks that given sensor is not NULL and has a non-empty name

Parameters:
pSensorsensor to validate

Definition at line 145 of file SensorRegistry.cpp.


Friends And Related Function Documentation

friend class Sensor [friend]

Definition at line 45 of file SensorRegistry.h.


Member Data Documentation

Definition at line 111 of file SensorRegistry.h.


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


nav2d_karto
Author(s): Sebastian Kasperski
autogenerated on Thu Aug 27 2015 14:07:26