A container for all visual items of a TOPPAS workflow. More...

#include <OpenMS/VISUAL/TOPPASScene.h>

Inheritance diagram for TOPPASScene:

Classes
struct	TOPPProcess
	Stores the information for a TOPP process. More...
Public Types
enum	ActionMode { AM_NEW_EDGE, AM_MOVE }
	The current action mode (creation of a new edge, or panning of the widget). More...
enum	RefreshStatus { ST_REFRESH_NOCHANGE, ST_REFRESH_CHANGED, ST_REFRESH_CHANGEINVALID }
	Pipeline status after refreshParameters() was called. More...
typedef QList< TOPPASEdge * >	EdgeContainer
	The container for edges.
typedef EdgeContainer::iterator	EdgeIterator
	A mutable iterator for edges.
typedef EdgeContainer::const_iterator	ConstEdgeIterator
	A const iterator for edges.
typedef QList< TOPPASVertex * >	VertexContainer
	The container for vertices.
typedef VertexContainer::iterator	VertexIterator
	A mutable iterator for vertices.
typedef VertexContainer::const_iterator	ConstVertexIterator
	A const iterator for vertices.
Public Slots
void	abortPipeline ()
	Terminates the currently running pipeline.
void	itemClicked ()
	Called when an item is clicked.
void	itemReleased ()
	Called when an item is released.
void	updateHoveringEdgePos (const QPointF &new_pos)
	Called when the position of the hovering edge changes.
void	addHoveringEdge (const QPointF &pos)
	Called when a new out edge is supposed to be created.
void	finishHoveringEdge ()
	Called when the new edge is being "released".
void	pipelineErrorSlot (const QString msg="")
	Called by vertices at which an error occurred during pipeline execution.
void	moveSelectedItems (qreal dx, qreal dy)
	Moves all selected items by dx, dy.
void	snapToGrid ()
	Makes all vertices snap to the grid.
void	setPipelineRunning (bool b=true)
void	changedParameter (const bool invalidates_running_pipeline)
	Invoked by TTV or other vectices if a parameter was edited.
void	processFinished ()
	Called by a finished QProcess to indicate that we are free to start a new one.
void	quitWithError ()
	dirty solution: when using ExecutePipeline this slot is called when the pipeline crashes. This will quit the app
Slots for printing log/error output when no GUI is available

void	logTOPPOutput (const QString &out)
	Writes the TOPP tool output to the logfile (and to stdout if no gui available).
void	logToolStarted ()
	Writes the "tool started" message to the logfile (and to stdout if no gui available).
void	logToolFinished ()
	Writes the "tool finished" message to the logfile (and to stdout if no gui available).
void	logToolFailed ()
	Writes the "tool failed" message to the logfile (and to stdout if no gui available).
void	logToolCrashed ()
	Writes the "tool crashed" message to the logfile (and to stdout if no gui available).
void	logOutputFileWritten (const String &file)
	Writes the "output file written" message to the logfile (and to stdout if no gui available).
Signals
void	entirePipelineFinished ()
	Emitted when the entire pipeline execution is finished.
void	pipelineExecutionFailed ()
	Emitted when the pipeline execution has failed.
void	saveMe ()
	Emitted when the pipeline should be saved (showing a save as file dialog and so on).
void	terminateCurrentPipeline ()
	Kills all connected TOPP processes.
void	selectionCopied (TOPPASScene *ts)
	Emitted when a selection is copied to the clipboard.
void	requestClipboardContent ()
	Requests the clipboard content from TOPPASBase, will be stored in clipboard_.
void	mainWindowNeedsUpdate ()
	Emitted when the main window needs to be updated.
void	openInTOPPView (QStringList all_files)
	Emitted when files are triggered for opening in TOPPView.
void	dryRunFinished (int, QProcess::ExitStatus)
	Emitted when in dry run mode and asked to run a TOPP tool (to fake success).
void	messageReady (const QString &msg)
	Emitted when there is an important message that needs to be printed in TOPPAS.
Public Member Functions
	TOPPASScene (QObject *parent, const QString &tmp_path, bool gui=true)
	Constructor.
virtual	~TOPPASScene ()
	Destructor.
void	addVertex (TOPPASVertex *tv)
	Adds a vertex.
void	addEdge (TOPPASEdge *te)
	Adds an edge.
void	setActionMode (ActionMode mode)
	Sets the action mode.
