The Atmosphere class contains information about an atmospheric model and related parameters such as temperature and pressure at sea level.
More...
#include <Atmosphere.hh>
The Atmosphere class contains information about an atmospheric model and related parameters such as temperature and pressure at sea level.
An Atmosphere instance is optionally part of a World.
◆ Atmosphere() [1/3]
sdf::v9::Atmosphere::Atmosphere |
( |
| ) |
|
◆ Atmosphere() [2/3]
sdf::v9::Atmosphere::Atmosphere |
( |
const Atmosphere & |
_atmosphere | ) |
|
Copy constructor.
- Parameters
-
◆ Atmosphere() [3/3]
sdf::v9::Atmosphere::Atmosphere |
( |
Atmosphere && |
_atmosphere | ) |
|
|
noexcept |
Move constructor.
- Parameters
-
◆ ~Atmosphere()
sdf::v9::Atmosphere::~Atmosphere |
( |
| ) |
|
◆ Load()
Load the atmosphere based on a element pointer.
This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.
- Parameters
-
- Returns
- Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.
◆ operator=() [1/2]
Move assignment operator.
- Parameters
-
- Returns
- Reference to this.
◆ operator=() [2/2]
Copy assignment operator.
- Parameters
-
- Returns
- Reference to this.
◆ operator==()
bool sdf::v9::Atmosphere::operator== |
( |
const Atmosphere & |
_atmosphere | ) |
|
Equality operator that returns true if this atmosphere instance equals the given atmosphere instance.
- Parameters
-
- Returns
- True if this instance equals the given atmosphere.
◆ Pressure()
double sdf::v9::Atmosphere::Pressure |
( |
| ) |
const |
Get the pressure at sea level in pascals.
- Returns
- The pressure at sea level in pascals.
◆ SetPressure()
void sdf::v9::Atmosphere::SetPressure |
( |
const double |
_pressure | ) |
|
Set the pressure at sea level in pascals.
- Parameters
-
[in] | _pressure | The pressure at sea level in pascals. |
◆ SetTemperature()
void sdf::v9::Atmosphere::SetTemperature |
( |
const gz::math::Temperature & |
_temp | ) |
|
Set the temperature at sea level.
- Parameters
-
[in] | _temp | The temperature at sea level. |
◆ SetTemperatureGradient()
void sdf::v9::Atmosphere::SetTemperatureGradient |
( |
const double |
_gradient | ) |
|
Set the temperature gradient with respect to increasing altitude in units of K/m.
- Parameters
-
[in] | _gradient | The temperature gradient in K/m. |
◆ SetType()
Set the type of the atmospheric model.
- Parameters
-
[in] | _type | The type of atmosphere engine. |
◆ Temperature()
gz::math::Temperature sdf::v9::Atmosphere::Temperature |
( |
| ) |
const |
Get the temperature at sea level.
- Returns
- The temperature at sea level.
◆ TemperatureGradient()
double sdf::v9::Atmosphere::TemperatureGradient |
( |
| ) |
const |
Get the temperature gradient with respect to increasing altitude in units of K/m.
- Returns
- The temperature gradient in K/m.
◆ Type()
Get the type of the atmospheric model.
- Returns
- The type of atmosphere engine, which defaults to adiabatic.
The documentation for this class was generated from the following file: