Altimeter.hh

Go to the documentation of this file.

/*
 * Copyright 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 SDF_ALTIMETER_HH_
#define SDF_ALTIMETER_HH_

#include <sdf/Error.hh>
#include <sdf/Element.hh>
#include <sdf/Noise.hh>
#include <sdf/sdf_config.h>

namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //
  class AltimeterPrivate;

  class SDFORMAT_VISIBLE Altimeter
  {
    public: Altimeter();

    public: Altimeter(const Altimeter &_altimeter);

    public: Altimeter(Altimeter &&_altimeter) noexcept;

    public: ~Altimeter();

    public: Altimeter &operator=(const Altimeter &_altimeter);

    public: Altimeter &operator=(Altimeter &&_altimeter) noexcept;

    public: Errors Load(ElementPtr _sdf);

    public: sdf::ElementPtr Element() const;

    public: const Noise &VerticalPositionNoise() const;

    public: void SetVerticalPositionNoise(const Noise &_noise);

    public: const Noise &VerticalVelocityNoise() const;

    public: void SetVerticalVelocityNoise(const Noise &_noise);

    public: bool operator==(const Altimeter &_alt) const;

    public: bool operator!=(const Altimeter &_alt) const;

    private: AltimeterPrivate *dataPtr;
  };
  }
}
#endif