SonarSensor.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012-2016 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_SONARSENSOR_HH_
#define _GAZEBO_SENSORS_SONARSENSOR_HH_

#include <memory>
#include <string>

#include "gazebo/sensors/Sensor.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace sensors
  {
    // Forward declare private data class.
    class SonarSensorPrivate;


    class GAZEBO_VISIBLE SonarSensor: public Sensor
    {
      public: SonarSensor();

      public: virtual ~SonarSensor();

      // Documentation inherited
      public: virtual void Load(const std::string &_worldName);

      // Documentation inherited
      public: virtual void Init();

      // Documentation inherited
      public: virtual std::string Topic() const;

      public: double GetRangeMin() const GAZEBO_DEPRECATED(7.0);

      public: double RangeMin() const;

      public: double GetRangeMax() const GAZEBO_DEPRECATED(7.0);

      public: double RangeMax() const;

      public: double GetRadius() const GAZEBO_DEPRECATED(7.0);

      public: double Radius() const;

      public: double GetRange() GAZEBO_DEPRECATED(7.0);

      public: double Range();


      // Documentation inherited
      public: virtual bool IsActive() const;

      public: event::ConnectionPtr ConnectUpdate(
                  std::function<void (msgs::SonarStamped)> _subscriber);

      public: void DisconnectUpdate(event::ConnectionPtr &_conn);

      // Documentation inherited
      protected: virtual bool UpdateImpl(const bool _force);

      // Documentation inherited
      protected: virtual void Fini();

      private: void OnContacts(ConstContactsPtr &_msg);

      private: std::unique_ptr<SonarSensorPrivate> dataPtr;
    };
  }
}
#endif