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
|
/**
*
* This file is part of Tulip (https://tulip.labri.fr)
*
* Authors: David Auber and the Tulip development Team
* from LaBRI, University of Bordeaux
*
* 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.
*
*/
#ifndef CSVEXPORT_H
#define CSVEXPORT_H
#include <iostream>
#include <tulip/ExportModule.h>
/*@{*/
/// Export plugin for CSV format
/**
* \
* \brief This plugin enables to save the values of tulip graph properties
* associated to graph elements in a CSV formatted file.
*
* The plugin saves one row by graph element exported
* and have the following parameters:
*
* - <b>Type of elements<b> which enables to choose the type of graph elements
* to export, and has 3 possible values - nodes, edges or both -
* The default value is nodes.
*
* - <b>Export selection<b> which indicates if only selected elements
* have to be exported. The default value is false.
*
* - <b>Export id<b> which indicates if the id of graph elements
* has to be exported. The default value is false.
* If it is set to true and nodes are exported, a field named 'node id',
* whose value is the id of the node, is added at the beginning of each row.
* If edges are exported, two fields named 'src id' and 'tgt id'
* corresponding to the id of the source and target nodes of an edge
* are exported at the beginning of each row (immediately after the node id
* field if it is present).
* The 'node id' field is left blank when exporting a row corresponding to
* an edge; while the 'src id' and 'tgt id' are left blank when exporting
* a row for a node.
*
* - <b>Field separator<b> which enables to choose the field separator and
* has 4 possible values - semi-colon (;), comma (,), tab, space -
* The default values is semi-colon.
*
* - <b>String delimiter<b> which enables to indicates the delimiter used
* around the string of characters values.
* It has 2 possible values - double quote("), quote(') - and its default
* value is double quote.
*/
class CsvExport : public tlp::ExportModule {
public:
PLUGININFORMATION("CSV Export", "David Auber, Patrick Mary", "18/01/2011",
"<p>Supported extensions: csv</p><p>Exports the values of tulip graph "
"properties associated to graph elements in a CSV file.</p>",
"1.2", "File")
std::string icon() const override {
return ":/tulip/graphperspective/icons/32/spreadsheet.png";
}
CsvExport(const tlp::PluginContext *context);
bool exportGraph(std::ostream &) override;
std::string fieldSeparator;
char stringDelimiter;
char decimalMark;
void exportString(std::ostream &os, const std::string &s);
};
/*@}*/
#endif // CSVEXPORT_H
|
