gazebo::sensors::SensorManager Class Reference

Class to manage and update all sensors. More...

#include <sensors/sensors.hh>

Inheritance diagram for gazebo::sensors::SensorManager:

Public Member Functions
std::string	CreateSensor (sdf::ElementPtr _elem, const std::string &_worldName, const std::string &_parentName)
	Add a sensor from an SDF element.
void	Fini ()
	Finalize all the sensors.
SensorPtr	GetSensor (const std::string &_name)
	Get a sensor.
Sensor_V	GetSensors () const
	Get all the sensors.
void	GetSensorTypes (std::vector< std::string > &_types) const
	Get all the sensor types.
void	Init ()
	Init all the sensors.
void	RemoveSensor (const std::string &_name)
	Remove a sensor.
void	RemoveSensors ()
	Remove all sensors.
void	Run ()
	Run the sensor manager update in a new thread.
bool	SensorsInitialized ()
	True if SensorManager::initSensors queue is empty i.e.
void	Stop ()
	Stop the run thread.
void	Update (bool _force=false)
	Update all the sensors.

Additional Inherited Members
Static Public Member Functions inherited from SingletonT< T >
static T *	Instance ()
	Get an instance of the singleton.
Protected Member Functions inherited from SingletonT< T >
	SingletonT ()
	Constructor.
virtual	~SingletonT ()
	Destructor.

Detailed Description

Class to manage and update all sensors.

Member Function Documentation

std::string gazebo::sensors::SensorManager::CreateSensor	(	sdf::ElementPtr	_elem,
		const std::string &	_worldName,
		const std::string &	_parentName
	)

Add a sensor from an SDF element.

This function will also Load and Init the sensor.

Parameters

[in]	_elem	The SDF element that describes the sensor
[in]	_worldName	Name of the world in which to create the sensor
[in]	_parentName	The name of the parent link which the sensor is attached to.

Returns

The name of the sensor

void gazebo::sensors::SensorManager::Fini

(

)

Finalize all the sensors.

SensorPtr gazebo::sensors::SensorManager::GetSensor

(

const std::string &

_name

)

Get a sensor.

Parameters

[in]

_name

The name of a sensor to find.

Returns

A pointer to the sensor. NULL if not found.

Sensor_V gazebo::sensors::SensorManager::GetSensors

(

)

const

Get all the sensors.

Returns

Vector of all the sensors.

void gazebo::sensors::SensorManager::GetSensorTypes

(

std::vector< std::string > &

_types

)

const

Get all the sensor types.

Parameters

[out]

All

the sensor types.

void gazebo::sensors::SensorManager::Init

(

)

Init all the sensors.

void gazebo::sensors::SensorManager::RemoveSensor

(

const std::string &

_name

)

Remove a sensor.

Parameters

[in]

_name

The name of the sensor to remove.

void gazebo::sensors::SensorManager::RemoveSensors

(

)

Remove all sensors.

void gazebo::sensors::SensorManager::Run

(

)

Run the sensor manager update in a new thread.

bool gazebo::sensors::SensorManager::SensorsInitialized

(

)

True if SensorManager::initSensors queue is empty i.e.

all sensors managed by SensorManager have been initialized

void gazebo::sensors::SensorManager::Stop

(

)

Stop the run thread.

void gazebo::sensors::SensorManager::Update

(

bool

_force = false

)

Update all the sensors.

Checks to see if any sensor need to be initialized first, then updates all sensors once.

Parameters

[in]

_force

True force update, false if not

---

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

• SensorManager.hh