Magnetometer.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2019 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef SDF_MAGNETOMETER_HH_
18 #define SDF_MAGNETOMETER_HH_
19 
20 #include <sdf/Error.hh>
21 #include <sdf/Element.hh>
22 #include <sdf/Noise.hh>
23 #include <sdf/sdf_config.h>
24 
25 namespace sdf
26 {
27  // Inline bracke to help doxygen filtering.
28  inline namespace SDF_VERSION_NAMESPACE {
29  //
30  class MagnetometerPrivate;
31 
35  {
37  public: Magnetometer();
38 
41  public: Magnetometer(const Magnetometer &_magnetometer);
42 
45  public: Magnetometer(Magnetometer &&_magnetometer) noexcept;
46 
48  public: ~Magnetometer();
49 
53  public: Magnetometer &operator=(const Magnetometer &_magnetometer);
54 
58  public: Magnetometer &operator=(Magnetometer &&_magnetometer);
59 
66  public: Errors Load(ElementPtr _sdf);
67 
72  public: sdf::ElementPtr Element() const;
73 
76  public: const Noise &XNoise() const;
77 
80  public: void SetXNoise(const Noise &_noise);
81 
84  public: const Noise &YNoise() const;
85 
88  public: void SetYNoise(const Noise &_noise);
89 
92  public: const Noise &ZNoise() const;
93 
96  public: void SetZNoise(const Noise &_noise);
97 
101  public: bool operator==(const Magnetometer &_mag) const;
102 
107  public: bool operator!=(const Magnetometer &_mag) const;
108 
110  private: MagnetometerPrivate *dataPtr;
111  };
112  }
113 }
114 #endif
Magnetometer contains information about a magnetometer sensor.
Definition: Magnetometer.hh:34
class SDFORMAT_VISIBLE Element
Definition: Element.hh:49
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
The Noise class contains information about a noise model, such as a Gaussian distribution.
Definition: Noise.hh:49
namespace for Simulation Description Format parser
Definition: Actor.hh:32
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:95