1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/**
*
* This file is part of Tulip (www.tulip-software.org)
*
* Authors: David Auber and the Tulip development Team
* from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
*
* Tulip is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* Tulip is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
*/
// +-------------------------------------------------------------------------+
// | Tulip Python Bindings |
// | inspired from bindings by the Booggie project development team |
// | (http://booggie.org/) |
// +-------------------------------------------------------------------------+
%ModuleHeaderCode
#include <tulip/ExportModule.h>
%End
namespace tlp {
class ExportModule: tlp::Plugin {
%TypeHeaderCode
#include <tulip/ExportModule.h>
%End
public:
%Docstring
Bases: :class:`tlp.WithParameter`
This abstract class describes an export plugin.
.. rubric:: class attributes
.. py:attribute:: graph
The :class:`tlp.Graph` to export
.. py:attribute:: dataSet
A dictionnary containing parameters for this export plugin, if any
.. py:attribute:: pluginProgress
A :class:`tlp.PluginProgress` to give feedback to the user. It can be :const:`None`, so use with caution
.. rubric:: class methods
%End
ExportModule(const tlp::PluginContext* context);
virtual ~ExportModule();
virtual std::string fileExtension() const = 0;
virtual std::string category() const;
virtual bool exportGraph(std::ostream &os) = 0;
%Docstring
tlp.ExportModule.exportGraph(os)
This method is called to export the graph to a file.
Derived classes must implement it.
The os parameter is an output file stream (initialized by the Tulip GUI
or by the :func:`tlp.exportGraph` function.). To write data to the file,
you have to use the following syntax::
# write the number of nodes and edges to the file
os << self.graph.numberOfNodes() << "\n"
os << self.graph.numberOfEdges() << "\n"
A boolean must also be returned
to indicate if the export was successful.
:param os: an output file stream
:type os: std.ostream
:rtype: boolean
%End
tlp::Graph *graph;
tlp::PluginProgress *pluginProgress;
tlp::DataSet *dataSet;
};
};
|