ActionMode	getActionMode ()
	Returns the action mode.
VertexIterator	verticesBegin ()
	Returns begin() iterator of all vertices.
VertexIterator	verticesEnd ()
	Returns end() iterator of all vertices.
EdgeIterator	edgesBegin ()
	Returns begin() iterator of all edges.
EdgeIterator	edgesEnd ()
	Returns end() iterator of all edges.
void	copySelected ()
	Copies all currently selected edges and vertices.
void	paste (QPointF pos=QPointF())
	Pastes the copied items.
void	removeSelected ()
	Removes all currently selected edges and vertices.
void	unselectAll ()
	Unselects all items.
void	updateEdgeColors ()
	Updates all edge colors (color of green and yellow edges can change when edges are added/removed).
void	resetDownstream (TOPPASVertex *vertex)
	Called when user fires "Resume" action, to clear downstream nodes from previous results.
void	runPipeline ()
	Runs the pipeline.
bool	store (const String &file)
	Stores the pipeline to `file`, returns true on success.
void	load (const String &file)
	Loads the pipeline from `file`.
void	include (TOPPASScene *new_scene, QPointF pos=QPointF())
	Includes the pipeline `scene`.
const String &	getSaveFileName ()
	Returns the file name.
void	setSaveFileName (const String &name)
	Sets the file name.
void	topoSort ()
	Performs a topological sort of all vertices.
const QString &	getOutDir ()
	Returns the name of the directory for output files.
const QString &	getTempDir ()
	Returns the name of the directory for temporary files.
void	setOutDir (const QString &dir)
	Sets the name of the directory for output files.
bool	saveIfChanged ()
	Saves the pipeline if it has been changed since the last save.
void	setChanged (bool b)
	Sets the changed flag.
bool	isPipelineRunning ()
	Returns if a pipeline is currently running.
bool	askForOutputDir (bool always_ask=true)
	Shows a dialog that allows to specify the output directory. If `always_ask` == false, the dialog won't be shown if a directory has been set, already.
void	enqueueProcess (const TOPPProcess &process)
	Enqueues the process, it will be run when the currently pending processes have finished.
void	runNextProcess ()
	Runs the next process in the queue, if any.
void	resetProcessesQueue ()
	Resets the processes queue.
void	setClipboard (TOPPASScene *clipboard)
	Sets the clipboard content.
void	connectVertexSignals (TOPPASVertex *tv)
	Connects the signals to slots.
void	connectToolVertexSignals (TOPPASToolVertex *ttv)
	Connects the signals to slots.
void	connectOutputVertexSignals (TOPPASOutputFileListVertex *oflv)
	Connects the signals to slots.
void	connectMergerVertexSignals (TOPPASMergerVertex *tmv)
	Connects the signals to slots.
void	connectEdgeSignals (TOPPASEdge *e)
	Connects the signals to slots.
void	loadResources (const TOPPASResources &resources)
	Loads the `resources` into the input nodes of this workflow.
void	createResources (TOPPASResources &resources)
	Create `resources` from the current workflow.
bool	wasChanged ()
	Returns whether the workflow has been changed since the latest "save".
RefreshStatus	refreshParameters ()
	Refreshes the parameters of the TOPP tools in this workflow.
bool	isDryRun () const
	determine dry run status (are tools actually called?)
QString	getDescription () const
	workflow description (to be displayed in TOPPAS window)
void	setDescription (const QString &desc)
	when description is updated by user, use this to update the description for later storage in file
void	setAllowedThreads (int num_threads)
	sets the maximum number of jobs
TOPPASEdge *	getHoveringEdge ()
	returns the hovering edge
void	checkIfWeAreDone ()
	Checks whether all output vertices are finished, and if yes, emits entirePipelineFinished() (called by finished output vertices).
Protected Member Functions
TOPPASVertex *	getVertexAt_ (const QPointF &pos)
	Returns the vertex in the foreground at position `pos` , if existent, otherwise 0.
bool	isEdgeAllowed_ (TOPPASVertex u, TOPPASVertex v)
	Returns whether an edge between node u and v would be allowed.
bool	dfsVisit_ (TOPPASVertex *vertex)
	DFS helper method. Returns true, if a back edge has been discovered.
bool	sanityCheck_ (bool allowUserOverride)
void	writeToLogFile_ (const QString &text)
	Writes the `text` to the logfile.
