Result.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_RESULT_HH_
#define IGNITION_FUEL_TOOLS_RESULT_HH_

#include <memory>
#include <string>

#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)
// TODO(jrivero): rename the DELETE method which is a reserved word in Windows
#undef DELETE
#endif

namespace ignition
{
  namespace fuel_tools
  {
    // forward declaration
    class ResultPrivate;
    class Model;

    enum class ResultType
    {
      UNKNOWN = 0,

      DELETE,

      DELETE_NOT_FOUND,

      DELETE_ERROR,

      FETCH,

      FETCH_ALREADY_EXISTS,

      FETCH_NOT_FOUND,

      FETCH_ERROR,

      UPLOAD,

      UPLOAD_ALREADY_EXISTS,

      UPLOAD_ERROR,

      PATCH_ERROR,

      PATCH,
    };

    class IGNITION_FUEL_TOOLS_VISIBLE Result
    {
      public: Result();

      public: ~Result();

      public: explicit Result(const ResultType _type);

      public: Result(const Result &_result);

      public: Result(Result &&_result) noexcept;  // NOLINT

      public: Result &operator=(const Result &_result);

      public: Result &operator=(Result &&_result) noexcept;  // NOLINT

      public: ResultType Type() const;

      public: virtual operator bool() const;

      public: virtual std::string ReadableResult() const;

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

#ifdef _MSC_VER
#pragma warning(pop)
#endif

#endif