All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
gazebo::sensors::WirelessTransceiver Class Reference

Sensor class for receiving wireless signals. More...

#include <sensors/sensors.hh>

Inheritance diagram for gazebo::sensors::WirelessTransceiver:
Inheritance graph
[legend]

Public Member Functions

 WirelessTransceiver ()
 Constructor. More...
 
 ~WirelessTransceiver ()
 Constructor. More...
 
virtual void Fini ()
 Finalize the sensor. More...
 
double GetGain () const
 Returns the antenna's gain of the receiver (dBi). More...
 
double GetPower () const
 Returns the receiver power (dBm). More...
 
virtual std::string GetTopic () const
 Returns the topic name as set in SDF. More...
 
virtual void Init ()
 Initialize the sensor. More...
 
virtual void Load (const std::string &_worldName)
 Load the sensor with default parameters. More...
 
- Public Member Functions inherited from gazebo::sensors::Sensor
 Sensor (SensorCategory _cat)
 Constructor. More...
 
virtual ~Sensor ()
 Destructor. More...
 
template<typename T >
event::ConnectionPtr ConnectUpdated (T _subscriber)
 Connect a signal that is triggered when the sensor is updated. More...
 
void DisconnectUpdated (event::ConnectionPtr &_c)
 Disconnect from a the updated signal. More...
 
void FillMsg (msgs::Sensor &_msg)
 fills a msgs::Sensor message. More...
 
SensorCategory GetCategory () const
 Get the category of the sensor. More...
 
uint32_t GetId () const
 Get the sensor's ID. More...
 
common::Time GetLastMeasurementTime ()
 Return last measurement time. More...
 
common::Time GetLastUpdateTime ()
 Return last update time. More...
 
std::string GetName () const
 Get name. More...
 
uint32_t GetParentId () const
 Get the sensor's parent's ID. More...
 
std::string GetParentName () const
 Returns the name of the sensor parent. More...
 
virtual math::Pose GetPose () const
 Get the current pose. More...
 
std::string GetScopedName () const
 Get fully scoped name of the sensor. More...
 
std::string GetType () const
 Get sensor type. More...
 
double GetUpdateRate ()
 Get the update rate of the sensor. More...
 
bool GetVisualize () const
 Return true if user requests the sensor to be visualized via tag: <visualize>true</visualize> in SDF. More...
 
std::string GetWorldName () const
 Returns the name of the world the sensor is in. More...
 
virtual bool IsActive ()
 Returns true if sensor generation is active. More...
 
virtual void Load (const std::string &_worldName, sdf::ElementPtr _sdf)
 Load the sensor with SDF parameters. More...
 
void ResetLastUpdateTime ()
 Reset the lastUpdateTime to zero. More...
 
virtual void SetActive (bool _value)
 Set whether the sensor is active or not. More...
 
virtual void SetParent (const std::string &_name) GAZEBO_DEPRECATED(1.10)
 Set the parent of the sensor. More...
 
void SetParent (const std::string &_name, uint32_t _id)
 Set the sensor's parent. More...
 
void SetUpdateRate (double _hz)
 Set the update rate of the sensor. More...
 
void Update (bool _force)
 Update the sensor. More...
 

Protected Attributes

double gain
 Antenna's gain of the receiver (dBi). More...
 
boost::weak_ptr< physics::LinkparentEntity
 Parent entity which the sensor is attached to. More...
 
double power
 Receiver's power (dBm). More...
 
transport::PublisherPtr pub
 Publisher to publish propagation model data. More...
 
math::Pose referencePose
 Sensor reference pose. More...
 
- Protected Attributes inherited from gazebo::sensors::Sensor
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...
 
boost::mutex mutexLastUpdateTime
 Mutex to protect resetting lastUpdateTime. More...
 
transport::NodePtr node
 Node for communication. 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...
 
math::Pose pose
 Pose of the sensor. More...
 
transport::SubscriberPtr poseSub
 Subscribe to pose updates. 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...
 

Additional Inherited Members

- Protected Member Functions inherited from gazebo::sensors::Sensor
virtual void UpdateImpl (bool)
 This gets overwritten by derived sensor types. More...
 

Detailed Description

Sensor class for receiving wireless signals.

Constructor & Destructor Documentation

gazebo::sensors::WirelessTransceiver::WirelessTransceiver ( )

Constructor.

gazebo::sensors::WirelessTransceiver::~WirelessTransceiver ( )

Constructor.

Member Function Documentation

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

Finalize the sensor.

Reimplemented from gazebo::sensors::Sensor.

Reimplemented in gazebo::sensors::WirelessReceiver.

double gazebo::sensors::WirelessTransceiver::GetGain ( ) const

Returns the antenna's gain of the receiver (dBi).

Returns
Antenna's gain of the receiver (dBi).
double gazebo::sensors::WirelessTransceiver::GetPower ( ) const

Returns the receiver power (dBm).

Returns
Receiver power (dBm).
virtual std::string gazebo::sensors::WirelessTransceiver::GetTopic ( ) const
virtual

Returns the topic name as set in SDF.

Returns
Topic name.

Reimplemented from gazebo::sensors::Sensor.

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

Initialize the sensor.

Reimplemented from gazebo::sensors::Sensor.

Reimplemented in gazebo::sensors::WirelessTransmitter, and gazebo::sensors::WirelessReceiver.

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

Load the sensor with default parameters.

Parameters
[in]_worldNameName of world to load from.

Reimplemented from gazebo::sensors::Sensor.

Reimplemented in gazebo::sensors::WirelessTransmitter, and gazebo::sensors::WirelessReceiver.

Member Data Documentation

double gazebo::sensors::WirelessTransceiver::gain
protected

Antenna's gain of the receiver (dBi).

boost::weak_ptr<physics::Link> gazebo::sensors::WirelessTransceiver::parentEntity
protected

Parent entity which the sensor is attached to.

double gazebo::sensors::WirelessTransceiver::power
protected

Receiver's power (dBm).

transport::PublisherPtr gazebo::sensors::WirelessTransceiver::pub
protected

Publisher to publish propagation model data.

math::Pose gazebo::sensors::WirelessTransceiver::referencePose
protected

Sensor reference pose.


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