#include <sensors/sensors.hh>

Inheritance diagram for gazebo::sensors::SonarSensor:

Public Member Functions
	SonarSensor ()
	Constructor.
virtual	~SonarSensor ()
	Destructor.
template<typename T >
event::ConnectionPtr	ConnectUpdate (T _subscriber)
	Connect a to the new update signal.
void	DisconnectUpdate (event::ConnectionPtr &_conn)
	Disconnect from the update signal.
double	GetRadius () const
	Get the radius of the sonar cone at maximum range.
double	GetRange ()
	Get detected range for a sonar.
double	GetRangeMax () const
	Get the minimum range of the sonar.
double	GetRangeMin () const
	Get the minimum range of the sonar.
virtual std::string	GetTopic () const
	Returns the topic name as set in SDF.
virtual void	Init ()
	Initialize the sensor.
virtual bool	IsActive ()
	Returns true if sensor generation is active.
virtual void	Load (const std::string &_worldName)
	Load the sensor with default parameters.
Public Member Functions inherited from gazebo::sensors::Sensor
	Sensor (SensorCategory _cat)
	Constructor.
virtual	~Sensor ()
	Destructor.
template<typename T >
event::ConnectionPtr	ConnectUpdated (T _subscriber)
	Connect a signal that is triggered when the sensor is updated.
void	DisconnectUpdated (event::ConnectionPtr &_c)
	Disconnect from a the updated signal.
void	FillMsg (msgs::Sensor &_msg)
	fills a msgs::Sensor message.
SensorCategory	GetCategory () const
	Get the category of the sensor.
common::Time	GetLastMeasurementTime ()
	Return last measurement time.
common::Time	GetLastUpdateTime ()
	Return last update time.
std::string	GetName () const
	Get name.
std::string	GetParentName () const
	Returns the name of the sensor parent.
virtual math::Pose	GetPose () const
	Get the current pose.
std::string	GetScopedName () const
	Get fully scoped name of the sensor.
std::string	GetType () const
	Get sensor type.
double	GetUpdateRate ()
	Get the update rate of the sensor.
bool	GetVisualize () const
	Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF.
std::string	GetWorldName () const
	Returns the name of the world the sensor is in.
virtual void	Load (const std::string &_worldName, sdf::ElementPtr _sdf)
	Load the sensor with SDF parameters.
void	ResetLastUpdateTime ()
	Reset the lastUpdateTime to zero.
virtual void	SetActive (bool _value)
	Set whether the sensor is active or not.
virtual void	SetParent (const std::string &_name)
	Set the parent of the sensor.
void	SetUpdateRate (double _hz)
	Set the update rate of the sensor.
void	Update (bool _force)
	Update the sensor.

Protected Member Functions
virtual void	Fini ()
	Finalize the sensor.
virtual void	UpdateImpl (bool _force)
	This gets overwritten by derived sensor types.

Protected Attributes
event::EventT< void(msgs::SonarStamped)>	update
	Update event.
Protected Attributes inherited from gazebo::sensors::Sensor
bool	active
	True if sensor generation is active.
std::vector< event::ConnectionPtr >	connections
	All event connections.
common::Time	lastMeasurementTime
	Stores last time that a sensor measurement was generated; this value must be updated within each sensor's UpdateImpl.
common::Time	lastUpdateTime
	Time of the last update.
transport::NodePtr	node
	Node for communication.
std::string	parentName
	Name of the parent.
std::vector< SensorPluginPtr >	plugins
	All the plugins for the sensor.
math::Pose	pose
	Pose of the sensor.
transport::SubscriberPtr	poseSub
	Subscribe to pose updates.
sdf::ElementPtr	sdf
	Pointer the the SDF element for the sensor.
common::Time	updatePeriod
	Desired time between updates, set indirectly by Sensor::SetUpdateRate.
gazebo::physics::WorldPtr	world
	Pointer to the world.

Detailed Description

Sensor with sonar cone.

This sensor uses a cone .

Constructor & Destructor Documentation

gazebo::sensors::SonarSensor::SonarSensor ( )

Constructor.

virtual gazebo::sensors::SonarSensor::~SonarSensor ( )

virtual

Destructor.

Member Function Documentation

template<typename T >

event::ConnectionPtr gazebo::sensors::SonarSensor::ConnectUpdate ( T _subscriber )

inline

Connect a to the new update signal.

Parameters

[in] _subscriber Callback function.

Returns: The connection, which must be kept in scope.

References gazebo::event::EventT< T >::Connect(), and update.

void gazebo::sensors::SonarSensor::DisconnectUpdate ( event::ConnectionPtr & _conn )

inline

Disconnect from the update signal.

Parameters

[in] _conn Connection to remove.

References gazebo::event::EventT< T >::Disconnect(), and update.

virtual void gazebo::sensors::SonarSensor::Fini ( )

protectedvirtual

Finalize the sensor.

Reimplemented from gazebo::sensors::Sensor.

double gazebo::sensors::SonarSensor::GetRadius ( ) const

Get the radius of the sonar cone at maximum range.

Returns: The radisu of the sonar cone at max range.

double gazebo::sensors::SonarSensor::GetRange ( )

Get detected range for a sonar.

    Warning: If you are accessing all the ray data in a loop
    it's possible that the Ray will update in the middle of
    your access loop. This means some data will come from one
    scan, and some from another scan. You can solve this
    problem by using SetActive(false) <your accessor loop>
    SetActive(true).

Returns: Returns DBL_MAX for no detection.

double gazebo::sensors::SonarSensor::GetRangeMax ( ) const

Get the minimum range of the sonar.

Returns: The sonar's maximum range.

double gazebo::sensors::SonarSensor::GetRangeMin ( ) const

Get the minimum range of the sonar.

Returns: The sonar's minimum range.

virtual std::string gazebo::sensors::SonarSensor::GetTopic ( ) const

virtual

Returns the topic name as set in SDF.

Returns: Topic name.

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::SonarSensor::Init ( )

virtual

Initialize the sensor.

Reimplemented from gazebo::sensors::Sensor.

virtual bool gazebo::sensors::SonarSensor::IsActive ( )

virtual

Returns true if sensor generation is active.

Returns: True if active, false if not.

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::SonarSensor::Load ( const std::string & _worldName )

virtual

Load the sensor with default parameters.

Parameters

[in] _worldName Name of world to load from.

Reimplemented from gazebo::sensors::Sensor.

virtual void gazebo::sensors::SonarSensor::UpdateImpl ( bool )

protectedvirtual

This gets overwritten by derived sensor types.

   This function is called during Sensor::Update.
   And in turn, Sensor::Update is called by
   SensorManager::Update

Parameters

[in] _force True if update is forced, false if not

Reimplemented from gazebo::sensors::Sensor.

Member Data Documentation

event::EventT<void(msgs::SonarStamped)> gazebo::sensors::SonarSensor::update

protected

Update event.

Referenced by ConnectUpdate(), and DisconnectUpdate().

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

SonarSensor.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation