Tulip 5.7.1
Large graphs analysis and drawing
Loading...
Searching...
No Matches
GraphProperty.h
1/*
2 *
3 * This file is part of Tulip (https://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
28namespace tlp {
29
30class PropertyContext;
31class GraphAbstract;
32
33typedef 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 */
42class TLP_SCOPE GraphProperty : public AbstractGraphProperty {
43 friend class GraphAbstract;
44
45public:
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 DEFINE_GET_CPP_CLASS_NAME;
64
65 // redefinition of some AbstractProperty methods
66 void setNodeValue(const node n,
67 tlp::StoredType<GraphType::RealType>::ReturnedConstValue g) override;
68 void setAllNodeValue(tlp::StoredType<GraphType::RealType>::ReturnedConstValue g) override;
69 void setValueToGraphNodes(tlp::StoredType<GraphType::RealType>::ReturnedConstValue g,
70 const Graph *graph) override;
71 bool readNodeDefaultValue(std::istream &iss) override;
72 bool readNodeValue(std::istream &iss, node n) override;
73 // tlp::GraphType encapsulates a tlp::Graph pointer but that is the graph id
74 // that gets serialized when using the TLPB format
75 unsigned int nodeValueSize() const override {
76 return sizeof(unsigned int);
77 }
78 unsigned int edgeValueSize() const override {
79 return 0;
80 }
81
82 // for optimizations purpose
83 bool hasNonDefaultValue(const node n) const {
84 return nodeProperties.hasNonDefaultValue(n.id);
85 }
86 bool hasNonDefaultValue(const edge e) const {
87 return !edgeProperties.get(e.id).empty();
88 }
89
90private:
91 MutableContainer<std::set<node>> referencedGraph;
92 const std::set<edge> &getReferencedEdges(const edge) const;
93};
94} // namespace tlp
95#endif
This class extends upon PropertyInterface, and adds type-safe methods to get and set the node and edg...
Event is the base class for all events used in the Observation mechanism.
Definition: Observable.h:52
A graph property that maps a tlp::Graph* value to graph elements.
Definition: GraphProperty.h:42
unsigned int edgeValueSize() const override
Returns the size in bytes of an edge's value.
Definition: GraphProperty.h:78
bool setAllEdgeStringValue(const std::string &v) override
Sets all the edges value to the value represented by the string. For some types, some parsing will be...
bool setAllNodeStringValue(const std::string &v) override
Sets all the nodes value to the value represented by the string. For some types, some parsing will be...
void treatEvent(const Event &) override
This function is called when events are sent to the Listeners, and Listeners only.
bool setEdgeStringValue(const edge e, const std::string &v) override
Sets a new value on the edge, represented by the string parameter.
PropertyInterface * clonePrototype(Graph *, const std::string &) const override
Creates a property of the same type (e.g. tlp::DoubleProperty) in the graph. The new property will no...
bool setStringValueToGraphNodes(const std::string &v, const tlp::Graph *graph) override
Sets all the nodes value to the value represented by the string for a graph. For some types,...
unsigned int nodeValueSize() const override
Returns the size in bytes of a node's value.
Definition: GraphProperty.h:75
bool readNodeDefaultValue(std::istream &iss) override
Reads the nodes default value.
const std::string & getTypename() const override
Gets a string describing the type of the property value (e.g. "graph", "double", "layout",...
Definition: GraphProperty.h:60
bool setNodeStringValue(const node n, const std::string &v) override
Sets a new value on the node, represented by the string parameter.
bool setStringValueToGraphEdges(const std::string &v, const tlp::Graph *graph) override
Sets all the edges value to the value represented by the string for a graph. For some types,...
bool readNodeValue(std::istream &iss, node n) override
Reads the value of a node.
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
unsigned int id
id The identifier of the node.
Definition: Node.h:44