ModelIdentifier.hh

Go to the documentation of this file.

/*
 * Copyright (C) 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 GZ_FUEL_TOOLS_MODELIDENTIFIER_HH_
#define GZ_FUEL_TOOLS_MODELIDENTIFIER_HH_
 
#include <cstdint>
#include <ctime>
#include <memory>
#include <string>
#include <vector>
 
#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 ModelIdentifierPrivate;
  class ServerConfig;
 
  class GZ_FUEL_TOOLS_VISIBLE ModelIdentifier
  {
    public: ModelIdentifier();
 
    public: ModelIdentifier(const ModelIdentifier &_orig);
 
    public: ~ModelIdentifier();
 
    public: ModelIdentifier &operator=(const ModelIdentifier &_orig);
 
    public: bool operator==(const ModelIdentifier &_rhs) const;
 
    public: bool operator!=(const ModelIdentifier &_rhs) const;
 
    public: std::string Name() const;
 
    public: std::string Owner() const;
 
    public: ServerConfig &Server() const;
 
    public: std::string UniqueName() const;
 
    public: gz::common::URI Url() const;
 
    public: bool SetName(const std::string &_name);
 
    public: bool SetOwner(const std::string &_name);
 
    public: bool SetServer(const ServerConfig &_server);
 
    public: std::string Description() const;
 
    public: unsigned int FileSize() const;
 
    public: std::time_t UploadDate() const;
 
    public: std::time_t ModifyDate() const;
 
    public: uint32_t LikeCount() const;
 
    public: uint32_t DownloadCount() const;
 
    public: std::string LicenseName() const;
 
    public: std::string LicenseUrl() const;
 
    public: std::string LicenseImageUrl() const;
 
    public: std::vector<std::string> Tags() const;
 
    public: bool Private() const;
 
    public: void SetPrivate(bool _private) const;
 
    public: bool SetDescription(const std::string &_desc);
 
    public: bool SetFileSize(const unsigned int _filesize);
 
    public: bool SetUploadDate(const std::time_t &_date);
 
    public: bool SetModifyDate(const std::time_t &_date);
 
    public: bool SetLikeCount(const uint32_t _likes);
 
    public: bool SetDownloadCount(const uint32_t _downloads);
 
    public: bool SetLicenseName(const std::string &_name);
 
    public: bool SetLicenseUrl(const std::string &_url);
 
    public: bool SetLicenseImageUrl(const std::string &_url);
 
    public: bool SetTags(const std::vector<std::string> &_tags);
 
    public: unsigned int Version() const;
 
    public: std::string VersionStr() const;
 
    public: bool SetVersion(const unsigned int _version);
 
    public: bool SetVersionStr(const std::string &_version);
 
    // /// \brief returns a SHA 2 256 hash of the model
    // /// \remarks fulfills versioning requirement
    // public: std::array<std::uint8_t, 32> SHA_256() const;
 
    // /// \brief Sets the SHA 2 256 hash of the model
    // /// \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;
 
    private: std::unique_ptr<ModelIdentifierPrivate> dataPtr;
  };
}  // namespace gz::fuel_tools
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#endif  // GZ_FUEL_TOOLS_MODELIDENTIFIER_HH_