Result.hh

/*
 * 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_RESULT_HH_
#define GZ_FUEL_TOOLS_RESULT_HH_

#include <memory>
#include <string>

#include "gz/fuel_tools/Export.hh"
#include "gz/fuel_tools/ResultType.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
{
  // forward declaration
  class ResultPrivate;
  class Model;

  /// \brief Class describing a result of an operation.
  class GZ_FUEL_TOOLS_VISIBLE Result
  {
    /// \brief Default constructor
    public: Result();

    /// \brief Destructor.
    public: virtual ~Result();

    /// \brief Constructor
    /// \param[in] _type Result type
    public: explicit Result(const ResultType _type);

    /// \brief Copy constructor.
    /// \param[in] _result Result to copy.
    public: Result(const Result &_result);

    /// \brief Move constructor
    /// \param[in] _result Result to move.
    public: Result(Result &&_result) noexcept;  // NOLINT

    /// \brief Copy assignment operator.
    /// \param[in] _result Result to copy.
    public: Result &operator=(const Result &_result);

    /// \brief Move assignment operator.
    /// \param[in] _result Result component to move.
    /// \return Reference to this.
    public: Result &operator=(Result &&_result) noexcept;  // NOLINT

    /// \brief Get the type of result
    /// \return The type of result.
    public: ResultType Type() const;

    /// \brief Operator bool returns true if operation was successful.
    /// \return True if the operation was successful.
    public: virtual operator bool() const;

    /// \brief Get human readable result string.
    /// \return The result string.
    public: virtual std::string ReadableResult() const;

    /// brief Pointer to private data
    private: std::unique_ptr<ResultPrivate> dataPtr;
  };
}  // namespace gz::fuel_tools

#ifdef _MSC_VER
#pragma warning(pop)
#endif

#endif  // GZ_FUEL_TOOLS_RESULT_HH_