ContactSensor.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_CONTACTSENSOR_HH_
#define _GAZEBO_SENSORS_CONTACTSENSOR_HH_

#include <map>
#include <string>
#include <memory>

#include "gazebo/msgs/msgs.hh"

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

namespace gazebo
{
  namespace sensors
  {
    // Forward declare private data class
    class ContactSensorPrivate;


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

      public: virtual ~ContactSensor();

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

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

      public: virtual void Init();

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

      protected: virtual void Fini();

      public: unsigned int GetCollisionCount() const;

      public: std::string GetCollisionName(unsigned int _index) const;

      public: unsigned int GetCollisionContactCount(
                  const std::string &_collisionName) const;

      public: msgs::Contacts GetContacts() const GAZEBO_DEPRECATED(7.0);

      public: msgs::Contacts Contacts() const;

      public: std::map<std::string, physics::Contact> GetContacts(
                  const std::string &_collisionName) GAZEBO_DEPRECATED(7.0);

      public: std::map<std::string, physics::Contact> Contacts(
                  const std::string &_collisionName) const;

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

      private: void OnContacts(ConstContactsPtr &_msg);

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