Loading...
Searching...
No Matches
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 <sdf/Error.hh>
21#include <sdf/Element.hh>
22#include <sdf/Noise.hh>
23#include <sdf/sdf_config.h>
24
25namespace sdf
26{
27 // Inline bracket to help doxygen filtering.
28 inline namespace SDF_VERSION_NAMESPACE {
29 //
30 class AltimeterPrivate;
31
35 {
37 public: Altimeter();
38
41 public: Altimeter(const Altimeter &_altimeter);
42
45 public: Altimeter(Altimeter &&_altimeter) noexcept;
46
48 public: ~Altimeter();
49
53 public: Altimeter &operator=(const Altimeter &_altimeter);
54
58 public: Altimeter &operator=(Altimeter &&_altimeter) noexcept;
59
66 public: Errors Load(ElementPtr _sdf);
67
72 public: sdf::ElementPtr Element() const;
73
76 public: const Noise &VerticalPositionNoise() const;
77
80 public: void SetVerticalPositionNoise(const Noise &_noise);
81
84 public: const Noise &VerticalVelocityNoise() const;
85
88 public: void SetVerticalVelocityNoise(const Noise &_noise);
89
93 public: bool operator==(const Altimeter &_alt) const;
94
99 public: bool operator!=(const Altimeter &_alt) const;
100
102 private: AltimeterPrivate *dataPtr;
103 };
104 }
105}
106#endif
Altimeter contains information about an altimeter sensor.
Definition Altimeter.hh:35
void SetVerticalPositionNoise(const Noise &_noise)
Set the noise values related to the vertical position.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
const Noise & VerticalVelocityNoise() const
Get the noise values related to the vertical velocity.
Altimeter & operator=(const Altimeter &_altimeter)
Assignment operator.
bool operator==(const Altimeter &_alt) const
Return true if both Altimeter objects contain the same values.
bool operator!=(const Altimeter &_alt) const
Return true this Altimeter object does not contain the same values as the passed in parameter.
const Noise & VerticalPositionNoise() const
Get the noise values related to the vertical position.
Altimeter(const Altimeter &_altimeter)
Copy constructor.
Errors Load(ElementPtr _sdf)
Load the altimeter based on an element pointer.
void SetVerticalVelocityNoise(const Noise &_noise)
Set the noise values related to the vertical velocity.
Altimeter()
Default constructor.
Altimeter & operator=(Altimeter &&_altimeter) noexcept
Move assignment operator.
~Altimeter()
Destructor.
Altimeter(Altimeter &&_altimeter) noexcept
Move constructor.
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