src/la/laGraphVisitor.h

   1 /*
   2 Qanava - Graph drawing library for QT
   3 Copyright (C) 2005 Benoit AUTHEMAN
   4
   5 This program is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU General Public License
   7 as published by the Free Software Foundation; either version 2
   8 of the License, or (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 */
  19
  20 //-----------------------------------------------------------------------------
  21 // This file is a part of the Qanava software.
  22 //
  23 // \file        laGraphVisitor.h
  24 // \author      Benoit Autheman (benoit@faktiss.net)
  25 // \date        2004 February 15
  26 //-----------------------------------------------------------------------------
  27
  28
  29 #ifndef laGraphVisitor_h
  30 #define laGraphVisitor_h
  31
  32
  33 #include "../utl/utlConfig.h"
  34
  35
  36 //-----------------------------------------------------------------------------
  37 namespace qan { // ::qan
  38         namespace la { // ::qan::la
  39
  40                 class Node;
  41                 class Edge;
  42                 class Graph;
  43
  44                 //! Visitor for graph related data structures.
  45                 /*!
  46                         \nosubgrouping
  47                 */
  48                 class GraphVisitor
  49                 {
  50                         /*! \name Visit Methods Management *///----------------------------
  51                         //@{
  52                 public:
  53
  54                         //! Visit a graph.
  55                         virtual void    visit( Graph* graph ) = 0;
  56
  57                         //! Visit a graph node.
  58                         virtual void    visit( Node* node ) = 0;
  59
  60                         //! Visit a graph edge.
  61                         virtual void    visit( Edge* edge ) = 0;
  62                         //@}
  63                         //-----------------------------------------------------------------
  64                 };
  65
  66
  67
  68                 //! Convert graph related data structure as neato formatted text.
  69                 /*!
  70                         \nosubgrouping
  71                 */
  72                 class Neato     : public GraphVisitor
  73                 {
  74                         /*! \name Neato Constructor/Destructor *///------------------------
  75                         //@{
  76                 public:
  77
  78                         //! Neato default constructor.
  79                         Neato( );
  80
  81                         //! Neato default destructor.
  82                         virtual ~Neato( );
  83
  84                 private:
  85
  86                         //! Neato empty private copy constructor.
  87                         Neato( const Neato& visitor ) : GraphVisitor( visitor ) { }
  88                         //@}
  89                         //-----------------------------------------------------------------
  90
  91
  92
  93                         /*! \name Visit Methods Management *///----------------------------
  94                         //@{
  95                 public:
  96
  97                         //! Visit a graph.
  98                         virtual void    visit( Graph* graph );
  99
 100                         //! Visit a graph node.
 101                         virtual void    visit( Node* node );
 102
 103                         //! Visit a graph edge.
 104                         virtual void    visit( Edge* edge );
 105                         //@}
 106                         //-----------------------------------------------------------------
 107                 };
 108         } // ::qan::la
 109 } // ::qan
 110 //-----------------------------------------------------------------------------
 111
 112
 113 #endif // laGraphVisitor_h
 114