Magnetometer.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_MAGNETOMETER_HH_
#define SDF_MAGNETOMETER_HH_

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

namespace sdf
{
  // Inline bracke to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //
  class MagnetometerPrivate;

  class SDFORMAT_VISIBLE Magnetometer
  {
    public: Magnetometer();

    public: Magnetometer(const Magnetometer &_magnetometer);

    public: Magnetometer(Magnetometer &&_magnetometer) noexcept;

    public: ~Magnetometer();

    public: Magnetometer &operator=(const Magnetometer &_magnetometer);

    public: Magnetometer &operator=(Magnetometer &&_magnetometer);

    public: Errors Load(ElementPtr _sdf);

    public: sdf::ElementPtr Element() const;

    public: const Noise &XNoise() const;

    public: void SetXNoise(const Noise &_noise);

    public: const Noise &YNoise() const;

    public: void SetYNoise(const Noise &_noise);

    public: const Noise &ZNoise() const;

    public: void SetZNoise(const Noise &_noise);

    public: bool operator==(const Magnetometer &_mag) const;

    public: bool operator!=(const Magnetometer &_mag) const;

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