Tulip  5.2.0
Large graphs analysis and drawing
GraphProperty.h
1 /*
2  *
3  * This file is part of Tulip (http://tulip.labri.fr)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux
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 
20 #ifndef TULIP_METAGRAPH_H
21 #define TULIP_METAGRAPH_H
22 
23 #include <set>
24 
25 #include <tulip/PropertyTypes.h>
26 #include <tulip/AbstractProperty.h>
27 
28 namespace tlp {
29 
30 class PropertyContext;
31 class GraphAbstract;
32 
33 typedef AbstractProperty<tlp::GraphType, tlp::EdgeSetType> AbstractGraphProperty;
34 
35 /**
36  * @ingroup Graph
37  * @brief A graph property that maps a tlp::Graph* value to graph elements.
38  *
39  * @warning This property is mainly used into the meta node engine. Using GraphProperty outside of
40  * this system is strongly discouraged since it could lead to unwanted behavior.
41  */
42 class TLP_SCOPE GraphProperty : public AbstractGraphProperty {
43  friend class GraphAbstract;
44 
45 public:
46  GraphProperty(Graph *, const std::string &n = "");
47  ~GraphProperty() override;
48  // override Observable::treatEvent
49  void treatEvent(const Event &) override;
50 
51  // redefinition of some PropertyInterface methods
52  PropertyInterface *clonePrototype(Graph *, const std::string &) const override;
53  bool setNodeStringValue(const node n, const std::string &v) override;
54  bool setAllNodeStringValue(const std::string &v) override;
55  bool setStringValueToGraphNodes(const std::string &v, const tlp::Graph *graph) override;
56  bool setEdgeStringValue(const edge e, const std::string &v) override;
57  bool setAllEdgeStringValue(const std::string &v) override;
58  bool setStringValueToGraphEdges(const std::string &v, const tlp::Graph *graph) override;
59  static const std::string propertyTypename;
60  const std::string &getTypename() const override {
61  return propertyTypename;
62  }
63 
64  // redefinition of some AbstractProperty methods
65  void setNodeValue(const node n,
66  tlp::StoredType<GraphType::RealType>::ReturnedConstValue g) override;
67  void setAllNodeValue(tlp::StoredType<GraphType::RealType>::ReturnedConstValue g) override;
68  void setValueToGraphNodes(tlp::StoredType<GraphType::RealType>::ReturnedConstValue g,
69  const Graph *graph) override;
70  bool readNodeDefaultValue(std::istream &iss) override;
71  bool readNodeValue(std::istream &iss, node n) override;
72  // tlp::GraphType encapsulates a tlp::Graph pointer but that is the graph id
73  // that gets serialized when using the TLPB format
74  unsigned int nodeValueSize() const override {
75  return sizeof(unsigned int);
76  }
77  unsigned int edgeValueSize() const override {
78  return 0;
79  }
80 
81  // for optimizations purpose
82  bool hasNonDefaultValue(const node n) const {
83  return nodeProperties.hasNonDefaultValue(n.id);
84  }
85  bool hasNonDefaultValue(const edge e) const {
86  return !edgeProperties.get(e.id).empty();
87  }
88 
89 private:
90  MutableContainer<std::set<node>> referencedGraph;
91  const std::set<edge> &getReferencedEdges(const edge) const;
92 };
93 }
94 #endif
PropertyInterface describes the interface of a graph property.
The edge struct represents an edge in a Graph object.
Definition: Edge.h:40
The node struct represents a node in a Graph object.
Definition: Node.h:40
A graph property that maps a tlp::Graph* value to graph elements.
Definition: GraphProperty.h:42
Event is the base class for all events used in the Observation mechanism.
Definition: Observable.h:51
unsigned int id
id The identifier of the node.
Definition: Node.h:44
unsigned int id
id The identifier of the edge.
Definition: Edge.h:44