File: ToLabels.cpp

package info (click to toggle)
tulip 6.0.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 196,224 kB
  • sloc: cpp: 571,851; ansic: 13,983; python: 4,105; sh: 1,555; yacc: 522; xml: 484; makefile: 168; pascal: 148; lex: 55
file content (111 lines) | stat: -rw-r--r-- 3,602 bytes parent folder | download
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
99
100
101
102
103
104
105
106
107
108
109
110
111
/**
 *
 * 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.
 *
 */

#include <tulip/PropertyAlgorithm.h>
#include <tulip/BooleanProperty.h>
#include <tulip/StringProperty.h>

using namespace tlp;

static const char *paramHelp[] = {
    // input
    "Source property",

    // selection
    "Set of elements for which to set the labels. if none is selected, the whole graph will be used.",

    // nodes
    "Sets labels on nodes.",

    // edges
    "Set labels on edges."};

class ToLabels : public tlp::StringAlgorithm {
  bool onNodes, onEdges;

public:
  PLUGININFORMATION(
      "To labels", "Ludwig Fiolka", "2012/03/16",
      "Use a string representation of the values of a given property as the labels of nodes and/or edges.",
      "1.2", "")
  ToLabels(const tlp::PluginContext *context)
      // set second parameter of the constructor below to true because
      // result needs to be an inout parameter
      // in order to preserve the original values of non targeted elements
      // i.e if "nodes" == true and "edges==false", the values of edges must be preserved
      : StringAlgorithm(context, true), onNodes(true), onEdges(true) {
    addInParameter<PropertyInterface *>("property", paramHelp[0], "viewMetric", true);
    addInParameter<BooleanProperty>("selection", paramHelp[1], "", false);
    addInParameter<bool>("nodes", paramHelp[2], "true");
    addInParameter<bool>("edges", paramHelp[3], "true");
  }

  bool check(std::string &errMsg) override {
    if (dataSet != nullptr) {
      dataSet->get("nodes", onNodes);
      dataSet->get("edges", onEdges);
      if ((onNodes == false) && (onEdges == false)) {
        errMsg = "No element selected. Please select at least nodes or edges.";
        return false;
      }
    }
    return true;
  }

  bool run() override {
    PropertyInterface *input = nullptr;
    BooleanProperty *selection = nullptr;

    if (dataSet != nullptr) {
      dataSet->get("property", input);
      dataSet->get("selection", selection);
    } else {
      input = graph->getProperty("viewMetric");
      selection = graph->getProperty<BooleanProperty>("viewSelection");
    }

    pluginProgress->showPreview(false);

    if (onNodes) {
      pluginProgress->setComment("Copying values of nodes");
      int step = 0, max_step = graph->numberOfNodes();
      for (auto n : selection ? selection->getNonDefaultValuatedNodes() : graph->getNodes()) {
        if ((++step % 100) == 0)
          pluginProgress->progress(step, max_step);

        result->setNodeValue(n, input->getNodeStringValue(n));
      }
    }

    if (onEdges) {
      pluginProgress->setComment("Copying values of edges");
      int step = 0, max_step = graph->numberOfEdges();
      for (auto e : selection ? selection->getNonDefaultValuatedEdges() : graph->getEdges()) {
        if ((++step % 100) == 0)
          pluginProgress->progress(step, max_step);

        result->setEdgeValue(e, input->getEdgeStringValue(e));
      }
    }

    return true;
  }
};

PLUGIN(ToLabels)