AirSpeed.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2023 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_AIRSPEED_HH_
18 #define SDF_AIRSPEED_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 
27 namespace sdf
28 {
29  // Inline bracke to help doxygen filtering.
30  inline namespace SDF_VERSION_NAMESPACE {
35  {
37  public: AirSpeed();
38 
45  public: Errors Load(ElementPtr _sdf);
46 
51  public: sdf::ElementPtr Element() const;
52 
55  public: const Noise &PressureNoise() const;
56 
59  public: void SetPressureNoise(const Noise &_noise);
60 
65  public: bool operator==(const AirSpeed &_air) const;
66 
71  public: bool operator!=(const AirSpeed &_air) const;
72 
78  public: sdf::ElementPtr ToElement() const;
79 
81  GZ_UTILS_IMPL_PTR(dataPtr)
82  };
83  }
84 }
85 #endif
AirSpeed contains information about a general purpose air speed sensor.
Definition: AirSpeed.hh:35
bool operator!=(const AirSpeed &_air) const
Return true this AirSpeed object does not contain the same values as the passed in parameter.
void SetPressureNoise(const Noise &_noise)
Set the noise values related to the differential pressure data.
bool operator==(const AirSpeed &_air) const
Return true if both AirSpeed objects contain the same values.
Errors Load(ElementPtr _sdf)
Load the air speed based on an element pointer.
const Noise & PressureNoise() const
Get the noise values.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this air pressure 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