Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
karto::SensorManager Class Reference

#include <Karto.h>

Public Member Functions

SensorVector GetAllSensors ()
 
SensorGetSensorByName (const Name &rName)
 
template<class T >
T * GetSensorByName (const Name &rName)
 
void RegisterSensor (Sensor *pSensor, kt_bool override=false)
 
 SensorManager ()
 
void UnregisterSensor (Sensor *pSensor)
 
virtual ~SensorManager ()
 

Static Public Member Functions

static SensorManagerGetInstance ()
 

Protected Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Protected Member Functions

static void Validate (Sensor *pSensor)
 

Protected Attributes

SensorManagerMap m_Sensors
 

Friends

class boost::serialization::access
 

Detailed Description

Manages sensors

Definition at line 3699 of file Karto.h.

Constructor & Destructor Documentation

◆ SensorManager()

karto::SensorManager::SensorManager ( )
inline

Constructor

Definition at line 3705 of file Karto.h.

◆ ~SensorManager()

virtual karto::SensorManager::~SensorManager ( )
inlinevirtual

Destructor

Definition at line 3712 of file Karto.h.

Member Function Documentation

◆ GetAllSensors()

SensorVector karto::SensorManager::GetAllSensors ( )
inline

Gets all registered sensors

Returns
vector of all registered sensors

Definition at line 3798 of file Karto.h.

◆ GetInstance()

SensorManager * karto::SensorManager::GetInstance ( )
static

Get singleton instance of SensorManager

Definition at line 57 of file Karto.cpp.

◆ GetSensorByName() [1/2]

Sensor* karto::SensorManager::GetSensorByName ( const Name rName)
inline

Gets the sensor with the given name

Parameters
rNamename of sensor
Returns
sensor

Definition at line 3771 of file Karto.h.

◆ GetSensorByName() [2/2]

template<class T >
T* karto::SensorManager::GetSensorByName ( const Name rName)
inline

Gets the sensor with the given name

Parameters
rNamename of sensor
Returns
sensor

Definition at line 3787 of file Karto.h.

◆ RegisterSensor()

void karto::SensorManager::RegisterSensor ( Sensor pSensor,
kt_bool  override = false 
)
inline

Registers a sensor by it's name. The Sensor name must be unique, if not sensor is not registered unless override is set to true

Parameters
pSensorsensor to register
override
Returns
true if sensor is registered with SensorManager, false if Sensor name is not unique

Definition at line 3730 of file Karto.h.

◆ serialize()

template<class Archive >
void karto::SensorManager::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

Definition at line 3835 of file Karto.h.

◆ UnregisterSensor()

void karto::SensorManager::UnregisterSensor ( Sensor pSensor)
inline

Unregisters the given sensor

Parameters
pSensorsensor to unregister

Definition at line 3750 of file Karto.h.

◆ Validate()

static void karto::SensorManager::Validate ( Sensor pSensor)
inlinestaticprotected

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

Parameters
pSensorsensor to validate

Definition at line 3815 of file Karto.h.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 3833 of file Karto.h.

Member Data Documentation

◆ m_Sensors

SensorManagerMap karto::SensorManager::m_Sensors
protected

Sensor map

Definition at line 3831 of file Karto.h.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Sat Oct 3 2020 03:51:02