NavSatSensor.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2021 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_NAVSAT_HH_
#define IGNITION_SENSORS_NAVSAT_HH_

#include <memory>

#include <ignition/common/SuppressWarning.hh>
#include <sdf/Sensor.hh>

#include "ignition/sensors/config.hh"
#include "ignition/sensors/navsat/Export.hh"

#include "ignition/sensors/Sensor.hh"

namespace ignition
{
  namespace sensors
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
    //
    class NavSatPrivate;

    class IGNITION_SENSORS_NAVSAT_VISIBLE NavSatSensor : public Sensor
    {
      public: NavSatSensor();

      public: virtual ~NavSatSensor();

      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 SetLatitude(const math::Angle &_latitude);

      public: const math::Angle &Latitude() const;

      public: void SetLongitude(const math::Angle &_longitude);

      public: const math::Angle &Longitude() const;

      public: void SetAltitude(double _altitude);

      public: double Altitude() const;

      public: void SetVelocity(const math::Vector3d &_vel);

      public: const math::Vector3d &Velocity() const;

      public: void SetPosition(const math::Angle &_latitude,
          const math::Angle &_longitude, double _altitude = 0.0);

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

#endif