WirelessTransmitter.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2012 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16*/
17#ifndef _GAZEBO_SENSORS_WIRELESSTRANSMITTER_HH_
18#define _GAZEBO_SENSORS_WIRELESSTRANSMITTER_HH_
19
20#include <memory>
21#include <string>
22#include "gazebo/physics/physics.hh"
25#include "gazebo/util/system.hh"
26
27namespace gazebo
28{
29 namespace sensors
30 {
31 // Forward declare private data class.
32 class WirelessTransmitterPrivate;
33
36
39 class GZ_SENSORS_VISIBLE WirelessTransmitter: public WirelessTransceiver
40 {
43
45 public: virtual ~WirelessTransmitter();
46
47 // Documentation inherited
48 protected: virtual bool UpdateImpl(const bool _force);
49
50 // Documentation inherited
51 public: virtual void Load(const std::string &_worldName);
52
53 // Documentation inherited
54 public: virtual void Init();
55
58 public: std::string ESSID() const;
59
62 public: double Freq() const;
63
68 public: double SignalStrength(const ignition::math::Pose3d &_receiver,
69 const double _rxGain);
70
74 public: double ModelStdDev() const;
75
78 private: std::unique_ptr<WirelessTransmitterPrivate> dataPtr;
79 };
81 }
82}
83#endif
sensors
Definition SensorManager.hh:35
Forward declarations for transport.
Sensor class for receiving wireless signals.
Definition WirelessTransceiver.hh:38
Transmitter to send wireless signals.
Definition WirelessTransmitter.hh:40
double SignalStrength(const ignition::math::Pose3d &_receiver, const double _rxGain)
Returns the signal strength in a given world's point (dBm).
double ModelStdDev() const
Get the std dev of the Gaussian random variable used in the propagation model.
virtual void Init()
Initialize the sensor.
std::string ESSID() const
Returns the Service Set Identifier (network name).
virtual void Load(const std::string &_worldName)
Load the sensor with default parameters.
double Freq() const
Returns reception frequency (MHz).
virtual bool UpdateImpl(const bool _force)
This gets overwritten by derived sensor types.
virtual ~WirelessTransmitter()
Destructor.
Forward declarations for the common classes.
Definition Animation.hh:27