src/api/cpp/status.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 #include "gmxapi/status.h"
  37
  38 #include <memory>
  39
  40 namespace gmxapi
  41 {
  42
  43 /*! \cond internal
  44  * \brief Implementation class for Status objects.
  45  *
  46  * Current implementation is basically just a wrapper for bool. Future
  47  * versions should be implemented as a "future" for a result that can contain
  48  * more information about failures.
  49  */
  50 class Status::Impl
  51 {
  52     public:
  53         /*!
  54          * \brief Default construct as unsuccessful status.
  55          */
  56         Impl() : success_ {false}
  57         {};
  58
  59         /*!
  60          * \brief Construct with success for true input.
  61          *
  62          * \param success let Boolean true == success.
  63          */
  64         explicit Impl(const bool &success) :
  65             success_ {success}
  66         {};
  67
  68         ~Impl() = default;
  69
  70         /*!
  71          * \brief Query success status
  72          *
  73          * \return true if successful
  74          */
  75         bool success() const
  76         {
  77             return success_;
  78         };
  79     private:
  80         bool success_;
  81 };
  82 /// \endcond
  83
  84 Status::Status() :
  85     impl_ {std::make_unique<Status::Impl>()}
  86 {}
  87
  88 Status::Status(const Status &status)
  89 {
  90     impl_ = std::make_unique<Impl>(status.success());
  91 }
  92
  93 Status &Status::operator=(const Status &status)
  94 {
  95     this->impl_ = std::make_unique<Impl>(status.success());
  96     return *this;
  97 }
  98
  99 Status &Status::operator=(Status &&) noexcept = default;
 100
 101 Status &Status::operator=(bool success)
 102 {
 103     this->impl_ = std::make_unique<Impl>(success);
 104     return *this;
 105 }
 106
 107 Status::Status(Status &&) noexcept = default;
 108
 109 Status::Status(bool success) :
 110     impl_ {std::make_unique<Status::Impl>(success)}
 111 {}
 112
 113 bool Status::success() const
 114 {
 115     return impl_->success();
 116 }
 117
 118 Status::~Status() = default;
 119
 120 } // end namespace gmxapi