Loading...
Searching...
No Matches
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 <sdf/Error.hh>
21#include <sdf/Element.hh>
22#include <sdf/Noise.hh>
23#include <sdf/sdf_config.h>
24
25#include <ignition/math/Angle.hh>
26
27namespace sdf
28{
29 // Inline bracket to help doxygen filtering.
30 inline namespace SDF_VERSION_NAMESPACE {
31 //
32 class NavSatPrivate;
33
77 {
79 public: NavSat();
80
83 public: NavSat(const NavSat &_navsat);
84
87 public: NavSat(NavSat &&_navsat) noexcept;
88
90 public: ~NavSat();
91
95 public: NavSat &operator=(const NavSat &_navsat);
96
100 public: NavSat &operator=(NavSat &&_navsat) noexcept;
101
108 public: Errors Load(ElementPtr _sdf);
109
114 public: sdf::ElementPtr Element() const;
115
118 public: void SetHorizontalPositionNoise(const Noise &_noise);
119
122 public: const Noise &HorizontalPositionNoise() const;
123
126 public: void SetVerticalPositionNoise(const Noise &_noise);
127
130 public: const Noise &VerticalPositionNoise() const;
131
134 public: void SetHorizontalVelocityNoise(const Noise &_noise);
135
138 public: const Noise &HorizontalVelocityNoise() const;
139
142 public: void SetVerticalVelocityNoise(const Noise &_noise);
143
146 public: const Noise &VerticalVelocityNoise() const;
147
151 public: bool operator==(const NavSat &_navsat) const;
152
157 public: bool operator!=(const NavSat &_navsat) const;
158
160 private: NavSatPrivate *dataPtr;
161 };
162 }
163}
164#endif
NavSat contains information about a NavSat sensor.
Definition NavSat.hh:77
NavSat & operator=(NavSat &&_navsat) noexcept
Move assignment operator.
bool operator!=(const NavSat &_navsat) const
Return true this NavSat object does not contain the same values as the passed in parameter.
NavSat()
Default constructor.
~NavSat()
Destructor.
NavSat & operator=(const NavSat &_navsat)
Assignment operator.
void SetHorizontalVelocityNoise(const Noise &_noise)
Set the noise values for the horizontal velocity sensor.
void SetVerticalVelocityNoise(const Noise &_noise)
Set the noise values for the vertical velocity sensor.
NavSat(NavSat &&_navsat) noexcept
Move constructor.
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.
const Noise & HorizontalPositionNoise() const
Get noise value for horizontal position sensor.
Errors Load(ElementPtr _sdf)
Load the navsat based on an element pointer.
void SetVerticalPositionNoise(const Noise &_noise)
Set the noise values for the vertical position sensor.
void SetHorizontalPositionNoise(const Noise &_noise)
Set the noise values for the horizontal position sensor.
bool operator==(const NavSat &_navsat) const
Return true if both NavSat objects contain the same values.
NavSat(const NavSat &_navsat)
Copy constructor.
const Noise & VerticalVelocityNoise() const
Get noise value for vertical velocity sensor.
const Noise & VerticalPositionNoise() const
Get noise value for vertical position sensor.
The Noise class contains information about a noise model, such as a Gaussian distribution.
Definition Noise.hh:50
std::vector< Error > Errors
A vector of Error.
Definition Types.hh:89
std::shared_ptr< Element > ElementPtr
Definition Element.hh:53
namespace for Simulation Description Format parser
Definition Actor.hh:33
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition system_util.hh:48