Tulip  4.7.0
Better Visualization Through Research
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Groups Pages
GraphTest.h
1 /*
2  *
3  * This file is part of Tulip (www.tulip-software.org)
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 ///@cond DOXYGEN_HIDDEN
20 
21 
22 #ifndef _GRAPHTEST_H
23 #define _GRAPHTEST_H
24 
25 #include <tulip/Algorithm.h>
26 
27 namespace tlp {
28 class GraphTest : public tlp::Algorithm {
29 public:
30  GraphTest(const tlp::PluginContext* context) : Algorithm(context) {
31  addOutParameter<bool>("result",
32  HTML_HELP_OPEN() \
33  HTML_HELP_DEF( "type", "bool" ) \
34  HTML_HELP_BODY() \
35  "Whether the graph passed the test or not." \
36  HTML_HELP_CLOSE());
37  }
38 
39  virtual bool run() {
40  bool result = test();
41 
42  if (dataSet) {
43  dataSet->set("result",result);
44  }
45 
46  return true;
47  }
48 
49  virtual bool test()=0;
50 };
51 
52 }
53 #endif //_GRAPHTEST_H
54 ///@endcond
This abstract class describes a basic algorithm plugin.
Definition: Algorithm.h:45
Contains runtime parameters for a plugin.
Definition: PluginContext.h:39