Altimeter.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_ALTIMETER_HH_
18#define SDF_ALTIMETER_HH_
19
20#include <gz/utils/ImplPtr.hh>
21
22#include <sdf/Error.hh>
23#include <sdf/Element.hh>
24#include <sdf/Noise.hh>
25#include <sdf/sdf_config.h>
26
27namespace sdf
28{
29 // Inline bracket to help doxygen filtering.
30 inline namespace SDF_VERSION_NAMESPACE {
34 {
36 public: Altimeter();
37
44 public: Errors Load(ElementPtr _sdf);
45
50 public: sdf::ElementPtr Element() const;
51
54 public: const Noise &VerticalPositionNoise() const;
55
58 public: void SetVerticalPositionNoise(const Noise &_noise);
59
62 public: const Noise &VerticalVelocityNoise() const;
63
66 public: void SetVerticalVelocityNoise(const Noise &_noise);
67
71 public: bool operator==(const Altimeter &_alt) const;
72
77 public: bool operator!=(const Altimeter &_alt) const;
78
84 public: sdf::ElementPtr ToElement() const;
85
92 public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
93
95 GZ_UTILS_IMPL_PTR(dataPtr)
96 };
97 }
98}
99#endif
Altimeter contains information about an altimeter sensor.
Definition: Altimeter.hh:34
Errors Load(ElementPtr _sdf)
Load the altimeter based on an element pointer.
const Noise & VerticalPositionNoise() const
Get the noise values related to the vertical position.
bool operator!=(const Altimeter &_alt) const
Return true this Altimeter object does not contain the same values as the passed in parameter.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
sdf::ElementPtr ToElement(sdf::Errors &_errors) const
Create and return an SDF element filled with data from this altimeter sensor.
const Noise & VerticalVelocityNoise() const
Get the noise values related to the vertical velocity.
void SetVerticalPositionNoise(const Noise &_noise)
Set the noise values related to the vertical position.
bool operator==(const Altimeter &_alt) const
Return true if both Altimeter objects contain the same values.
void SetVerticalVelocityNoise(const Noise &_noise)
Set the noise values related to the vertical velocity.
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this altimeter 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