Root.hh

Go to the documentation of this file.

/*
 * Copyright 2017 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_ROOT_HH_
#define SDF_ROOT_HH_

#include <string>
#include <ignition/utils/ImplPtr.hh>

#include "sdf/SDFImpl.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 declarations.
  class Actor;
  class Light;
  class Model;
  class World;

  class SDFORMAT_VISIBLE Root
  {
    public: Root();

    public: Errors Load(const std::string &_filename);

    public: Errors Load(
                const std::string &_filename, const ParserConfig &_config);

    public: Errors LoadSdfString(const std::string &_sdf);

    public: Errors LoadSdfString(
                const std::string &_sdf, const ParserConfig &_config);

    public: Errors Load(const SDFPtr _sdf);

    public: Errors Load(const SDFPtr _sdf, const ParserConfig &_config);

    public: std::string Version() const;

    public: void SetVersion(const std::string &_version);

    public: uint64_t WorldCount() const;

    public: const World *WorldByIndex(const uint64_t _index) const;

    public: bool WorldNameExists(const std::string &_name) const;

    public: uint64_t ModelCount() const SDF_DEPRECATED(11.0);

    public: const sdf::Model *ModelByIndex(const uint64_t _index) const
        SDF_DEPRECATED(11.0);

    public: bool ModelNameExists(const std::string &_name) const
        SDF_DEPRECATED(11.0);

    public: const sdf::Model *Model() const;

    public: uint64_t LightCount() const SDF_DEPRECATED(11.0);

    public: const sdf::Light *LightByIndex(const uint64_t _index) const
        SDF_DEPRECATED(11.0);

    public: bool LightNameExists(const std::string &_name) const
        SDF_DEPRECATED(11.0);

    public: const sdf::Light *Light() const;

    public: uint64_t ActorCount() const SDF_DEPRECATED(11.0);

    public: const sdf::Actor *ActorByIndex(const uint64_t _index) const
        SDF_DEPRECATED(11.0);

    public: bool ActorNameExists(const std::string &_name) const
        SDF_DEPRECATED(11.0);

    public: const sdf::Actor *Actor() const;

    public: sdf::ElementPtr Element() const;

    IGN_UTILS_UNIQUE_IMPL_PTR(dataPtr)
  };
  }
}
#endif