SonarSensor Class Reference

Sensor with sonar cone. More...

#include <sensors/sensors.hh>

Inherits Sensor.

Public Member Functions

 SonarSensor ()
 Constructor. More...
 
virtual ~SonarSensor ()
 Destructor. More...
 
SensorCategory Category () const
 Get the category of the sensor. More...
 
event::ConnectionPtr ConnectUpdate (std::function< void(msgs::SonarStamped)> _subscriber)
 Connect a to the new update signal. More...
 
event::ConnectionPtr ConnectUpdated (std::function< void()> _subscriber)
 Connect a signal that is triggered when the sensor is updated. More...
 
void FillMsg (msgs::Sensor &_msg)
 fills a msgs::Sensor message. More...
 
uint32_t Id () const
 Get the sensor's ID. More...
 
virtual void Init ()
 Initialize the sensor. More...
 
virtual bool IsActive () const
 Returns true if sensor generation is active. More...
 
common::Time LastMeasurementTime () const
 Return last measurement time. More...
 
common::Time LastUpdateTime () const
 Return last update time. More...
 
virtual void Load (const std::string &_worldName)
 Load the sensor with default parameters. More...
 
virtual void Load (const std::string &_worldName, sdf::ElementPtr _sdf)
 Load the sensor with SDF parameters. More...
 
std::string Name () const
 Get name. More...
 
NoisePtr Noise (const SensorNoiseType _type) const
 Get the sensor's noise model for a specified noise type. More...
 
uint32_t ParentId () const
 Get the sensor's parent's ID. More...
 
std::string ParentName () const
 Returns the name of the sensor parent. More...
 
virtual ignition::math::Pose3d Pose () const
 Get the current pose. More...
 
double Radius () const
 Get the radius of the sonar cone at maximum range. More...
 
double Range ()
 Get detected range for a sonar. More...
 
double RangeMax () const
 Get the minimum range of the sonar. More...
 
double RangeMin () const
 Get the minimum range of the sonar. More...
 
void ResetLastUpdateTime ()
 Reset the lastUpdateTime to zero. More...
 
std::string ScopedName () const
 Get fully scoped name of the sensor. More...
 
virtual void SetActive (const bool _value)
 Set whether the sensor is active or not. More...
 
void SetParent (const std::string &_name, const uint32_t _id)
 Set the sensor's parent. More...
 
virtual void SetPose (const ignition::math::Pose3d &_pose)
 Set the current pose. More...
 
void SetUpdateRate (const double _hz)
 Set the update rate of the sensor. More...
 
virtual std::string Topic () const
 Returns the topic name as set in SDF. More...
 
std::string Type () const
 Get sensor type. More...
 
void Update (const bool _force)
 Update the sensor. More...
 
double UpdateRate () const
 Get the update rate of the sensor. More...
 
bool Visualize () const
 Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF. More...
 
std::string WorldName () const
 Returns the name of the world the sensor is in. More...
 

Protected Member Functions

virtual void Fini ()
 Finalize the sensor. More...
 
bool NeedsUpdate ()
 Return true if the sensor needs to be updated. More...
 
virtual bool UpdateImpl (const bool _force)
 This gets overwritten by derived sensor types. More...
 

Protected Attributes

bool active
 True if sensor generation is active. More...
 
std::vector< event::ConnectionPtrconnections
 All event connections. More...
 
common::Time lastMeasurementTime
 Stores last time that a sensor measurement was generated; this value must be updated within each sensor's UpdateImpl. More...
 
common::Time lastUpdateTime
 Time of the last update. More...
 
transport::NodePtr node
 Node for communication. More...
 
ignition::transport::Node nodeIgn
 Ignition transport node. More...
 
std::map< SensorNoiseType, NoisePtrnoises
 Noise added to sensor data. More...
 
uint32_t parentId
 The sensor's parent ID. More...
 
std::string parentName
 Name of the parent. More...
 
std::vector< SensorPluginPtrplugins
 All the plugins for the sensor. More...
 
ignition::math::Pose3d pose
 Pose of the sensor. More...
 
gazebo::rendering::ScenePtr scene
 Pointer to the Scene. More...
 
sdf::ElementPtr sdf
 Pointer the the SDF element for the sensor. More...
 
common::Time updatePeriod
 Desired time between updates, set indirectly by Sensor::SetUpdateRate. More...
 
gazebo::physics::WorldPtr world
 Pointer to the world. More...
 

Detailed Description

Sensor with sonar cone.

This sensor uses a cone .

Constructor & Destructor Documentation

Constructor.

virtual ~SonarSensor ( )
virtual

Destructor.

Member Function Documentation

SensorCategory Category ( ) const
inherited

Get the category of the sensor.

Returns
The category of the sensor.
See also
SensorCategory
event::ConnectionPtr ConnectUpdate ( std::function< void(msgs::SonarStamped)>  _subscriber)

Connect a to the new update signal.

Parameters
[in]_subscriberCallback function.
Returns
The connection, which must be kept in scope.
event::ConnectionPtr ConnectUpdated ( std::function< void()>  _subscriber)
inherited

Connect a signal that is triggered when the sensor is updated.

Parameters
[in]_subscriberCallback that receives the signal.
Returns
A pointer to the connection. This must be kept in scope.
See also
Sensor::DisconnectUpdated
void FillMsg ( msgs::Sensor &  _msg)
inherited

fills a msgs::Sensor message.

Parameters
[out]_msgMessage to fill.
virtual void Fini ( )
protectedvirtual

Finalize the sensor.

Reimplemented from Sensor.

uint32_t Id ( ) const
inherited

