TOPPASOutputFileListVertex Class Reference

A vertex representing an output file list. More...

#include <OpenMS/VISUAL/TOPPASOutputFileListVertex.h>

Inheritance diagram for TOPPASOutputFileListVertex:

Public Slots
virtual void	inEdgeHasChanged ()
Public Slots inherited from TOPPASVertex
virtual void	inEdgeHasChanged ()
	Called by an incoming edge when it has changed. More...
virtual void	outEdgeHasChanged ()
	Called by an outgoing edge when it has changed. More...

Signals
void	outputFileWritten (const String &file)
	Emitted when an output file was written. More...
void	outputFolderNameChanged ()
	Emitted when user has changed the output folder name (i.e. output dir needs to be newly created and packages updates) More...
Signals inherited from TOPPASVertex
void	clicked ()
	Emitted when this item is clicked. More...
void	released ()
	Emitted when this item is released. More...
void	hoveringEdgePosChanged (const QPointF &new_pos)
	Emitted when the position of the hovering edge changes. More...
void	newHoveringEdge (const QPointF &pos)
	Emitted when a new out edge is supposed to be created. More...
void	finishHoveringEdge ()
	Emitted when the mouse is released after having dragged a new edge somewhere. More...
void	somethingHasChanged ()
	Emitted when something has changed. More...
void	itemDragged (qreal dx, qreal dy)
	Emitted when the item is dragged. More...
void	parameterChanged (const bool invalidates_running_pipeline)

Public Member Functions
	TOPPASOutputFileListVertex ()
	Default constructor. More...
	TOPPASOutputFileListVertex (const TOPPASOutputFileListVertex &rhs)
	Copy constructor. More...
virtual	~TOPPASOutputFileListVertex ()
	Destructor. More...
TOPPASOutputFileListVertex &	operator= (const TOPPASOutputFileListVertex &rhs)
	Assignment operator. More...
virtual String	getName () const
	returns "OutputVertex" More...
virtual void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
	Paints the item. More...
virtual QRectF	boundingRect () const
	Returns the bounding rectangle of this item. More...
virtual QPainterPath	shape () const
	Returns a more precise shape. More...
virtual void	reset (bool reset_all_files=false)
virtual void	run ()
	Called when the parent node has finished execution. More...
String	getFullOutputDirectory () const
	Returns the full directory (including preceding output path as selected by user) More...
String	getOutputDir () const
	Returns the directory where the output files are stored. More...
String	createOutputDir ()
	Creates the output directory for this node. More...
virtual void	setTopoNr (UInt nr)
	Sets the topological sort number and removes invalidated tmp files. More...
void	openContainingFolder ()
	Opens the folders of the output files. More...
void	setOutputFolderName (const QString &name)
const QString &	getOutputFolderName () const
	return the output folder where results are written More...
Public Member Functions inherited from TOPPASVertex
	TOPPASVertex ()
	Default Constructor. More...
	TOPPASVertex (const TOPPASVertex &rhs)
	Copy constructor. More...
virtual	~TOPPASVertex ()
	Destructor. More...
TOPPASVertex &	operator= (const TOPPASVertex &rhs)
	Assignment operator. More...
bool	buildRoundPackages (RoundPackages &pkg, String &error_msg)
bool	isUpstreamFinished () const
	check if all upstream nodes are ready to go ( 'finished_' is true) More...
ConstEdgeIterator	outEdgesBegin () const
	Returns begin() iterator of outgoing edges. More...
ConstEdgeIterator	outEdgesEnd () const
	Returns end() iterator of outgoing edges. More...
ConstEdgeIterator	inEdgesBegin () const
	Returns begin() iterator of incoming edges. More...
ConstEdgeIterator	inEdgesEnd () const
	Returns end() iterator of incoming edges. More...
Size	incomingEdgesCount ()
	Returns the number of incoming edges. More...
Size	outgoingEdgesCount ()
	Returns the number of outgoing edges. More...
void	addInEdge (TOPPASEdge *edge)
	Adds an incoming edge. More...
