WirelessReceiver.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_WIRELESSRECEIVER_HH_
18 #define _GAZEBO_SENSORS_WIRELESSRECEIVER_HH_
19 
20 #include <memory>
21 #include <string>
25 #include "gazebo/util/system.hh"
26 
27 namespace gazebo
28 {
29  namespace sensors
30  {
31  // Forward declare private data
32  class WirelessReceiverPrivate;
33 
36 
39  class GZ_SENSORS_VISIBLE WirelessReceiver: public WirelessTransceiver
40  {
42  public: WirelessReceiver();
43 
45  public: virtual ~WirelessReceiver();
46 
47  // Documentation inherited
48  public: virtual void Load(const std::string &_worldName);
49 
50  // Documentation inherited
51  public: virtual void Init();
52 
53  // Documentation inherited
54  public: virtual void Fini();
55 
58  public: double MinFreqFiltered() const;
59 
62  public: double MaxFreqFiltered() const;
63 
66  public: double Sensitivity() const;
67 
68  // Documentation inherited
69  protected: virtual bool UpdateImpl(const bool _force);
70 
73  private: std::unique_ptr<WirelessReceiverPrivate> dataPtr;
74  };
76  }
77 }
78 #endif
virtual void Fini()
Finalize the sensor.
Forward declarations for the common classes.
Definition: Animation.hh:26
Forward declarations for transport.
virtual void Init()
Initialize the sensor.
double Sensitivity() const
Returns the receiver sensitivity (dBm).
default namespace for gazebo
double MaxFreqFiltered() const
Returns the maximum frequency filtered (MHz).
virtual bool UpdateImpl(const bool _force)
This gets overwritten by derived sensor types.
virtual void Load(const std::string &_worldName)
Load the sensor with default parameters.
double MinFreqFiltered() const
Returns the minimum frequency filtered (MHz).
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
WirelessReceiver()
Constructor.
Sensor class for receiving wireless signals.
Definition: WirelessReceiver.hh:39
virtual ~WirelessReceiver()
Destructor.
Sensor class for receiving wireless signals.
Definition: WirelessTransceiver.hh:37