Sensor.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 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 IGNITION_SENSORS_SENSOR_HH_
#define IGNITION_SENSORS_SENSOR_HH_

#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable: 4005)
#pragma warning(disable: 4251)
#endif
#include <ignition/msgs/header.pb.h>
#ifdef _WIN32
#pragma warning(pop)
#endif

#include <chrono>
#include <memory>
#include <string>

#include <ignition/common/SuppressWarning.hh>
#include <ignition/common/Time.hh>
#include <ignition/math/Pose3.hh>
#include <ignition/sensors/config.hh>
#include <ignition/sensors/Export.hh>
#include <sdf/sdf.hh>

namespace ignition
{
  namespace sensors
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
    //
    using SensorId = std::size_t;
    const SensorId NO_SENSOR = 0;

    class SensorPrivate;

    class IGNITION_SENSORS_VISIBLE Sensor
    {
      protected: Sensor();

      public: virtual ~Sensor();

      public: virtual bool Load(const sdf::Sensor &_sdf);

      public: virtual bool Load(sdf::ElementPtr _sdf);

      public: virtual bool Init();

      public:
        virtual bool IGN_DEPRECATED(4) Update(const common::Time &_now) = 0;

      public: virtual bool Update(
        const std::chrono::steady_clock::duration &_now) = 0;

      public: ignition::common::Time IGN_DEPRECATED(4) NextUpdateTime() const;

      public: std::chrono::steady_clock::duration NextDataUpdateTime() const;

      public: bool IGN_DEPRECATED(4)
        Update(const ignition::common::Time &_now, const bool _force);

      public: bool Update(
        const std::chrono::steady_clock::duration &_now, const bool _force);

      public: double UpdateRate() const;

      public: void SetUpdateRate(const double _hz);

      public: ignition::math::Pose3d Pose() const;

      public: void SetPose(const ignition::math::Pose3d &_pose);

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

      public: std::string Name() const;

      public: std::string Topic() const;

      public: bool SetTopic(const std::string &_topic);

      public: bool EnableMetrics() const;

      public: void SetEnableMetrics(bool _enableMetrics);

      public: std::string Parent() const;

      public: SensorId Id() const;

      public: sdf::ElementPtr SDF() const;

      public: void AddSequence(ignition::msgs::Header *_msg,
                  const std::string &_seqKey = "default");

      public: void PublishMetrics(
        const std::chrono::duration<double> &_now);

      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<SensorPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
    }
  }
}

#endif