graph 6.0.0
Graph: generic attributed relational graphs
gwriter.h
Go to the documentation of this file.
1/* This software and supporting documentation are distributed by
2 * Institut Federatif de Recherche 49
3 * CEA/NeuroSpin, Batiment 145,
4 * 91191 Gif-sur-Yvette cedex
5 * France
6 *
7 * This software is governed by the CeCILL-B license under
8 * French law and abiding by the rules of distribution of free software.
9 * You can use, modify and/or redistribute the software under the
10 * terms of the CeCILL-B license as circulated by CEA, CNRS
11 * and INRIA at the following URL "http://www.cecill.info".
12 *
13 * As a counterpart to the access to the source code and rights to copy,
14 * modify and redistribute granted by the license, users are provided only
15 * with a limited warranty and the software's author, the holder of the
16 * economic rights, and the successive licensors have only limited
17 * liability.
18 *
19 * In this respect, the user's attention is drawn to the risks associated
20 * with loading, using, modifying and/or developing or reproducing the
21 * software by the user in light of its specific status of free software,
22 * that may mean that it is complicated to manipulate, and that also
23 * therefore means that it is reserved for developers and experienced
24 * professionals having in-depth computer knowledge. Users are therefore
25 * encouraged to load and test the software's suitability as regards their
26 * requirements in conditions enabling the security of their systems and/or
27 * data to be ensured and, more generally, to use and operate it in the
28 * same conditions as regards security.
29 *
30 * The fact that you are presently reading this means that you have had
31 * knowledge of the CeCILL-B license and that you accept its terms.
32 */
33
34#ifndef GRAPH_GRAPH_GWRITER_H
35#define GRAPH_GRAPH_GWRITER_H
36
37
38//=============================================================================
39// H E A D E R F I L E S
40//=============================================================================
41
43#include <soma-io/writer/awriter.h>
44
45
46//=============================================================================
47// F O R W A R D D E C L A R A T I O N S
48//=============================================================================
49
50class Graph;
51class Vertex;
52class Edge;
53
54
55//=============================================================================
56// C L A S S D E C L A R A T I O N
57//=============================================================================
58
61class GRAPH_API GraphWriter : public carto::AttributedWriter
62{
63
64public:
65
66 //---------------------------------------------------------------------
68 //---------------------------------------------------------------------
70
71 GraphWriter(const std::string& filename,
72 const carto::SyntaxSet& syntax,
73 const HelperSet& helpers = HelperSet());
74
76 const HelperSet& helpers = HelperSet());
77
78 virtual ~GraphWriter();
79
81
82 //---------------------------------------------------------------------
84 //---------------------------------------------------------------------
86
90 virtual void write(const Graph& graph);
91
93
94protected:
95
96 //---------------------------------------------------------------------
98 //---------------------------------------------------------------------
100
104 virtual void write(const Vertex& vertex);
105
109 virtual void write(const Edge& edge);
110
112
113private:
114
115 //---------------------------------------------------------------------
117 //---------------------------------------------------------------------
119
121 GraphWriter(const GraphWriter&);
122
124 GraphWriter& operator=(const GraphWriter&);
125
127
128 //---------------------------------------------------------------------
130 //---------------------------------------------------------------------
132
134 int _index;
135
137 std::map<const Vertex*, int> _serializer;
138
140};
141
142
143//=============================================================================
144// F U N C T I O N S
145//=============================================================================
146
153
154
155#endif
The abstract base class for all types of edges; edges are created and managed by Graphs.
Definition edge.h:69
To write a Graph to a file.
Definition gwriter.h:62
virtual void write(const Vertex &vertex)
write a Vertex to a file
GraphWriter(const carto::SyntaxSet &syntax, const HelperSet &helpers=HelperSet())
virtual ~GraphWriter()
virtual void write(const Graph &graph)
write a Graph to a file
virtual void write(const Edge &edge)
write an Edge to a file
GraphWriter(const std::string &filename, const carto::SyntaxSet &syntax, const HelperSet &helpers=HelperSet())
The base class for graphs.
Definition graph.h:72
Vertices are created and managed by Graphs.
Definition vertex.h:64
GRAPH_API GraphWriter & operator<<(GraphWriter &writer, const Graph &graph)
Save a graph to a file using a GraphWriter.
#define GRAPH_API
std::map< std::string, Syntax > SyntaxSet