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