Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Signals | Public Member Functions | Protected Attributes

TOPPASMergerVertex Class Reference
[TOPPAS]

A special vertex that allows to merge several inputs. More...

#include <OpenMS/VISUAL/TOPPASMergerVertex.h>

Inheritance diagram for TOPPASMergerVertex:
TOPPASVertex QObject QGraphicsItem

List of all members.

Signals

void mergeFailed (const QString message)
 Emitted when merging upstream data failed.

Public Member Functions

 TOPPASMergerVertex ()
 Default constructor.
 TOPPASMergerVertex (bool round_based)
 Constructor.
 TOPPASMergerVertex (const TOPPASMergerVertex &rhs)
 Copy constructor.
virtual ~TOPPASMergerVertex ()
 Destructor.
TOPPASMergerVertexoperator= (const TOPPASMergerVertex &rhs)
 Assignment operator.
virtual String getName () const
 returns "MergerVertex"
virtual void run ()
 check if upstream nodes are finished and call downstream nodes
bool allInputsReady ()
 Determines whether all inputs are ready (only a problem in mergers, when called from upstream).
bool roundBasedMode ()
 Determines whether this merger is merging round based or merging all inputs into one list.
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
 Paints the item.
virtual QRectF boundingRect () const
 Returns the bounding rectangle of this item.
virtual QPainterPath shape () const
 Returns a more precise shape.
virtual void markUnreachable ()
 Marks this node (and everything further downstream) as unreachable. Overridden behavior in mergers.

Protected Member Functions

reimplemented Qt events

void mouseDoubleClickEvent (QGraphicsSceneMouseEvent *e)

Protected Attributes

bool round_based_mode_
 Stores whether this merger is merging round based or merging all inputs into one list.

Detailed Description

A special vertex that allows to merge several inputs.

A special vertex that allows to merge several inputs. Mergers have two modes: The normal, round-based merging mode and a "wait & merge all" mode. In round-based mode, a merger first takes the first files of each incoming file list and merges them into a list (which has as many elements as the merger has incoming edges).

In "wait & merge all" mode, the merger first waits for all upstream mergers to finish all their merging rounds and then merges all collected files from all merging rounds for all incoming edges into one single list and calls the next tool with this list of files as input.


Constructor & Destructor Documentation

Default constructor.

TOPPASMergerVertex ( bool  round_based  ) 

Constructor.

TOPPASMergerVertex ( const TOPPASMergerVertex rhs  ) 

Copy constructor.

virtual ~TOPPASMergerVertex (  )  [virtual]

Destructor.


Member Function Documentation

bool allInputsReady (  ) 

Determines whether all inputs are ready (only a problem in mergers, when called from upstream).

Reimplemented from TOPPASVertex.

virtual QRectF boundingRect (  )  const [virtual]

Returns the bounding rectangle of this item.

Implements TOPPASVertex.

virtual String getName (  )  const [virtual]

returns "MergerVertex"

Implements TOPPASVertex.

virtual void markUnreachable (  )  [virtual]

Marks this node (and everything further downstream) as unreachable. Overridden behavior in mergers.

Reimplemented from TOPPASVertex.

void mergeFailed ( const QString  message  )  [signal]

Emitted when merging upstream data failed.

void mouseDoubleClickEvent ( QGraphicsSceneMouseEvent *  e  )  [protected]

Reimplemented from TOPPASVertex.

TOPPASMergerVertex& operator= ( const TOPPASMergerVertex rhs  ) 

Assignment operator.

virtual void paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget widget 
) [virtual]

Paints the item.

Implements TOPPASVertex.

bool roundBasedMode (  ) 

Determines whether this merger is merging round based or merging all inputs into one list.

virtual void run (  )  [virtual]

check if upstream nodes are finished and call downstream nodes

Reimplemented from TOPPASVertex.

virtual QPainterPath shape (  )  const [virtual]

Returns a more precise shape.

Implements TOPPASVertex.


Member Data Documentation

bool round_based_mode_ [protected]

Stores whether this merger is merging round based or merging all inputs into one list.


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:58 using doxygen 1.7.1