NavSat.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2021 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_NAVSAT_HH_
18 #define SDF_NAVSAT_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 #include <gz/math/Angle.hh>
27 
28 namespace sdf
29 {
30  // Inline bracket to help doxygen filtering.
31  inline namespace SDF_VERSION_NAMESPACE {
32  //
76  {
78  public: NavSat();
85  public: Errors Load(ElementPtr _sdf);
86 
91  public: sdf::ElementPtr Element() const;
92 
95  public: void SetHorizontalPositionNoise(const Noise &_noise);
96 
99  public: const Noise &HorizontalPositionNoise() const;
100 
103  public: void SetVerticalPositionNoise(const Noise &_noise);
104 
107  public: const Noise &VerticalPositionNoise() const;
108 
111  public: void SetHorizontalVelocityNoise(const Noise &_noise);
112 
115  public: const Noise &HorizontalVelocityNoise() const;
116 
119  public: void SetVerticalVelocityNoise(const Noise &_noise);
120 
123  public: const Noise &VerticalVelocityNoise() const;
124 
128  public: bool operator==(const NavSat &_navsat) const;
129 
134  public: bool operator!=(const NavSat &_navsat) const;
135 
137  GZ_UTILS_IMPL_PTR(dataPtr)
138  };
139  }
140 }
141 #endif
NavSat contains information about a NavSat sensor.
Definition: NavSat.hh:76
const Noise & VerticalPositionNoise() const
Get noise value for vertical position sensor.
void SetHorizontalVelocityNoise(const Noise &_noise)
Set the noise values for the horizontal velocity sensor.
void SetHorizontalPositionNoise(const Noise &_noise)
Set the noise values for the horizontal position sensor.
void SetVerticalVelocityNoise(const Noise &_noise)
Set the noise values for the vertical velocity sensor.
NavSat()
Default constructor.
void SetVerticalPositionNoise(const Noise &_noise)
Set the noise values for the vertical position sensor.
const Noise & HorizontalVelocityNoise() const
Get noise value for horizontal velocity sensor.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
Errors Load(ElementPtr _sdf)
Load the navsat based on an element pointer.
bool operator!=(const NavSat &_navsat) const
Return true this NavSat object does not contain the same values as the passed in parameter.
const Noise & VerticalVelocityNoise() const
Get noise value for vertical velocity sensor.
bool operator==(const NavSat &_navsat) const
Return true if both NavSat objects contain the same values.
const Noise & HorizontalPositionNoise() const
Get noise value for horizontal position sensor.
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