Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
karto::SensorRegistry Class Reference

#include <SensorRegistry.h>

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

Public Member Functions

void Clear ()
 
SensorGetSensorByName (const Identifier &rName)
 
template<class C >
C * GetSensorByName (const Identifier &rName)
 
 SensorRegistry ()
 
virtual ~SensorRegistry ()
 
- Public Member Functions inherited from karto::Referenced
 Referenced ()
 

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
 

Additional Inherited Members

- Protected Member Functions inherited from karto::Referenced
kt_int32s GetReferenceCount ()
 
kt_int32s Reference () const
 
kt_int32s Unreference () const
 
kt_int32s UnreferenceNoDelete () const
 

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

karto::SensorRegistry::SensorRegistry ( )

Default constructor

Definition at line 46 of file SensorRegistry.cpp.

karto::SensorRegistry::~SensorRegistry ( )
virtual

Destructor

Definition at line 51 of file SensorRegistry.cpp.

Member Function Documentation

void karto::SensorRegistry::Clear ( )

Clears the registry

Definition at line 139 of file SensorRegistry.cpp.

SensorRegistry * karto::SensorRegistry::GetInstance ( )
static

Gets singleton instance of SensorRegistry

Definition at line 57 of file SensorRegistry.cpp.

Sensor * karto::SensorRegistry::GetSensorByName ( const Identifier rName)

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

SensorRegistryPrivate* karto::SensorRegistry::m_pSensorRegistryPrivate
private

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 Jun 6 2019 19:20:25