ClientConfig.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 IGNITION_FUEL_TOOLS_CLIENTCONFIG_HH_
#define IGNITION_FUEL_TOOLS_CLIENTCONFIG_HH_

#include <memory>
#include <string>
#include <vector>

#include <ignition/common/URI.hh>

#include "ignition/fuel_tools/Export.hh"

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif

namespace ignition
{
  namespace fuel_tools
  {
    class ServerConfigPrivate;

    class ClientConfigPrivate;

    class IGNITION_FUEL_TOOLS_VISIBLE ServerConfig
    {
      public: ServerConfig();

      public: ServerConfig(const ServerConfig &_orig);

      public: ServerConfig &operator=(const ServerConfig &_orig);

      public: ~ServerConfig();

      public: void Clear();

      public: common::URI Url() const;

      public: void SetUrl(const common::URI &_url);

      public: std::string ApiKey() const;

      public: void SetApiKey(const std::string &_key);

      public: std::string Version() const;

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

      public: std::string AsString(const std::string &_prefix = "") const;

      public: std::string AsPrettyString(const std::string &_prefix = "") const;

      private: std::unique_ptr<ServerConfigPrivate> dataPtr;
    };

    class IGNITION_FUEL_TOOLS_VISIBLE ClientConfig
    {
      public: ClientConfig();

      public: ClientConfig(const ClientConfig &_copy);

      public: ClientConfig &operator=(const ClientConfig &_copy);

      public: ~ClientConfig();

      public: void Clear();

      public: void SetUserAgent(const std::string &_agent);

      public: const std::string &UserAgent() const;

      public: bool LoadConfig(const std::string &_file);

      public: std::string ConfigPath() const;

      public: std::vector<ServerConfig> Servers() const;

      public: std::vector<ServerConfig> & MutableServers() const;

      public: void AddServer(const ServerConfig &_srv);

      public: std::string CacheLocation() const;

      public: void SetCacheLocation(const std::string &_path);

      public: std::string AsString(const std::string &_prefix = "") const;

      private: std::unique_ptr<ClientConfigPrivate> dataPtr;
    };
  }
}

#ifdef _MSC_VER
#pragma warning(pop)
#endif

#endif