##

WirelessTransmitter.hh
Go to the documentation of this file.
/*
* Copyright (C) 2012 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef _GAZEBO_SENSORS_WIRELESSTRANSMITTER_HH_
#define _GAZEBO_SENSORS_WIRELESSTRANSMITTER_HH_
#include <memory>
#include <string>
#include "gazebo/physics/physics.hh"
#include "gazebo/sensors/WirelessTransceiver.hh"
#include "gazebo/transport/TransportTypes.hh"
#include "gazebo/util/system.hh"
namespace gazebo
{
namespace sensors
{
// Forward declare private data class.
class WirelessTransmitterPrivate;
class GZ_SENSORS_VISIBLE WirelessTransmitter: public WirelessTransceiver
{
public: WirelessTransmitter();
public: virtual ~WirelessTransmitter();
// Documentation inherited
protected: virtual bool UpdateImpl(const bool _force);
// Documentation inherited
public: virtual void Load(const std::string &_worldName);
// Documentation inherited
public: virtual void Init();
public: std::string ESSID() const;
public: double Freq() const;
public: double SignalStrength(const ignition::math::Pose3d &_receiver,
const double _rxGain);
public: double ModelStdDev() const;
private: std::unique_ptr<WirelessTransmitterPrivate> dataPtr;
};
}
}
#endif
gazebo::sensors::WirelessTransmitter::Load
virtual void Load(const std::string &_worldName)
Load the sensor with default parameters.
gazebo::sensors::WirelessTransmitter::Freq
double Freq() const
Returns reception frequency (MHz).
gazebo
Forward declarations for the common classes.
Definition: Animation.hh:26
gazebo::sensors::WirelessTransmitter::SignalStrength
double SignalStrength(const ignition::math::Pose3d &_receiver, const double _rxGain)
Returns the signal strength in a given world's point (dBm).
sensors
sensors
Definition: SensorManager.hh:35
TransportTypes.hh
Forward declarations for transport.
system.hh
WirelessTransceiver.hh
gazebo::sensors::WirelessTransmitter::ESSID
std::string ESSID() const
Returns the Service Set Identifier (network name).
gazebo::sensors::WirelessTransmitter::~WirelessTransmitter
virtual ~WirelessTransmitter()
Destructor.
gazebo::sensors::WirelessTransmitter::ModelStdDev
double ModelStdDev() const
Get the std dev of the Gaussian random variable used in the propagation model.
gazebo::sensors::WirelessTransmitter
Transmitter to send wireless signals.
Definition: WirelessTransmitter.hh:39
gazebo::msgs::Init
GAZEBO_VISIBLE void Init(google::protobuf::Message &_message, const std::string &_id="")
Initialize a message.
gazebo::sensors::WirelessTransmitter::WirelessTransmitter
WirelessTransmitter()
Constructor.
gazebo::sensors::WirelessTransceiver
Sensor class for receiving wireless signals.
Definition: WirelessTransceiver.hh:37
gazebo::sensors::WirelessTransmitter::Init
virtual void Init()
Initialize the sensor.
gazebo::sensors::WirelessTransmitter::UpdateImpl
virtual bool UpdateImpl(const bool _force)
This gets overwritten by derived sensor types.