Physics.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_PHYSICS_HH_
#define SDF_PHYSICS_HH_

#include <string>

#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 {
  //

  // Forward declare private data class.
  class PhysicsPrivate;

  class SDFORMAT_VISIBLE Physics
  {
    public: Physics();

    public: Physics(const Physics &_physics);

    public: Physics(Physics &&_physics) noexcept;

    public: Physics &operator=(Physics &&_physics);

    public: Physics &operator=(const Physics &_physics);

    public: ~Physics();

    public: Errors Load(ElementPtr _sdf);

    public: std::string Name() const;

    public: void SetName(const std::string &_name) const;

    public: sdf::ElementPtr Element() const;

    public: bool IsDefault() const;

    public: void SetDefault(const bool _default) const;

    public: std::string EngineType() const;

    public: void SetEngineType(const std::string &_type);

    public: double MaxStepSize() const;

    public: void SetMaxStepSize(const double _step);

    public: double RealTimeFactor() const;

    public: void SetRealTimeFactor(const double _factor);

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