Get the sensor's ID.

Returns
The sensor's ID.
virtual void Init ( )
virtual

Initialize the sensor.

Reimplemented from Sensor.

virtual bool IsActive ( ) const
virtual

Returns true if sensor generation is active.

Returns
True if active, false if not.

Reimplemented from Sensor.

common::Time LastMeasurementTime ( ) const
inherited

Return last measurement time.

Returns
Time of last measurement.
common::Time LastUpdateTime ( ) const
inherited

Return last update time.

Returns
Time of last update.
virtual void Load ( const std::string &  _worldName)
virtual

Load the sensor with default parameters.

Parameters
[in]_worldNameName of world to load from.

Reimplemented from Sensor.

virtual void Load ( const std::string &  _worldName,
sdf::ElementPtr  _sdf 
)
virtualinherited

Load the sensor with SDF parameters.

Parameters
[in]_sdfSDF Sensor parameters.
[in]_worldNameName of world to load from.

Reimplemented in GpuRaySensor, ContactSensor, CameraSensor, ForceTorqueSensor, AltimeterSensor, GpsSensor, LogicalCameraSensor, RFIDSensor, ImuSensor, MagnetometerSensor, and RFIDTag.

std::string Name ( ) const
inherited

Get name.

Returns
Name of sensor.
bool NeedsUpdate ( )
protectedinherited

Return true if the sensor needs to be updated.

Returns
True when sensor should be updated.
NoisePtr Noise ( const SensorNoiseType  _type) const
inherited

Get the sensor's noise model for a specified noise type.

Parameters
[in]_typeIndex of the noise type. Refer to SensorNoiseType enumeration for possible indices
Returns
The sensor's noise model for the given noise type
uint32_t ParentId ( ) const
inherited

Get the sensor's parent's ID.

Returns
The sensor's parent's ID.
std::string ParentName ( ) const
inherited

Returns the name of the sensor parent.

The parent name is set by Sensor::SetParent.

Returns
Name of Parent.
virtual ignition::math::Pose3d Pose ( ) const
virtualinherited

Get the current pose.

Returns
Current pose of the sensor.
See also
SetPose()
double Radius ( ) const

Get the radius of the sonar cone at maximum range.

Returns
The radius of the sonar cone at max range.
double Range ( )

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 RangeMax ( ) const

Get the minimum range of the sonar.

Returns
The sonar's maximum range.
double RangeMin ( ) const

Get the minimum range of the sonar.

Returns
The sonar's minimum range.
void ResetLastUpdateTime ( )
inherited

Reset the lastUpdateTime to zero.

std::string ScopedName ( ) const
inherited

Get fully scoped name of the sensor.

Returns
world_name::model_name::link_name::sensor_name.
virtual void SetActive ( const bool  _value)
virtualinherited

Set whether the sensor is active or not.

Parameters
[in]_valueTrue if active, false if not.
void SetParent ( const std::string &  _name,
const uint32_t  _id 
)
inherited

Set the sensor's parent.

Parameters
[in]_nameThe sensor's parent's name.
[in]_idThe sensor's parent's ID.
virtual void SetPose ( const ignition::math::Pose3d &  _pose)
virtualinherited

Set the current pose.

Parameters
[in]_poseNew pose of the sensor.
See also
Pose()
void SetUpdateRate ( const double  _hz)
inherited

Set the update rate of the sensor.

Parameters
[in]_hzupdate rate of sensor.
virtual std::string Topic ( ) const
virtual

Returns the topic name as set in SDF.

Returns
Topic name.

Reimplemented from Sensor.

std::string Type ( ) const
inherited

Get sensor type.

Returns
Type of sensor.
void Update ( const bool  _force)
inherited

Update the sensor.

Parameters
[in]_forceTrue to force update, false otherwise.
virtual bool UpdateImpl ( const 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]_forceTrue if update is forced, false if not
Returns
True if the sensor was updated.

Reimplemented from Sensor.

double UpdateRate ( ) const
inherited

Get the update rate of the sensor.

Returns
_hz update rate of sensor. Returns 0 if unthrottled.
bool Visualize ( ) const
inherited

Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF.

Returns
True if visualized, false if not.
std::string WorldName ( ) const
inherited

Returns the name of the world the sensor is in.

Returns
Name of the world.

Member Data Documentation

bool active
protectedinherited

True if sensor generation is active.

std::vector<event::ConnectionPtr> connections
protectedinherited

All event connections.

common::Time lastMeasurementTime
protectedinherited

Stores last time that a sensor measurement was generated; this value must be updated within each sensor's UpdateImpl.

common::Time lastUpdateTime
protectedinherited

Time of the last update.

transport::NodePtr node
protectedinherited

Node for communication.

ignition::transport::Node nodeIgn
protectedinherited

Ignition transport node.

std::map<SensorNoiseType, NoisePtr> noises
protectedinherited

Noise added to sensor data.

uint32_t parentId
protectedinherited

The sensor's parent ID.

std::string parentName
protectedinherited

Name of the parent.

std::vector<SensorPluginPtr> plugins
protectedinherited

All the plugins for the sensor.

ignition::math::Pose3d pose
protectedinherited

Pose of the sensor.

gazebo::rendering::ScenePtr scene
protectedinherited

Pointer to the Scene.

sdf::ElementPtr sdf
protectedinherited

Pointer the the SDF element for the sensor.

common::Time updatePeriod
protectedinherited

Desired time between updates, set indirectly by Sensor::SetUpdateRate.

gazebo::physics::WorldPtr world
protectedinherited

Pointer to the world.


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