gz/sensors/MagnetometerSensor.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2019 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 GZ_SENSORS_MAGNETOMETERSENSOR_HH_
#define GZ_SENSORS_MAGNETOMETERSENSOR_HH_
 
#include <memory>
 
#include <sdf/sdf.hh>
 
#include <gz/common/SuppressWarning.hh>
#include <gz/math/Pose3.hh>
 
#include <gz/sensors/config.hh>
#include <gz/sensors/magnetometer/Export.hh>
 
#include "gz/sensors/Sensor.hh"
 
namespace ignition
{
  namespace sensors
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
    //
    class MagnetometerSensorPrivate;
 
    class IGNITION_SENSORS_MAGNETOMETER_VISIBLE MagnetometerSensor
        : public Sensor
    {
      public: MagnetometerSensor();
 
      public: virtual ~MagnetometerSensor();
 
      public: virtual bool Load(const sdf::Sensor &_sdf) override;
 
      public: virtual bool Load(sdf::ElementPtr _sdf) override;
 
      public: virtual bool Init() override;
 
      public: virtual bool Update(
        const std::chrono::steady_clock::duration &_now) override;
 
      public: void SetWorldPose(const math::Pose3d _pose);
 
      public: math::Pose3d WorldPose() const;
 
      public: void SetWorldMagneticField(const math::Vector3d &_field);
 
      public: math::Vector3d WorldMagneticField() const;
 
      public: math::Vector3d MagneticField() const;
 
      public: bool HasConnections() const;
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<MagnetometerSensorPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
    }
  }
}
 
#endif