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 <gz/utils/ImplPtr.hh>
21 #include <sdf/Error.hh>
22 #include <sdf/Element.hh>
23 #include <sdf/Noise.hh>
24 #include <sdf/sdf_config.h>
25 
26 namespace sdf
27 {
28  // Inline bracke to help doxygen filtering.
29  inline namespace SDF_VERSION_NAMESPACE {
30  //
31 
35  {
37  public: Magnetometer();
38 
45  public: Errors Load(ElementPtr _sdf);
46 
51  public: sdf::ElementPtr Element() const;
52 
55  public: const Noise &XNoise() const;
56 
59  public: void SetXNoise(const Noise &_noise);
60 
63  public: const Noise &YNoise() const;
64 
67  public: void SetYNoise(const Noise &_noise);
68 
71  public: const Noise &ZNoise() const;
72 
75  public: void SetZNoise(const Noise &_noise);
76 
80  public: bool operator==(const Magnetometer &_mag) const;
81 
86  public: bool operator!=(const Magnetometer &_mag) const;
87 
93  public: sdf::ElementPtr ToElement() const;
94 
96  GZ_UTILS_IMPL_PTR(dataPtr)
97  };
98  }
99 }
100 #endif
Magnetometer contains information about a magnetometer sensor.
Definition: Magnetometer.hh:35
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this magnetometer.
bool operator==(const Magnetometer &_mag) const
Return true if both Magnetometer objects contain the same values.
bool operator!=(const Magnetometer &_mag) const
Return true this Magnetometer object does not contain the same values as the passed in parameter.
Errors Load(ElementPtr _sdf)
Load the magnetometer based on an element pointer.
void SetZNoise(const Noise &_noise)
Set the noise values related to the body-frame z axis.
const Noise & YNoise() const
Get the noise values related to the body-frame y axis.
const Noise & ZNoise() const
Get the noise values related to the body-frame z axis.
void SetYNoise(const Noise &_noise)
Set the noise values related to the body-frame y axis.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
void SetXNoise(const Noise &_noise)
Set the noise values related to the body-frame x axis.
const Noise & XNoise() const
Get the noise values related to the body-frame x axis.
The Noise class contains information about a noise model, such as a Gaussian distribution.
Definition: Noise.hh:48
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:95
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
namespace for Simulation Description Format parser
Definition: Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:25