Loading...
Searching...
No Matches
AirPressure.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_AIRPRESSURE_HH_
18#define SDF_AIRPRESSURE_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 bracke to help doxygen filtering.
28 inline namespace SDF_VERSION_NAMESPACE {
29 //
30 class AirPressurePrivate;
31
36 {
38 public: AirPressure();
39
42 public: AirPressure(const AirPressure &_sensor);
43
46 public: AirPressure(AirPressure &&_sensor);
47
49 public: ~AirPressure();
50
55 public: AirPressure &operator=(const AirPressure &_sensor);
56
61 public: AirPressure &operator=(AirPressure &&_sensor);
62
69 public: Errors Load(ElementPtr _sdf);
70
75 public: sdf::ElementPtr Element() const;
76
84 public: double ReferenceAltitude() const;
85
89 public: void SetReferenceAltitude(double _ref);
90
93 public: const Noise &PressureNoise() const;
94
97 public: void SetPressureNoise(const Noise &_noise);
98
103 public: bool operator==(const AirPressure &_air) const;
104
109 public: bool operator!=(const AirPressure &_air) const;
110
112 private: AirPressurePrivate *dataPtr;
113 };
114 }
115}
116#endif
AirPressure contains information about a general purpose fluid pressure sensor.
Definition AirPressure.hh:36
double ReferenceAltitude() const
Get the reference altitude of the sensor in meters.
void SetReferenceAltitude(double _ref)
Set the reference altitude of the sensor in meters.
~AirPressure()
Destructor.
AirPressure & operator=(const AirPressure &_sensor)
Assignment operator.
bool operator!=(const AirPressure &_air) const
Return true this AirPressure object does not contain the same values as the passed in parameter.
AirPressure(AirPressure &&_sensor)
Move constructor.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
bool operator==(const AirPressure &_air) const
Return true if both AirPressure objects contain the same values.
const Noise & PressureNoise() const
Get the noise values.
AirPressure()
Default constructor.
AirPressure(const AirPressure &_sensor)
Copy constructor.
Errors Load(ElementPtr _sdf)
Load the airPressure based on an element pointer.
void SetPressureNoise(const Noise &_noise)
Set the noise values related to the pressure data.
AirPressure & operator=(AirPressure &&_sensor)
Move assignment operator.
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