WorldIdentifier.hh

Go to the documentation of this file.

/*
 * Copyright (C) 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 GZ_FUEL_TOOLS_WORLDIDENTIFIER_HH_
#define GZ_FUEL_TOOLS_WORLDIDENTIFIER_HH_
 
#include <memory>
#include <string>
 
#include "gz/fuel_tools/Helpers.hh"
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
 
namespace gz::fuel_tools
{
  class WorldIdentifierPrivate;
  class ServerConfig;
 
  class GZ_FUEL_TOOLS_VISIBLE WorldIdentifier
  {
    public: WorldIdentifier();
 
    public: WorldIdentifier(const WorldIdentifier &_orig);
 
    public: ~WorldIdentifier();
 
    public: WorldIdentifier &operator=(const WorldIdentifier &_orig);
 
    public: bool operator==(const WorldIdentifier &_rhs) const;
 
    public: std::string Name() const;
 
    public: bool SetName(const std::string &_name);
 
    public: std::string Owner() const;
 
    public: bool SetOwner(const std::string &_name);
 
    public: ServerConfig &Server() const;
 
    public: bool SetServer(const ServerConfig &_server);
 
    public: unsigned int Version() const;
 
    public: std::string VersionStr() const;
 
    public: bool SetVersion(const unsigned int _version);
 
    public: bool SetVersionStr(const std::string &_version);
 
    public: std::string LocalPath() const;
 
    public: bool SetLocalPath(const std::string &_path);
 
    public: std::string UniqueName() const;
 
    public: gz::common::URI Url() const;
 
    // /// \brief Sets the SHA 2 256 hash of the world
    // /// \param[in] _hash a 256 bit SHA 2 hash
    // /// \returns true if successful
    // public: bool SHA_256(const std::array<std::uint8_t, 32> &_hash);
 
    public: std::string AsString(const std::string &_prefix = "") const;
 
    public: std::string AsPrettyString(const std::string &_prefix = "") const;
 
    public: bool Private() const;
 
    public: void SetPrivate(bool _private);
 
    private: std::unique_ptr<WorldIdentifierPrivate> dataPtr;
  };
}  // namespace gz::fuel_tools
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#endif  // GZ_FUEL_TOOLS_WORLDIDENTIFIER_HH_