sdf::SDF_VERSION_NAMESPACE::Atmosphere Class Reference

The Atmosphere class contains information about an atmospheric model and related parameters such as temperature and pressure at sea level. More...

#include <Atmosphere.hh>

Public Member Functions
	Atmosphere ()
	Default constructor. More...
Errors	Load (ElementPtr _sdf)
	Load the atmosphere based on a element pointer. More...
bool	operator== (const Atmosphere &_atmosphere) const
	Equality operator that returns true if this atmosphere instance equals the given atmosphere instance. More...
double	Pressure () const
	Get the pressure at sea level in pascals. More...
void	SetPressure (const double _pressure)
	Set the pressure at sea level in pascals. More...
void	SetTemperature (const gz::math::Temperature &_temp)
	Set the temperature at sea level. More...
void	SetTemperatureGradient (const double _gradient)
	Set the temperature gradient with respect to increasing altitude in units of K/m. More...
void	SetType (const AtmosphereType _type)
	Set the type of the atmospheric model. More...
gz::math::Temperature	Temperature () const
	Get the temperature at sea level. More...
double	TemperatureGradient () const
	Get the temperature gradient with respect to increasing altitude in units of K/m. More...
sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this atmosphere. More...
sdf::ElementPtr	ToElement (sdf::Errors &_errors) const
	Create and return an SDF element filled with data from this atmosphere. More...
AtmosphereType	Type () const
	Get the type of the atmospheric model. More...

Detailed Description

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.

Constructor & Destructor Documentation

Atmosphere()

sdf::SDF_VERSION_NAMESPACE::Atmosphere::Atmosphere

(

)

Default constructor.

Member Function Documentation

Load()

Errors sdf::SDF_VERSION_NAMESPACE::Atmosphere::Load

(

ElementPtr

_sdf

)

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

[in]

_sdf

The SDF Element pointer

Returns

Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

operator==()

bool sdf::SDF_VERSION_NAMESPACE::Atmosphere::operator==

(

const Atmosphere &

_atmosphere

)

const

Equality operator that returns true if this atmosphere instance equals the given atmosphere instance.

Parameters

[in]

_atmosphere

Atmosphere instance to compare.

Returns

True if this instance equals the given atmosphere.

Pressure()

double sdf::SDF_VERSION_NAMESPACE::Atmosphere::Pressure

(

)

const

Get the pressure at sea level in pascals.

Returns

The pressure at sea level in pascals.

SetPressure()

void sdf::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::Atmosphere::SetTemperature

(

const gz::math::Temperature &

_temp

)

Set the temperature at sea level.

Parameters

[in]

_temp

The temperature at sea level.

SetTemperatureGradient()

void sdf::SDF_VERSION_NAMESPACE::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()

void sdf::SDF_VERSION_NAMESPACE::Atmosphere::SetType

(

const AtmosphereType

_type

)

Set the type of the atmospheric model.

Parameters

[in]

_type

The type of atmosphere engine.

Temperature()

gz::math::Temperature sdf::SDF_VERSION_NAMESPACE::Atmosphere::Temperature

(

)

const

Get the temperature at sea level.

Returns

The temperature at sea level.

TemperatureGradient()

double sdf::SDF_VERSION_NAMESPACE::Atmosphere::TemperatureGradient

(

)

const

Get the temperature gradient with respect to increasing altitude in units of K/m.

Returns

The temperature gradient in K/m.

ToElement() [1/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Atmosphere::ToElement

(

)

const

Create and return an SDF element filled with data from this atmosphere.

Note that parameter passing functionality is not captured with this function.

Returns

SDF element pointer with updated atmosphere values.

ToElement() [2/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Atmosphere::ToElement

(

sdf::Errors &

_errors

)

const

Create and return an SDF element filled with data from this atmosphere.

Note that parameter passing functionality is not captured with this function.

Parameters

[out]

_errors

Vector of errors.

Returns

SDF element pointer with updated atmosphere values.

Type()

AtmosphereType sdf::SDF_VERSION_NAMESPACE::Atmosphere::Type

(

)

const

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:

• Atmosphere.hh