Base class for sensors. More...

#include <sensors/sensors.hh>

Inheritance diagram for gazebo::sensors::Sensor:

Public Member Functions
	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.
virtual void	Fini ()
	Finalize the sensor.
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.
virtual std::string	GetTopic () const
	Returns the topic name as set in SDF.
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	Init ()
	Initialize the sensor.
virtual bool	IsActive ()
	Returns true if sensor generation is active.
virtual void	Load (const std::string &_worldName, sdf::ElementPtr _sdf)
	Load the sensor with SDF parameters.
virtual void	Load (const std::string &_worldName)
	Load the sensor with default 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	UpdateImpl (bool)
	This gets overwritten by derived sensor types.

Protected Attributes
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

Base class for sensors.

Constructor & Destructor Documentation

gazebo::sensors::Sensor::Sensor ( SensorCategory _cat )

explicit

Constructor.

Parameters

[in] _class

virtual gazebo::sensors::Sensor::~Sensor ( )

virtual

Destructor.

Member Function Documentation

template<typename T >

event::ConnectionPtr gazebo::sensors::Sensor::ConnectUpdated ( T _subscriber )

inline

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

Parameters

[in] _subscriber Callback that receives the signal.

Returns: A pointer to the connection. This must be kept in scope.

See Also: Sensor::DisconnectUpdated

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

void gazebo::sensors::Sensor::DisconnectUpdated ( event::ConnectionPtr & _c )

inline

Disconnect from a the updated signal.

Parameters

[in] _c The connection to disconnect

See Also: Sensor::ConnectUpdated

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

void gazebo::sensors::Sensor::FillMsg ( msgs::Sensor & _msg )

fills a msgs::Sensor message.

Parameters

[out] _msg Message to fill.

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

virtual

Finalize the sensor.

Reimplemented in gazebo::sensors::MultiCameraSensor, gazebo::sensors::ForceTorqueSensor, gazebo::sensors::CameraSensor, gazebo::sensors::GpuRaySensor, gazebo::sensors::ContactSensor, gazebo::sensors::DepthCameraSensor, gazebo::sensors::RFIDSensor, gazebo::sensors::RaySensor, gazebo::sensors::RFIDTag, gazebo::sensors::SonarSensor, and gazebo::sensors::ImuSensor.

SensorCategory gazebo::sensors::Sensor::GetCategory ( ) const

Get the category of the sensor.

Returns: The category of the sensor.

See Also: SensorCategory

common::Time gazebo::sensors::Sensor::GetLastMeasurementTime ( )

Return last measurement time.

Returns: Time of last measurement.

common::Time gazebo::sensors::Sensor::GetLastUpdateTime ( )

Return last update time.

Returns: Time of last update.

std::string gazebo::sensors::Sensor::GetName ( ) const

Get name.

Returns: Name of sensor.

std::string gazebo::sensors::Sensor::GetParentName ( ) const

Returns the name of the sensor parent.

The parent name is set by Sensor::SetParent.

Returns: Name of Parent.

virtual math::Pose gazebo::sensors::Sensor::GetPose ( ) const

virtual

Get the current pose.

Returns: Current pose of the sensor.

std::string gazebo::sensors::Sensor::GetScopedName ( ) const

Get fully scoped name of the sensor.

Returns: world_name::parent_name::sensor_name.

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

virtual

Returns the topic name as set in SDF.

Returns: Topic name.

Reimplemented in gazebo::sensors::GpuRaySensor, gazebo::sensors::RaySensor, gazebo::sensors::CameraSensor, gazebo::sensors::SonarSensor, gazebo::sensors::MultiCameraSensor, and gazebo::sensors::ForceTorqueSensor.

std::string gazebo::sensors::Sensor::GetType ( ) const

Get sensor type.

Returns: Type of sensor.

double gazebo::sensors::Sensor::GetUpdateRate ( )

Get the update rate of the sensor.

Returns: _hz update rate of sensor. Returns 0 if unthrottled.

bool gazebo::sensors::Sensor::GetVisualize ( ) const

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 gazebo::sensors::Sensor::GetWorldName ( ) const

Returns the name of the world the sensor is in.

Returns: Name of the world.

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

virtual

Initialize the sensor.

Reimplemented in gazebo::sensors::GpuRaySensor, gazebo::sensors::ContactSensor, gazebo::sensors::CameraSensor, gazebo::sensors::DepthCameraSensor, gazebo::sensors::RFIDSensor, gazebo::sensors::RaySensor, gazebo::sensors::RFIDTag, gazebo::sensors::SonarSensor, gazebo::sensors::MultiCameraSensor, gazebo::sensors::ImuSensor, and gazebo::sensors::ForceTorqueSensor.

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

virtual

Returns true if sensor generation is active.

Returns: True if active, false if not.

Reimplemented in gazebo::sensors::GpuRaySensor, gazebo::sensors::RaySensor, gazebo::sensors::ContactSensor, gazebo::sensors::CameraSensor, gazebo::sensors::MultiCameraSensor, gazebo::sensors::SonarSensor, gazebo::sensors::ImuSensor, and gazebo::sensors::ForceTorqueSensor.

virtual void gazebo::sensors::Sensor::Load	(	const std::string &	_worldName,
		sdf::ElementPtr	_sdf
	)

virtual

Load the sensor with SDF parameters.

Parameters

[in]	_sdf	SDF Sensor parameters.
[in]	_worldName	Name of world to load from.

Reimplemented in gazebo::sensors::ContactSensor, gazebo::sensors::CameraSensor, gazebo::sensors::RFIDSensor, and gazebo::sensors::ImuSensor.

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

virtual

Load the sensor with default parameters.

Parameters

[in] _worldName Name of world to load from.

Reimplemented in gazebo::sensors::GpuRaySensor, gazebo::sensors::ContactSensor, gazebo::sensors::CameraSensor, gazebo::sensors::DepthCameraSensor, gazebo::sensors::RFIDSensor, gazebo::sensors::RaySensor, gazebo::sensors::RFIDTag, gazebo::sensors::SonarSensor, gazebo::sensors::MultiCameraSensor, gazebo::sensors::ImuSensor, and gazebo::sensors::ForceTorqueSensor.

void gazebo::sensors::Sensor::ResetLastUpdateTime ( )

Reset the lastUpdateTime to zero.

virtual void gazebo::sensors::Sensor::SetActive ( bool _value )

virtual

Set whether the sensor is active or not.

Parameters

[in] _value True if active, false if not.

Reimplemented in gazebo::sensors::DepthCameraSensor.

virtual void gazebo::sensors::Sensor::SetParent ( const std::string & _name )

virtual

Set the parent of the sensor.

Parameters

[in] _name Name of the parent.

Reimplemented in gazebo::sensors::CameraSensor, and gazebo::sensors::DepthCameraSensor.

void gazebo::sensors::Sensor::SetUpdateRate ( double _hz )

Set the update rate of the sensor.

Parameters

[in] _hz update rate of sensor.

void gazebo::sensors::Sensor::Update ( bool _force )

Update the sensor.

Parameters

[in] _force True to force update, false otherwise.

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

inlineprotectedvirtual

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 in gazebo::sensors::MultiCameraSensor, gazebo::sensors::ForceTorqueSensor, gazebo::sensors::CameraSensor, gazebo::sensors::GpuRaySensor, gazebo::sensors::ContactSensor, gazebo::sensors::DepthCameraSensor, gazebo::sensors::RFIDSensor, gazebo::sensors::RaySensor, gazebo::sensors::RFIDTag, gazebo::sensors::SonarSensor, and gazebo::sensors::ImuSensor.

Member Data Documentation

bool gazebo::sensors::Sensor::active

protected

True if sensor generation is active.

std::vector<event::ConnectionPtr> gazebo::sensors::Sensor::connections

protected

All event connections.

common::Time gazebo::sensors::Sensor::lastMeasurementTime

protected

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

common::Time gazebo::sensors::Sensor::lastUpdateTime

protected

Time of the last update.

transport::NodePtr gazebo::sensors::Sensor::node

protected

Node for communication.

std::string gazebo::sensors::Sensor::parentName

protected

Name of the parent.

std::vector<SensorPluginPtr> gazebo::sensors::Sensor::plugins

protected

All the plugins for the sensor.

math::Pose gazebo::sensors::Sensor::pose

protected

Pose of the sensor.

transport::SubscriberPtr gazebo::sensors::Sensor::poseSub

protected

Subscribe to pose updates.

sdf::ElementPtr gazebo::sensors::Sensor::sdf

protected

Pointer the the SDF element for the sensor.

common::Time gazebo::sensors::Sensor::updatePeriod

protected

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

gazebo::physics::WorldPtr gazebo::sensors::Sensor::world

protected

Pointer to the world.

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

Sensor.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation