Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
TOPPASVertex.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2015.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Johannes Junker $
32 // $Authors: Johannes Junker, Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_VISUAL_TOPPASVERTEX_H
36 #define OPENMS_VISUAL_TOPPASVERTEX_H
37 
38 // ------------- DEBUGGING ----------------
39 
40 // ---- Uncomment to enable debug mode ----
41 //#define TOPPAS_DEBUG
42 // ----------------------------------------
43 
44 #ifdef TOPPAS_DEBUG
45 #define __DEBUG_BEGIN_METHOD__ \
46  { \
47  for (int dbg_indnt_cntr = 0; dbg_indnt_cntr < global_debug_indent_; ++dbg_indnt_cntr) \
48  { \
49  std::cout << " "; \
50  } \
51  std::cout << "BEGIN [" << topo_nr_ << "] " << __PRETTY_FUNCTION__ << std::endl; \
52  ++global_debug_indent_; \
53  }
54 
55 #define __DEBUG_END_METHOD__ \
56  { \
57  --global_debug_indent_; \
58  if (global_debug_indent_ < 0) global_debug_indent_ = 0; \
59  for (int dbg_indnt_cntr = 0; dbg_indnt_cntr < global_debug_indent_; ++dbg_indnt_cntr) \
60  { \
61  std::cout << " "; \
62  } \
63  std::cout << "END [" << topo_nr_ << "] " << __PRETTY_FUNCTION__ << std::endl; \
64  }
65 #else
66 #define __DEBUG_BEGIN_METHOD__ {}
67 #define __DEBUG_END_METHOD__ {}
68 #endif
69 
70 // ----------------------------------------
71 
72 // OpenMS_GUI config
74 
77 
78 #include <QtGui/QPainter>
79 #include <QtGui/QPainterPath>
80 #include <QtGui/QGraphicsSceneMouseEvent>
81 #include <QtGui/QGraphicsSceneContextMenuEvent>
82 #include <QtGui/QGraphicsItem>
83 #include <QtCore/QProcess>
84 #include <QtGui/QMenu>
85 
86 namespace OpenMS
87 {
88  class TOPPASEdge;
89 
101  class OPENMS_GUI_DLLAPI TOPPASVertex :
102  public QObject,
103  public QGraphicsItem
104  {
105  Q_OBJECT
106  Q_INTERFACES(QGraphicsItem)
107 
108 public:
109 
111  typedef QList<TOPPASEdge *> EdgeContainer;
113  typedef EdgeContainer::iterator EdgeIterator;
115  typedef EdgeContainer::const_iterator ConstEdgeIterator;
118  {
120  filenames(),
121  edge(0)
122  {
123  }
124 
125  QStringList filenames; //< filenames passed from upstream node in this round
126  TOPPASEdge * edge; //< edge that connects the upstream node to the current one
127  };
128 
133  typedef std::map<Int, VertexRoundPackage> RoundPackage;
134  typedef RoundPackage::const_iterator RoundPackageConstIt;
135  typedef RoundPackage::iterator RoundPackageIt;
136 
138  typedef std::vector<RoundPackage> RoundPackages;
139 
142  {
145  DFS_BLACK
146  };
147 
150  {
151  TV_ALLFINISHED, // all downstream nodes are done (including the ones which are feed by a parallel subtree)
152  TV_UNFINISHED, // some direct downstream node is not done
153  TV_UNFINISHED_INBRANCH // a parallel subtree which merged with some downstream node A was not done (which prevented processing of the node A)
154  };
155 
157  TOPPASVertex();
159  TOPPASVertex(const TOPPASVertex & rhs);
161  virtual ~TOPPASVertex();
163  TOPPASVertex & operator=(const TOPPASVertex & rhs);
164 
168  bool buildRoundPackages(RoundPackages & pkg, String & error_msg);
169 
171  bool isUpstreamFinished() const;
172 
174  virtual QRectF boundingRect() const = 0;
176  virtual QPainterPath shape() const = 0;
178  virtual void paint(QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget) = 0;
180  ConstEdgeIterator outEdgesBegin() const;
182  ConstEdgeIterator outEdgesEnd() const;
184  ConstEdgeIterator inEdgesBegin() const;
186  ConstEdgeIterator inEdgesEnd() const;
188  Size incomingEdgesCount();
190  Size outgoingEdgesCount();
192  void addInEdge(TOPPASEdge * edge);
194  void addOutEdge(TOPPASEdge * edge);
196  void removeInEdge(TOPPASEdge * edge);
198  void removeOutEdge(TOPPASEdge * edge);
200  DFS_COLOR getDFSColor();
202  void setDFSColor(DFS_COLOR color);
204  TOPPASVertex * getDFSParent();
206  void setDFSParent(TOPPASVertex * parent);
208  TOPPASVertex::SUBSTREESTATUS getSubtreeStatus() const;
210  bool isTopoSortMarked();
212  void setTopoSortMarked(bool b);
214  UInt getTopoNr();
216  virtual void setTopoNr(UInt nr);
219  virtual void reset(bool reset_all_files = false);
221  virtual void markUnreachable();
223  bool isReachable();
225  bool isFinished() const;
228  virtual void run();
230  virtual bool invertRecylingMode();
232  bool isRecyclingEnabled() const;
234  void setRecycling(const bool is_enabled);
235 
236  // get the name of the vertex (to be overridden by derived classes)
237  virtual String getName() const = 0;
238 
244  QStringList getFileNames(int param_index, int round) const;
245 
247  QStringList getFileNames() const;
248 
249  // get the output structure directly
250  const RoundPackages & getOutputFiles() const;
251 
252 
254  bool allInputsReady();
255 
256 
257 public slots:
258 
260  virtual void inEdgeHasChanged();
262  virtual void outEdgeHasChanged();
263 
264 signals:
265 
267  void clicked();
269  void released();
271  void hoveringEdgePosChanged(const QPointF & new_pos);
273  void newHoveringEdge(const QPointF & pos);
275  void finishHoveringEdge();
277  void somethingHasChanged();
279  void itemDragged(qreal dx, qreal dy);
282  void parameterChanged(const bool invalidates_running_pipeline);
283 
284 protected:
285 
287  EdgeContainer in_edges_;
289  EdgeContainer out_edges_;
293  QColor pen_color_;
295  QColor brush_color_;
305  RoundPackages output_files_;
311  bool finished_;
316 
317 
318 #ifdef TOPPAS_DEBUG
319  // Indentation level for nicer debug output
320  static int global_debug_indent_;
321 #endif
322 
324 
325  void mouseReleaseEvent(QGraphicsSceneMouseEvent * e);
326  void mousePressEvent(QGraphicsSceneMouseEvent * e);
327  void mouseDoubleClickEvent(QGraphicsSceneMouseEvent * e);
328  void mouseMoveEvent(QGraphicsSceneMouseEvent * e);
329  void contextMenuEvent(QGraphicsSceneContextMenuEvent * event);
331 
333  virtual void moveNewEdgeTo_(const QPointF & pos);
335  String get3CharsNumber_(UInt number) const;
336 
338  void debugOut_(const String &
339 #ifdef TOPPAS_DEBUG
340  message
341 #endif
342  ) const
343  {
344 #ifdef TOPPAS_DEBUG
345  for (int i = 0; i < global_debug_indent_; ++i)
346  {
347  std::cout << " ";
348  }
349  std::cout << "[" << topo_nr_ << "] " << message << std::endl;
350 #endif
351  }
352 
353  };
354 }
355 
356 #endif
TOPPASEdge * edge
Definition: TOPPASVertex.h:126
bool edge_being_created_
Indicates whether a new out edge is currently being created.
Definition: TOPPASVertex.h:291
QColor pen_color_
The color of the pen.
Definition: TOPPASVertex.h:293
Definition: TOPPASVertex.h:143
RoundPackage::iterator RoundPackageIt
Definition: TOPPASVertex.h:135
A more convenient string class.
Definition: String.h:57
RoundPackage::const_iterator RoundPackageConstIt
Definition: TOPPASVertex.h:134
bool finished_
Stores whether this node has already been processed during the current pipeline execution.
Definition: TOPPASVertex.h:311
The base class of the different vertex classes.
Definition: TOPPASVertex.h:101
std::map< Int, VertexRoundPackage > RoundPackage
Definition: TOPPASVertex.h:133
Info for one edge and round, to be passed to next node.
Definition: TOPPASVertex.h:117
bool allow_output_recycling_
shall subsequent tools be allowed to recycle the output of this node to match the number of rounds im...
Definition: TOPPASVertex.h:315
TOPPASVertex * dfs_parent_
The DFS parent of this node.
Definition: TOPPASVertex.h:299
DFS_COLOR dfs_color_
The DFS color of this node.
Definition: TOPPASVertex.h:297
QStringList filenames
Definition: TOPPASVertex.h:125
Definition: TOPPASVertex.h:152
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
An edge representing a data flow in TOPPAS.
Definition: TOPPASEdge.h:59
T round(T x)
Rounds the value.
Definition: MathFunctions.h:137
SUBSTREESTATUS
The color of a vertex during depth-first search.
Definition: TOPPASVertex.h:149
EdgeContainer::iterator EdgeIterator
A mutable iterator for in/out edges.
Definition: TOPPASVertex.h:113
EdgeContainer out_edges_
The list of outgoing edges.
Definition: TOPPASVertex.h:289
int round_total_
number of rounds this node will do ('Merge All' nodes will pass everything, thus do only one round) ...
Definition: TOPPASVertex.h:307
void debugOut_(const String &) const
Displays the debug output message, if TOPPAS_DEBUG is defined.
Definition: TOPPASVertex.h:338
bool reachable_
Indicates whether this node is reachable (i.e. there is an input node somewhere further upstream) ...
Definition: TOPPASVertex.h:313
DFS_COLOR
The color of a vertex during depth-first search.
Definition: TOPPASVertex.h:141
Definition: TOPPASVertex.h:144
std::vector< RoundPackage > RoundPackages
all information a node needs to process all rounds
Definition: TOPPASVertex.h:138
EdgeContainer in_edges_
The list of incoming edges.
Definition: TOPPASVertex.h:287
RoundPackages output_files_
Stores the current output file names for each output parameter.
Definition: TOPPASVertex.h:305
QList< TOPPASEdge * > EdgeContainer
The container for in/out edges.
Definition: TOPPASVertex.h:111
VertexRoundPackage()
Definition: TOPPASVertex.h:119
Definition: TOPPASVertex.h:151
QColor brush_color_
The color of the brush.
Definition: TOPPASVertex.h:295
EdgeContainer::const_iterator ConstEdgeIterator
A const iterator for in/out edges.
Definition: TOPPASVertex.h:115
bool topo_sort_marked_
"marked" flag for topological sort
Definition: TOPPASVertex.h:301
UInt topo_nr_
The number in a topological sort of the entire graph.
Definition: TOPPASVertex.h:303
int round_counter_
currently finished number of rounds (TODO: do we need that?)
Definition: TOPPASVertex.h:309

OpenMS / TOPP release 2.0.0 Documentation generated on Tue Aug 25 2015 05:53:54 using doxygen 1.8.9.1