ext/OGDF/ogdf/module/EmbedderModule.h

   1 /*
   2  * $Revision: 2546 $
   3  *
   4  * last checkin:
   5  *   $Author: gutwenger $
   6  *   $Date: 2012-07-04 21:16:17 +0200 (Mi, 04. Jul 2012) $
   7  ***************************************************************/
   8
   9 /** \file
  10  * \brief Declaration of interface for embedder for
  11  * graphs.
  12  *
  13  * \author Thorsten Kerkhof (thorsten.kerkhof@udo.edu)
  14  *
  15  * \par License:
  16  * This file is part of the Open Graph Drawing Framework (OGDF).
  17  *
  18  * \par
  19  * Copyright (C)<br>
  20  * See README.txt in the root directory of the OGDF installation for details.
  21  *
  22  * \par
  23  * This program is free software; you can redistribute it and/or
  24  * modify it under the terms of the GNU General Public License
  25  * Version 2 or 3 as published by the Free Software Foundation;
  26  * see the file LICENSE.txt included in the packaging of this file
  27  * for details.
  28  *
  29  * \par
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * \par
  36  * You should have received a copy of the GNU General Public
  37  * License along with this program; if not, write to the Free
  38  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  39  * Boston, MA 02110-1301, USA.
  40  *
  41  * \see  http://www.gnu.org/copyleft/gpl.html
  42  ***************************************************************/
  43
  44 #ifdef _MSC_VER
  45 #pragma once
  46 #endif
  47
  48 #ifndef OGDF_EMBEDDER_MODULE_H
  49 #define OGDF_EMBEDDER_MODULE_H
  50
  51 #include <ogdf/planarity/PlanRep.h>
  52 #include <ogdf/basic/Module.h>
  53 #include <ogdf/basic/Timeouter.h>
  54
  55 namespace ogdf {
  56
  57 /**
  58  * \brief Base class for embedder algorithms.
  59  *
  60  * An embedder algorithm computes a planar embedding of a planar
  61  * graph.
  62  *
  63  * \see PlanarizationLayout, PlanarizationGridLayout
  64  */
  65 class OGDF_EXPORT EmbedderModule : public Module, public Timeouter {
  66 public:
  67         //! Initializes an embedder module.
  68         EmbedderModule() { }
  69
  70         virtual ~EmbedderModule() { }
  71
  72         /**
  73          * \brief Calls the embedder algorithm for graph \a G.
  74          * \param G is the graph that shall be embedded.
  75          * \param adjExternal is set (by the algorithm) to an adjacency entry on the
  76          *        external face of \a G.
  77          */
  78         virtual void call(Graph& G, adjEntry& adjExternal) = 0;
  79
  80         //! Calls the embedder algorithm for planarized representation \a PG.
  81         void operator()(Graph& G, adjEntry& adjExternal) { call(G, adjExternal); }
  82
  83         OGDF_MALLOC_NEW_DELETE
  84 };
  85
  86 } // end namespace ogdf
  87
  88 #endif