Atmosphere.hh

Go to the documentation of this file.

/*
 * Copyright 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef SDF_ATMOSPHERE_HH_
#define SDF_ATMOSPHERE_HH_

#include <ignition/math/Temperature.hh>
#include "sdf/Element.hh"
#include "sdf/Types.hh"
#include "sdf/sdf_config.h"
#include "sdf/system_util.hh"

namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //
  enum class AtmosphereType
  {
    ADIABATIC = 0,
  };

  // Forward declarations.
  class AtmospherePrivate;

  class SDFORMAT_VISIBLE Atmosphere
  {
    public: Atmosphere();

    public: Atmosphere(const Atmosphere &_atmosphere);

    public: Atmosphere(Atmosphere &&_atmosphere) noexcept;

    public: Atmosphere &operator=(Atmosphere &&_atmosphere);

    public: Atmosphere &operator=(const Atmosphere &_atmosphere);

    public: ~Atmosphere();

    public: Errors Load(ElementPtr _sdf);

    public: AtmosphereType Type() const;

    public: void SetType(const AtmosphereType _type);

    public: ignition::math::Temperature Temperature() const;

    public: void SetTemperature(const ignition::math::Temperature &_temp);

    public: double TemperatureGradient() const;

    public: void SetTemperatureGradient(const double _gradient);

    public: double Pressure() const;

    public: void SetPressure(const double _pressure);

    public: bool operator==(const Atmosphere &_atmosphere);

    private: AtmospherePrivate *dataPtr = nullptr;
  };
  }
}
#endif