void	addOutEdge (TOPPASEdge *edge)
	Adds an outgoing edge. More...
void	removeInEdge (TOPPASEdge *edge)
	Removes an incoming edge. More...
void	removeOutEdge (TOPPASEdge *edge)
	Removes an outgoing edge. More...
DFS_COLOR	getDFSColor ()
	Returns the DFS color of this node. More...
void	setDFSColor (DFS_COLOR color)
	Sets the DFS color of this node. More...
TOPPASVertex *	getDFSParent ()
	Returns the DFS parent of this node. More...
void	setDFSParent (TOPPASVertex *parent)
	Sets the DFS parent of this node. More...
TOPPASVertex::SUBSTREESTATUS	getSubtreeStatus () const
	Checks if all tools in the subtree below this node are finished. More...
bool	isTopoSortMarked ()
	Returns whether the vertex has been marked already (during topological sort) More...
void	setTopoSortMarked (bool b)
	(Un)marks the vertex (during topological sort) More...
UInt	getTopoNr ()
	Returns the topological sort number. More...
virtual void	markUnreachable ()
	Marks this node (and everything further downstream) as unreachable. Overridden behavior in mergers. More...
bool	isReachable ()
	Returns whether this node is reachable. More...
bool	isFinished () const
	Returns whether this node has already been processed during the current pipeline execution. More...
virtual bool	invertRecylingMode ()
	invert status of recycling More...
bool	isRecyclingEnabled () const
	get status of recycling More...
void	setRecycling (const bool is_enabled)
	set status of recycling More...
QStringList	getFileNames (int param_index, int round) const
	gets filenames for a certain output parameter (from this vertex), for a certain TOPPAS round More...
QStringList	getFileNames () const
	get all output files for all parameters for all rounds More...
const RoundPackages &	getOutputFiles () const
bool	allInputsReady ()
	check if all upstream nodes are finished More...

Static Protected Member Functions
static bool	copy_ (const QString &from, const QString &to)

Protected Attributes
QString	output_folder_name_
int	files_written_
int	files_total_
Protected Attributes inherited from TOPPASVertex
EdgeContainer	in_edges_
	The list of incoming edges. More...
EdgeContainer	out_edges_
	The list of outgoing edges. More...
bool	edge_being_created_
	Indicates whether a new out edge is currently being created. More...
QColor	pen_color_
	The color of the pen. More...
QColor	brush_color_
	The color of the brush. More...
DFS_COLOR	dfs_color_
	The DFS color of this node. More...
TOPPASVertex *	dfs_parent_
	The DFS parent of this node. More...
bool	topo_sort_marked_
	"marked" flag for topological sort More...
UInt	topo_nr_
	The number in a topological sort of the entire graph. More...
RoundPackages	output_files_
	Stores the current output file names for each output parameter. More...
int	round_total_
	number of rounds this node will do ('Merge All' nodes will pass everything, thus do only one round) More...
int	round_counter_
	currently finished number of rounds (TODO: do we need that?) More...
bool	finished_
	Stores whether this node has already been processed during the current pipeline execution. More...
bool	reachable_
	Indicates whether this node is reachable (i.e. there is an input node somewhere further upstream) More...
bool	allow_output_recycling_
	shall subsequent tools be allowed to recycle the output of this node to match the number of rounds imposed by other parent nodes? More...

Additional Inherited Members
Public Types inherited from TOPPASVertex
enum	DFS_COLOR { DFS_WHITE, DFS_GRAY, DFS_BLACK }
	The color of a vertex during depth-first search. More...
enum	SUBSTREESTATUS { TV_ALLFINISHED, TV_UNFINISHED, TV_UNFINISHED_INBRANCH }
	The color of a vertex during depth-first search. More...
typedef QList< TOPPASEdge * >	EdgeContainer
	The container for in/out edges. More...
typedef EdgeContainer::iterator	EdgeIterator
	A mutable iterator for in/out edges. More...
typedef EdgeContainer::const_iterator	ConstEdgeIterator
	A const iterator for in/out edges. More...
