ext/OGDF/ogdf/basic/Module.h

   1 /*
   2  * $Revision: 2523 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-02 20:59:27 +0200 (Mon, 02 Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declares base class for all module types.
  11  *
  12  * \author Carsten Gutwenger
  13  *
  14  * \par License:
  15  * This file is part of the Open Graph Drawing Framework (OGDF).
  16  *
  17  * \par
  18  * Copyright (C)<br>
  19  * See README.txt in the root directory of the OGDF installation for details.
  20  *
  21  * \par
  22  * This program is free software; you can redistribute it and/or
  23  * modify it under the terms of the GNU General Public License
  24  * Version 2 or 3 as published by the Free Software Foundation;
  25  * see the file LICENSE.txt included in the packaging of this file
  26  * for details.
  27  *
  28  * \par
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * \par
  35  * You should have received a copy of the GNU General Public
  36  * License along with this program; if not, write to the Free
  37  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  38  * Boston, MA 02110-1301, USA.
  39  *
  40  * \see  http://www.gnu.org/copyleft/gpl.html
  41  ***************************************************************/
  42
  43 #ifdef _MSC_VER
  44 #pragma once
  45 #endif
  46
  47
  48 #ifndef OGDF_MODULE_H
  49 #define OGDF_MODULE_H
  50
  51
  52 #include <ogdf/basic/basic.h>
  53
  54 namespace ogdf {
  55
  56
  57 /**
  58  * \brief Base class for modules.
  59  *
  60  * A module represents an algorithm that implements a certain interface.
  61  * There are various specific module types present in the OGDF, which all
  62  * inherit Module as a base class. These module types define the interface
  63  * implemented by the module.
  64  *
  65  * \sa ModuleOption
  66  */
  67 class OGDF_EXPORT Module
  68 {
  69 public:
  70         //! The return type of a module.
  71         enum ReturnType {
  72                 retFeasible, //!< The solution is feasible.
  73                 retOptimal, //!< The solution is optimal
  74                 retNoFeasibleSolution, //!< There exists no feasible solution.
  75                 retTimeoutFeasible, //!< The solution is feasible, but there was a timeout.
  76                 retTimeoutInfeasible, //!< The solution is not feasible due to a timeout.
  77                 retError //! Computation was aborted due to an error.
  78         };
  79
  80         //! Initializes a module.
  81         Module() { }
  82
  83         virtual ~Module() { }
  84
  85         //! Returns true iff \a retVal indicates that the module returned a feasible solution.
  86         static bool isSolution(ReturnType ret) {
  87                 return ret == retFeasible || ret == retOptimal || ret == retTimeoutFeasible;
  88         }
  89 };
  90
  91
  92 } // end namespace ogdf
  93
  94
  95 #endif