Tulip  4.3.0
Better Visualization Through Research
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Groups Pages
GraphAbstract.h
1 /*
2  *
3  * This file is part of Tulip (www.tulip-software.org)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  */
19 ///@cond DOXYGEN_HIDDEN
20 
21 #ifndef TULIP_SUPERGRAPHABSTRACT_H
22 #define TULIP_SUPERGRAPHABSTRACT_H
23 
24 #ifndef DOXYGEN_NOTFOR_USER
25 
26 #include <set>
27 #include <vector>
28 #include <tulip/Graph.h>
29 #include <tulip/DataSet.h>
30 
31 namespace tlp {
32 
33 #define GRAPH_SEQ std::vector<Graph *>
34 
35 template<class C>struct Iterator;
36 class PropertyManager;
37 class GraphProperty;
38 
39 ///Abstract class for default graph operations.
40 class GraphAbstract:public Graph {
41  friend class PropertyManager;
42 protected:
43  GraphAbstract(Graph *supergraph, unsigned int id);
44 public:
45  virtual ~GraphAbstract();
46  virtual void clear();
47  virtual Graph *addSubGraph(BooleanProperty *selection=NULL,
48  std::string name = "unnamed");
49  // used to force the id of the newly created subgraph
50  // when importing (tlp/tlpjson)
51  Graph *addSubGraph(unsigned int id,
52  BooleanProperty *selection=NULL,
53  std::string name = "");
54  virtual void delSubGraph(Graph *);
55  virtual void delAllSubGraphs(Graph *);
56  virtual Graph* getSuperGraph()const;
57  virtual Graph* getRoot() const;
58  virtual Iterator<Graph *>* getSubGraphs() const;
59  virtual bool isSubGraph(const Graph* sg) const;
60  virtual bool isDescendantGraph(const Graph* sg) const;
61  virtual Graph* getSubGraph(unsigned int id) const;
62  virtual Graph* getSubGraph(const std::string &name) const;
63  virtual Graph* getDescendantGraph(unsigned int id) const;
64  virtual Graph* getDescendantGraph(const std::string &name) const;
65  virtual Graph *getNthSubGraph(unsigned int n) const;
66  virtual unsigned int numberOfSubGraphs() const;
67  virtual unsigned int numberOfDescendantGraphs() const;
68 
69  //=======================================
70  virtual unsigned int deg(const node) const;
71  virtual unsigned int indeg(const node) const;
72  virtual unsigned int outdeg(const node) const;
73  virtual bool isMetaNode(const node) const;
74  virtual Graph* getNodeMetaInfo(const node) const;
75  virtual void delNodes(Iterator<node>* itN, bool deleteInAllGraphs);
76  virtual node source(const edge) const;
77  virtual void setSource(const edge, const node);
78  virtual node target(const edge) const;
79  virtual void setTarget(const edge, const node);
80  virtual const std::pair<node, node>& ends(const edge) const;
81  virtual void setEnds(const edge, const node, const node);
82  virtual node opposite(const edge, const node)const;
83  virtual void reverse(const edge);
84  virtual bool isMetaEdge(const edge) const;
85  virtual Iterator<edge>* getEdgeMetaInfo(const edge) const;
86  virtual void delEdges(Iterator<edge>* itE, bool deleteInAllGraphs = false);
87  //=======================================
88  virtual node getOneNode() const;
89  virtual node getInNode(const node,unsigned int ) const;
90  virtual node getOutNode(const node,unsigned int ) const;
91  virtual edge getOneEdge() const;
92  virtual unsigned int numberOfNodes() const;
93  virtual unsigned int numberOfEdges() const;
94  //========================================
95  bool existProperty(const std::string&) const;
96  bool existLocalProperty(const std::string&) const;
97  void delLocalProperty(const std::string&);
98  void addLocalProperty(const std::string &name, PropertyInterface *prop);
99  Iterator<std::string>* getLocalProperties() const;
100  Iterator<std::string>* getInheritedProperties() const;
101  Iterator<std::string>* getProperties() const;
102  Iterator<PropertyInterface*>* getLocalObjectProperties() const;
103  Iterator<PropertyInterface*>* getInheritedObjectProperties() const;
104  Iterator<PropertyInterface*>* getObjectProperties() const;
105  PropertyInterface* getProperty(const std::string &) const;
106 
107  // to get viewMetaGraph property
108  GraphProperty* getMetaGraphProperty();
109 
110  virtual void setName(const std::string &name);
111  virtual std::string getName() const;
112 
113  virtual Iterator<node>* bfs(const node root = node()) const;
114  virtual Iterator<node>* dfs(const node root = node()) const;
115 
116 protected:
117  DataSet& getNonConstAttributes();
118  void setSuperGraph(Graph *);
119  PropertyManager *propertyContainer;
120  const std::set<edge>& getReferencedEdges(const edge) const;
121 
122  // internally used to deal with sub graph deletion
123  virtual void clearSubGraphs();
124  virtual void removeSubGraph(Graph*);
125  virtual void restoreSubGraph(Graph*);
126  virtual void setSubGraphToKeep(Graph*);
127 
128 private:
129  DataSet attributes;
130  Graph *supergraph;
131  Graph* const root;
132  GRAPH_SEQ subgraphs;
133  Graph* subGraphToKeep;
134  // pointer to root viewMetaGraph property
135  GraphProperty* metaGraphProperty;
136  // notification of addition/deletion of inherited properties
137  void notifyBeforeAddInheritedProperty(const std::string& prop);
138  void notifyAddInheritedProperty(const std::string& prop);
139  void notifyBeforeDelInheritedProperty(const std::string& prop);
140  void notifyAfterDelInheritedProperty(const std::string& prop);
141 };
142 
143 }
144 #endif // DOXYGEN_NOTFOR_USER
145 
146 #endif
147 ///@endcond