typedef std::map< Int, VertexRoundPackage >	RoundPackage
typedef RoundPackage::const_iterator	RoundPackageConstIt
typedef RoundPackage::iterator	RoundPackageIt
typedef std::vector< RoundPackage >	RoundPackages
	all information a node needs to process all rounds More...
Protected Member Functions inherited from TOPPASVertex
virtual void	moveNewEdgeTo_ (const QPointF &pos)
	Moves the target pos of the edge which is just being created to pos. More...
String	get3CharsNumber_ (UInt number) const
	Returns a three character string (i.e. 001 instead of 1) for the given number. More...
void	debugOut_ (const String &) const
	Displays the debug output message, if TOPPAS_DEBUG is defined. More...
void	mouseReleaseEvent (QGraphicsSceneMouseEvent *e)
void	mousePressEvent (QGraphicsSceneMouseEvent *e)
void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *e)
void	mouseMoveEvent (QGraphicsSceneMouseEvent *e)
void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)

Detailed Description

A vertex representing an output file list.

Constructor & Destructor Documentation

TOPPASOutputFileListVertex() [1/2]

TOPPASOutputFileListVertex

(

)

Default constructor.

TOPPASOutputFileListVertex() [2/2]

TOPPASOutputFileListVertex

(

const TOPPASOutputFileListVertex &

rhs

)

Copy constructor.

~TOPPASOutputFileListVertex()

virtual ~TOPPASOutputFileListVertex ( )

virtual

Destructor.

Member Function Documentation

boundingRect()

virtual QRectF boundingRect ( ) const

virtual

Returns the bounding rectangle of this item.

Implements TOPPASVertex.

copy_()

static bool copy_ ( const QString &  from, const QString &  to  )

staticprotected

createOutputDir()

String createOutputDir

(

)

Creates the output directory for this node.

getFullOutputDirectory()

String getFullOutputDirectory

(

)

const

Returns the full directory (including preceding output path as selected by user)

getName()

virtual String getName ( ) const

virtual

returns "OutputVertex"

Implements TOPPASVertex.

getOutputDir()

String getOutputDir

(

)

const

Returns the directory where the output files are stored.

getOutputFolderName()

const QString& getOutputFolderName

(

)

const

return the output folder where results are written

inEdgeHasChanged

virtual void inEdgeHasChanged ( )

virtualslot

openContainingFolder()

void openContainingFolder

(

)

Opens the folders of the output files.

operator=()

TOPPASOutputFileListVertex& operator=

(

const TOPPASOutputFileListVertex &

rhs

)

Assignment operator.

outputFileWritten

void outputFileWritten ( const String &  file )

signal

Emitted when an output file was written.

outputFolderNameChanged

void outputFolderNameChanged ( )

signal

Emitted when user has changed the output folder name (i.e. output dir needs to be newly created and packages updates)

paint()

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

virtual

Paints the item.

Implements TOPPASVertex.

reset()

virtual void reset ( bool  reset_all_files = false )

virtual

Resets the status

Parameters

reset_all_files

Not used in this implementation, but in derived classes

Reimplemented from TOPPASVertex.

run()

virtual void run ( )

virtual

Called when the parent node has finished execution.

Reimplemented from TOPPASVertex.

setOutputFolderName()

void setOutputFolderName

(

const QString &

name

)

Sets a custom output folder name, which will be integrated into 'getOutputDir()' and 'getFullOutputDirectory()' calls.

Note

The string is not checked for validity (avoid characters which are not allowed in directories, e.g. '{')

setTopoNr()

virtual void setTopoNr ( UInt  nr )

virtual

Sets the topological sort number and removes invalidated tmp files.

Reimplemented from TOPPASVertex.

shape()

virtual QPainterPath shape ( ) const

virtual

Returns a more precise shape.

Implements TOPPASVertex.

Member Data Documentation

files_total_

int files_total_

protected

files_written_

int files_written_

protected

output_folder_name_

QString output_folder_name_

protected