All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Files | Namespaces | Classes | Macros | Functions

A set of sensor classes, functions, and definitions. More...


file  SensorTypes.hh
 Forward declarations and typedefs for sensors.


namespace  gazebo::sensors
 Sensors namespace.


class  gazebo::sensors::CameraSensor
class  gazebo::sensors::ContactSensor
class  gazebo::sensors::DepthCameraSensor
class  gazebo::sensors::GpuRaySensor
class  gazebo::sensors::ImuSensor
 An IMU sensor. More...
class  gazebo::sensors::RaySensor
class  gazebo::sensors::RFIDSensor
 Sensor class for RFID type of sensor. More...
class  gazebo::sensors::RFIDTag
 RFIDTag to interact with RFIDTagSensors Nate check. More...
class  gazebo::sensors::RFIDTagManager
 Nate fill in More...
class  gazebo::sensors::Sensor
class  SensorFactor
 The sensor factory; the class is just for namespacing purposes. More...
class  gazebo::sensors::SensorFactory
class  gazebo::sensors::SensorManager
 Class to manage and update all sensors. More...


#define GZ_REGISTER_STATIC_SENSOR(name, classname)
 Static sensor registration macro.


std::string gazebo::sensors::create_sensor (sdf::ElementPtr _elem, const std::string &_worldName, const std::string &_parentName)
 Create a sensor using SDF.
bool gazebo::sensors::fini ()
 shutdown the sensor generation loop.
SensorPtr gazebo::sensors::get_sensor (const std::string &_name)
 Get a sensor using by name.
bool gazebo::sensors::init ()
 initialize the sensor generation loop.
bool gazebo::sensors::load ()
void gazebo::sensors::remove_sensor (const std::string &_sensorName)
 Remove a sensor by name.
bool gazebo::sensors::remove_sensors ()
 Remove all sensors.
void gazebo::sensors::run ()
 Run sensor generation continuously. This is a blocking call.
void gazebo::sensors::run_once (bool _force=true)
 Run the sensor generation one step.
void gazebo::sensors::stop ()
 Stop the sensor generation loop.

Detailed Description

A set of sensor classes, functions, and definitions.

Load the sensor library.

class Sensor Sensor.hh sensors/sensors.hh

Sensor with one or more rays.

This class inherits from Sensor, but looks like it specifically doesn't override any methods, is this intentional? i.e.

GPU based laser sensor.

Contact sensor.

Basic camera sensor This sensor is used for simulating standard monocular cameras

This sensor detects and reports contacts between objects

Depth camera sensor This sensor is used for simulating standard monocular cameras

This sensor cast rays into the world, tests for intersections, and reports the range to the nearest object. It is used by ranging sensor models (e.g., sonars and scanning laser range finders).

LoadChild instead of Load, InitChild instead of Init

Base class for sensors

True if successfully loaded, false if not Nate check

Macro Definition Documentation

Sensor *New##classname() \
{ \
return new gazebo::sensors::classname(); \
} \
void Register##classname() \
SensorFactory::RegisterSensor(name, New##classname);\

Static sensor registration macro.

Use this macro to register sensors with the server.

nameSensor type name, as it appears in the world file.
classnameC++ class name for the sensor.

Function Documentation

std::string gazebo::sensors::create_sensor ( sdf::ElementPtr  _elem,
const std::string &  _worldName,
const std::string &  _parentName 

Create a sensor using SDF.

[in]_elemThe SDF element that describes the sensor
[in]_worldNameName of the world in which to create the sensor
[in]_parentNameThe fully scoped parent name (model::link)
The name of the new sensor
bool gazebo::sensors::fini ( )

shutdown the sensor generation loop.

True if successfully finalized, false if not
SensorPtr gazebo::sensors::get_sensor ( const std::string &  _name)

Get a sensor using by name.

The given name should have: world_name::model_name::link_name::sensor_name

[in]_nameName of the sensor. This name should be fully scoped. This means _name = world_name::model_name::link_name::sensor_name. You may use the unscoped sensor name if that name is unique within the entire simulation. If the name is not unique a NULL pointer is returned.
Pointer to the sensor, NULL if the sensor could not be found.
bool gazebo::sensors::init ( )

initialize the sensor generation loop.

True if successfully initialized, false if not
bool gazebo::sensors::load ( )
void gazebo::sensors::remove_sensor ( const std::string &  _sensorName)

Remove a sensor by name.

[in]_sensorNameName of sensor to remove
bool gazebo::sensors::remove_sensors ( )

Remove all sensors.

True if all successfully removed, false if not
void gazebo::sensors::run ( )

Run sensor generation continuously. This is a blocking call.

void gazebo::sensors::run_once ( bool  _force = true)

Run the sensor generation one step.

_force,:If true, all sensors are forced to update. Otherwise a sensor will update based on it's Hz rate.
void gazebo::sensors::stop ( )

Stop the sensor generation loop.