ext/OGDF/ogdf/module/UMLLayoutModule.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 Declaration of interface for layout algorithms for
  11  *        UML diagrams.
  12  *
  13  * \author Carsten Gutwenger
  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
  45 #ifdef _MSC_VER
  46 #pragma once
  47 #endif
  48
  49 #ifndef OGDF_UML_LAYOUT_MODULE_H
  50 #define OGDF_UML_LAYOUT_MODULE_H
  51
  52
  53 #include <ogdf/module/LayoutModule.h>
  54 #include <ogdf/basic/UMLGraph.h>
  55
  56
  57 namespace ogdf {
  58
  59
  60 /**
  61  * \brief Interface of UML layout algorithms.
  62  */
  63 class OGDF_EXPORT UMLLayoutModule : public LayoutModule
  64 {
  65 public:
  66         //! Initializes a UML layout module.
  67         UMLLayoutModule() { }
  68
  69         virtual ~UMLLayoutModule() { }
  70
  71         /**
  72          * \brief Computes a layout of UML graph \a umlGraph
  73          *
  74          * Must be implemented by derived classes.
  75          * @param umlGraph is the input UML graph and has to be assigned the UML layout.
  76          */
  77         virtual void call(UMLGraph &umlGraph) = 0;
  78
  79         /**
  80          * \brief Computes a layout of UML graph \a umlGraph
  81          *
  82          * @param umlGraph is the input UML graph and has to be assigned the UML layout.
  83          */
  84         void operator()(UMLGraph &umlGraph) { call(umlGraph); }
  85
  86         OGDF_MALLOC_NEW_DELETE
  87 };
  88
  89
  90 } // end namespace ogdf
  91
  92
  93 #endif