reimplemented Qt events

void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)
Protected Attributes
ActionMode	action_mode_
	The current action mode.
VertexContainer	vertices_
	The list of all vertices.
EdgeContainer	edges_
	The list of all edges.
TOPPASEdge *	hover_edge_
	The hovering edge which is currently being created.
TOPPASVertex *	potential_target_
	The current potential target vertex of the hovering edge.
String	file_name_
	The file name of this pipeline.
QString	tmp_path_
	The path for temporary files.
bool	gui_
	Are we in a GUI or is the scene used by ExecutePipeline (at the command line)?
QString	out_dir_
	The directory where the output files will be written.
bool	changed_
	Flag that indicates if the pipeline has been changed since the last save.
bool	running_
	Indicates if a pipeline is currently running.
bool	error_occured_
	true if an error occurred during pipeline execution
bool	user_specified_out_dir_
	Indicates if the output directory has been specified by the user already.
QList< TOPPProcess >	topp_processes_queue_
	The queue of pending TOPP processes.
TOPPASScene *	clipboard_
	Stores the clipboard content when requested from TOPPASBase.
bool	dry_run_
	dry run mode (no tools are actually called)
int	threads_active_
	currently running processes...
QString	description_text_
	description text
int	allowed_threads_
	maximum number of allowed threads
TOPPASToolVertex *	resume_source_
	last node where 'resume' was started

Detailed Description

A container for all visual items of a TOPPAS workflow.

TOPPASScene is a subclass of QGraphicsScene and acts as a container for all visual items (i.e. all vertices and edges). It is visualized by a TOPPASWidget (a subclass of QGraphicsView). This class also provides large parts of the functionality of TOPPAS, e.g., the methods for loading, saving, running, and aborting pipelines are located here.

TOPPASScene can also be used without a visualizing TOPPASWidget (i.e., without a gui) which can be indicated via the constructor. In this case, the signals for log message output are connected to standard out. This is utilized for the ExecutePipeline tool.

Temporary files of the pipeline are stored in the member tmp_path_. Update it when loading a pipeline which has tmp data from an old run. TOPPASToolVertex will ask its parent scene() whenever it wants to know the tmp directory.

Member Typedef Documentation

typedef EdgeContainer::const_iterator ConstEdgeIterator

A const iterator for edges.

typedef VertexContainer::const_iterator ConstVertexIterator

A const iterator for vertices.

typedef QList<TOPPASEdge *> EdgeContainer

The container for edges.

typedef EdgeContainer::iterator EdgeIterator

A mutable iterator for edges.

typedef QList<TOPPASVertex *> VertexContainer

The container for vertices.

typedef VertexContainer::iterator VertexIterator

A mutable iterator for vertices.

Member Enumeration Documentation

enum ActionMode

The current action mode (creation of a new edge, or panning of the widget).

Enumerator:

AM_NEW_EDGE
AM_MOVE

enum RefreshStatus

Pipeline status after refreshParameters() was called.

Enumerator:

ST_REFRESH_NOCHANGE
ST_REFRESH_CHANGED
ST_REFRESH_CHANGEINVALID

Constructor & Destructor Documentation

TOPPASScene	(	QObject *	parent,
		const QString &	tmp_path,
		bool	gui = `true`
	)

Constructor.

virtual ~TOPPASScene ( ) [virtual]

Destructor.

Member Function Documentation

void abortPipeline ( ) [slot]

Terminates the currently running pipeline.

Referenced by TOPPASBase::abortPipeline().

void addEdge ( TOPPASEdge * te )

Adds an edge.

void addHoveringEdge ( const QPointF & pos ) [slot]

Called when a new out edge is supposed to be created.

void addVertex ( TOPPASVertex * tv )

Adds a vertex.

Referenced by TOPPASBase::insertNewVertex_().

bool askForOutputDir ( bool always_ask = true )

Shows a dialog that allows to specify the output directory. If always_ask == false, the dialog won't be shown if a directory has been set, already.

void changedParameter ( const bool invalidates_running_pipeline ) [slot]

Invoked by TTV or other vectices if a parameter was edited.

void checkIfWeAreDone ( )

Checks whether all output vertices are finished, and if yes, emits entirePipelineFinished() (called by finished output vertices).

void connectEdgeSignals ( TOPPASEdge * e )