WirelessTransmitter.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012-2016 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 
27 namespace gazebo
28 {
29  namespace sensors
30  {
31  // Forward declare private data class.
32  class WirelessTransmitterPrivate;
33 
36 
40  {
42  public: WirelessTransmitter();
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 
59  public: std::string GetESSID() const GAZEBO_DEPRECATED(7.0);
60 
63  public: std::string ESSID() const;
64 
68  public: double GetFreq() const GAZEBO_DEPRECATED(7.0);
69 
72  public: double Freq() const;
73 
78  public: double SignalStrength(const ignition::math::Pose3d &_receiver,
79  const double _rxGain);
80 
84  public: double ModelStdDev() const;
85 
88  private: std::unique_ptr<WirelessTransmitterPrivate> dataPtr;
89  };
91  }
92 }
93 #endif
Sensor class for receiving wireless signals.
Definition: WirelessTransceiver.hh:37
Forward declarations for the common classes.
Definition: Animation.hh:33
Forward declarations for transport.
Transmitter to send wireless signals.
Definition: WirelessTransmitter.hh:39
#define GAZEBO_DEPRECATED(version)
Definition: CommonTypes.hh:48
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
#define GAZEBO_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system.hh:59