Atmosphere.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2018 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_ATMOSPHERE_HH_
18 #define SDF_ATMOSPHERE_HH_
19 
20 #include <gz/math/Temperature.hh>
21 #include <gz/utils/ImplPtr.hh>
22 
23 #include "sdf/Element.hh"
24 #include "sdf/Types.hh"
25 #include "sdf/sdf_config.h"
26 #include "sdf/system_util.hh"
27 
28 
29 namespace sdf
30 {
31  // Inline bracket to help doxygen filtering.
32  inline namespace SDF_VERSION_NAMESPACE {
35  enum class AtmosphereType
36  {
38  ADIABATIC = 0,
39  };
40 
46  {
48  public: Atmosphere();
49 
56  public: Errors Load(ElementPtr _sdf);
57 
60  public: AtmosphereType Type() const;
61 
64  public: void SetType(const AtmosphereType _type);
65 
68  public: gz::math::Temperature Temperature() const;
69 
72  public: void SetTemperature(const gz::math::Temperature &_temp);
73 
77  public: double TemperatureGradient() const;
78 
82  public: void SetTemperatureGradient(const double _gradient);
83 
86  public: double Pressure() const;
87 
90  public: void SetPressure(const double _pressure);
91 
96  public: bool operator==(const Atmosphere &_atmosphere) const;
97 
103  public: sdf::ElementPtr ToElement() const;
104 
111  public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
112 
114  GZ_UTILS_IMPL_PTR(dataPtr)
115  };
116  }
117 }
118 #endif
sdf
namespace for Simulation Description Format parser
Definition: Actor.hh:34
sdf::SDF_VERSION_NAMESPACE::AtmosphereType::ADIABATIC
@ ADIABATIC
Adiabatic atmosphere model.
Types.hh
sdf_config.h
sdf::SDF_VERSION_NAMESPACE::AtmosphereType
AtmosphereType
Definition: Atmosphere.hh:35
SDFORMAT_VISIBLE
#define SDFORMAT_VISIBLE
Definition: system_util.hh:25
sdf::SDF_VERSION_NAMESPACE::Atmosphere
The Atmosphere class contains information about an atmospheric model and related parameters such as t...
Definition: Atmosphere.hh:45
sdf::SDF_VERSION_NAMESPACE::Errors
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:80
system_util.hh
sdf::SDF_VERSION_NAMESPACE::ElementPtr
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
Element.hh