RaySensor.hh

Go to the documentation of this file.

/*
 * Copyright 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.
 *
*/
/* Desc: RaySensor proximity sensor
 * Author: Nate Koenig
 * Date: 23 february 2004
*/

#ifndef _RAYSENSOR_HH_
#define _RAYSENSOR_HH_

#include <vector>
#include <string>

#include "gazebo/math/Angle.hh"
#include "gazebo/math/Pose.hh"
#include "gazebo/transport/TransportTypes.hh"
#include "gazebo/sensors/Sensor.hh"

namespace gazebo
{
  class OgreDynamicLines;
  class Collision;
  class MultiRayShape;

  namespace sensors
  {

    class RaySensor: public Sensor
    {
      public: RaySensor();

      public: virtual ~RaySensor();

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

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

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

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

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

      public: math::Angle GetAngleMin() const;

      public: math::Angle GetAngleMax() const;

      public: double GetAngleResolution() const;

      public: double GetRangeMin() const;

      public: double GetRangeMax() const;

      public: double GetRangeResolution() const;

      public: int GetRayCount() const;

      public: int GetRangeCount() const;

      public: int GetVerticalRayCount() const;

      public: int GetVerticalRangeCount() const;

      public: math::Angle GetVerticalAngleMin() const;

      public: math::Angle GetVerticalAngleMax() const;

      public: double GetRange(int _index);

      public: void GetRanges(std::vector<double> &_ranges);

      public: double GetRetro(int _index);

      public: int GetFiducial(int _index);

      public: physics::MultiRayShapePtr GetLaserShape() const
              {return this->laserShape;}

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

      private: physics::CollisionPtr laserCollision;
      private: physics::MultiRayShapePtr laserShape;
      private: physics::EntityPtr parentEntity;

      private: transport::PublisherPtr scanPub;
      private: boost::mutex mutex;
      private: msgs::LaserScanStamped laserMsg;

      // Which noise type we support
      private: enum NoiseModelType
      {
        NONE,
        GAUSSIAN
      };
      // If true, apply the noise model specified by other noise parameters
      private: bool noiseActive;
      // Which type of noise we're applying
      private: enum NoiseModelType noiseType;
      // If noiseType==GAUSSIAN, noiseMean is the mean of the distibution
      // from which we sample
      private: double noiseMean;
      // If noiseType==GAUSSIAN, noiseStdDev is the standard devation of
      // the distibution from which we sample
      private: double noiseStdDev;
    };
  }
}

#endif