Sensor.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: Base class for all sensors
 * Author: Nathan Koenig
 * Date: 25 May 2007
 */

#ifndef _SENSOR_HH_
#define _SENSOR_HH_

#include <boost/enable_shared_from_this.hpp>
#include <vector>
#include <string>

#include <sdf/sdf.hh>

#include "gazebo/physics/PhysicsTypes.hh"

#include "gazebo/msgs/msgs.hh"
#include "gazebo/common/Events.hh"
#include "gazebo/common/Time.hh"
#include "gazebo/math/Pose.hh"
#include "gazebo/transport/TransportTypes.hh"

namespace gazebo
{
  namespace sensors
  {
    enum SensorCategory
    {
      // IMAGE must be the first element, and it must start with 0. Do not
      // change this! See SensorManager::sensorContainers for reference.
      IMAGE = 0,

      RAY = 1,

      OTHER = 2,

      CATEGORY_COUNT = 3
    };


    class Sensor : public boost::enable_shared_from_this<Sensor>
    {
      public: explicit Sensor(SensorCategory _cat);

      public: virtual ~Sensor();

      public: virtual void Load(const std::string &_worldName,
                                sdf::ElementPtr _sdf);

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

      public: virtual void Init();

      public: virtual void SetParent(const std::string &_name);

      public: std::string GetParentName() const;

      public: void Update(bool _force);

      protected: virtual void UpdateImpl(bool /*_force*/) {}

      public: double GetUpdateRate();

      public: void SetUpdateRate(double _hz);

      public: virtual void Fini();

      public: std::string GetName() const;

      public: std::string GetScopedName() const;

      public: virtual math::Pose GetPose() const;

      public: virtual void SetActive(bool _value);

      public: virtual bool IsActive();

      public: std::string GetType() const;

      public: common::Time GetLastUpdateTime();

      public: common::Time GetLastMeasurementTime();

      public: bool GetVisualize() const;

      public: virtual std::string GetTopic() const;

      public: void FillMsg(msgs::Sensor &_msg);

      public: std::string GetWorldName() const;

      public: template<typename T>
              event::ConnectionPtr ConnectUpdated(T _subscriber)
              {return this->updated.Connect(_subscriber);}

      public: void DisconnectUpdated(event::ConnectionPtr &_c)
              {this->updated.Disconnect(_c);}

      public: SensorCategory GetCategory() const;

      public: void ResetLastUpdateTime();

      private: void LoadPlugin(sdf::ElementPtr _sdf);

      protected: bool active;

      protected: sdf::ElementPtr sdf;

      protected: math::Pose pose;

      protected: std::vector<event::ConnectionPtr> connections;

      protected: transport::NodePtr node;

      protected: transport::SubscriberPtr poseSub;

      protected: std::string parentName;

      protected: std::vector<SensorPluginPtr> plugins;

      protected: gazebo::physics::WorldPtr world;

      protected: common::Time updatePeriod;

      protected: common::Time lastUpdateTime;

      protected: common::Time lastMeasurementTime;

      private: event::EventT<void()> updated;

      private: transport::SubscriberPtr controlSub;

      private: transport::PublisherPtr sensorPub;

      private: SensorCategory category;

      private: common::Time updateDelay;
    };
  }
}
#endif