gz/sensors/AltimeterSensor.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_ALTIMETERSENSOR_HH_
#define GZ_SENSORS_ALTIMETERSENSOR_HH_
 
#include <memory>
 
#include <sdf/sdf.hh>
 
#include <gz/common/SuppressWarning.hh>
#include <gz/common/Time.hh>
 
#include <gz/sensors/config.hh>
#include <gz/sensors/altimeter/Export.hh>
 
#include "gz/sensors/Sensor.hh"
 
namespace ignition
{
  namespace sensors
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
    //
    class AltimeterSensorPrivate;
 
    class IGNITION_SENSORS_ALTIMETER_VISIBLE AltimeterSensor : public Sensor
    {
      public: AltimeterSensor();
 
      public: virtual ~AltimeterSensor();
 
      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 common::Time &_now) override;
 
      public: void SetVerticalReference(double _reference);
 
      public: double VerticalReference() const;
 
      public: void SetPosition(double _pos);
 
      public: double VerticalPosition() const;
 
      public: void SetVerticalVelocity(double _vel);
 
      public: double VerticalVelocity() const;
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<AltimeterSensorPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
    }
  }
}
 
#endif