src/qanNode.h

   1 /*
   2 Qanava - Graph drawing library for QT
   3 Copyright (C) 2006 Benoit AUTHEMAN
   4
   5 This library is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU Lesser General Public
   7 License as published by the Free Software Foundation; either
   8 version 2.1 of the License, or (at your option) any later version.
   9
  10 This library 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 GNU
  13 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public
  16 License along with this library; 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        laNode.h
  24 // \author      Benoit Autheman (benoit@libqanava.org)
  25 // \date        2004 February 15
  26 //-----------------------------------------------------------------------------
  27
  28
  29 #ifndef laNode_h
  30 #define laNode_h
  31
  32
  33 // Qanava headers
  34 #include "./qanEdge.h"
  35 #include "./qanVectorf.h"
  36
  37
  38 // Standard headers
  39 #include <cassert>
  40
  41
  42 // QT headers
  43 #include <QList>
  44 #include <QSet>
  45 #include <QDateTime>
  46
  47
  48 //-----------------------------------------------------------------------------
  49 //! Root qanava namespace
  50 namespace qan { // ::qan
  51
  52                 //! Model a node in a standard weighted and directed graph.
  53                 /*!
  54                         \nosubgrouping
  55                 */
  56                 class Node : public AttrFunc
  57                 {
  58                         /*! \name Node Constructor/Destructor *///-------------------------
  59                         //@{
  60                 public:
  61
  62                         //! Node constructor with label initialisation.
  63                         Node( const QString& label );
  64
  65                         //! Node constructor with label and type initialisation.
  66                         Node( const QString& label, int type );
  67
  68                         //! Node destructor.
  69                         ~Node( ) { }
  70
  71                 private:
  72
  73                         Node( const Node& n );
  74                         //@}
  75                         //-----------------------------------------------------------------
  76
  77
  78
  79                         /*! \name Node Edges Management *///-------------------------------
  80                         //@{
  81                 public:
  82
  83                         //! Typedef for a QT list of pointer on Node.
  84                         typedef QList< Node* >  List;
  85
  86                         //! Typedef for a QT set of pointer on Node.
  87                         typedef QSet< Node* >   Set;
  88
  89                         //! Get a list of all nodes pointing to this node.
  90                         const Edge::List&       getInEdges( ) const { return _inEdges; }
  91
  92                         //! Get a list of all nodes pointing to this node.
  93                         Edge::List&                     getInEdges( ) { return _inEdges; }
  94
  95                         //! Get a list of all node pointed by this node.
  96                         const Edge::List&       getOutEdges( ) const { return _outEdges; }
  97
  98                         //! Get a list of all node pointed by this node.
  99                         Edge::List&                     getOutEdges( ) { return _outEdges; }
 100
 101                         //! Collect a list of this node sub nodes.
 102                         void                            collectOutNodes( Node::List& outNodes );
 103
 104                         //! Collect a list of this node in nodes.
 105                         void                            collectInNodes( Node::List& outNodes );
 106
 107                         //! Collect a set of unique nodes pointed by this node.
 108                         void                            collectOutNodesSet( Node::Set& outNodes ) const;
 109
 110                         //! Collect a set of unique nodes referencing this node.
 111                         void                            collectInNodesSet( Node::Set& nodes ) const;
 112
 113                         //! Add an in edge.
 114                         void                            addInEdge( Edge& edge ) { _inEdges << &edge; }
 115
 116                         //! Add an out edge.
 117                         void                            addOutEdge( Edge& edge ) { _outEdges << &edge; }
 118
 119                         //! Get node in degree.
 120                         unsigned int            getInDegree( ) const { return _inEdges.size( ); }
 121
 122                         //! Get node out degree.
 123                         unsigned int            getOutDegree( ) const { return _outEdges.size( ); }
 124
 125                         //! Get a list of nodes adjacent to this (all in and out nodes, without this).
 126                         void                            getAdjacentNodesSet( Node::Set& nodes ) const;
 127
 128                         //! Get a list of nodes non adjacent to this (all nodes minus the adjacent node set collected with getAdjacentNodesSet()).
 129                         void                            getNonAdjacentNodesSet( Node::Set& nonAdjacentNodes, const Node::Set& graphNodes ) const;
 130
 131                         //! Return true if this node is a "leaf" (ie has no out edges).
 132                         bool                            isLeaf( ) const { return _outEdges.size( ) == 0; }
 133
 134                 private:
 135
 136                         //! Input edges.
 137                         Edge::List                      _inEdges;
 138
 139                         //! Output edges.
 140                         Edge::List                      _outEdges;
 141                         //@}
 142                         //-----------------------------------------------------------------
 143
 144
 145
 146                         /*! \name Node Property Management *///----------------------------
 147                         //@{
 148                 public:
 149
 150                         //! Attribute role.
 151                         enum Role
 152                         {
 153                                 TYPE                    = 1,
 154                                 LABEL                   = 2,
 155                                 POSITION                = 3,
 156                                 DIMENSION               = 4,
 157                                 DATE                    = 5,
 158                                 USER                    = 6
 159                         };
 160
 161                         enum { StdAttributeCount = 5 };
 162
 163                         //! Get this node label.
 164                         const QString&  getLabel( ) const { return *getAttribute< QString >( Node::LABEL ); }
 165
 166                         //! Set this node label.
 167                         void                    setLabel( const QString& label ) { setAttribute< QString >( Node::LABEL, label ); }
 168
 169                         //! Set this node's user defined type.
 170                         void                    setType( int type ) { setAttribute< int >( Node::TYPE, type ); }
 171
 172                         //! Get this node's user defined type.
 173                         int                             getType( ) const { return *getAttribute< int >( Node::TYPE ); }
 174
 175                         //! .
 176                         VectorF&                getPosition( ) { return *getAttribute< VectorF >( Node::POSITION ); }
 177
 178                         //! .
 179                         const VectorF&  getPosition( ) const { return *getAttribute< VectorF >( Node::POSITION ); }
 180
 181                         //! .
 182                         void                    setPosition( VectorF& position ) { setAttribute< VectorF >( Node::POSITION, position ); }
 183
 184                         //! .
 185                         void                    setPosition( float x, float y )
 186                         {
 187                                 VectorF& position = getPosition( );
 188                                 position( 0 ) = x; position( 1 ) = y;
 189                         }
 190
 191                         const VectorF&  getDimension( ) const { return *getAttribute< VectorF >( Node::DIMENSION ); }
 192
 193                         void                    setDimension( const VectorF& dimension ) { setAttribute< VectorF >( Node::DIMENSION, dimension ); }
 194
 195                         void                    setDimension( float x, float y )
 196                         {
 197                                 VectorF& dimension = *getAttribute< VectorF >( Node::DIMENSION );
 198                                 dimension( 0 ) = x; dimension( 1 ) = y;
 199                         }
 200
 201                         //! Set the node date from a text string with the Posix Time format (ex: 2002-Jan-01 10:00:01).
 202                         void                            setDate( const QString& date );
 203
 204                         //! Return the node date under Posix Time format (0 if the date is undefined).
 205                         const QDateTime*        getDate( ) const { return getAttribute< QDateTime >( Node::DATE ); }
 206                         //@}
 207                         //-----------------------------------------------------------------
 208                 };
 209 } // ::qan
 210 //-----------------------------------------------------------------------------
 211
 212
 213 #endif // laNode_h