View an image list in an image file list widget. More...

#include <ImageFileListViewWorkOrder.h>

Inheritance diagram for Isis::ImageFileListViewWorkOrder:

Collaboration diagram for Isis::ImageFileListViewWorkOrder:

Public Types
enum	WorkOrderStatus { WorkOrderUnknownStatus = 0, WorkOrderNotStarted, WorkOrderRedoing, WorkOrderRedone, WorkOrderUndoing, WorkOrderUndone, WorkOrderFinished, WorkOrderLastStatus = WorkOrderFinished }

enum	Context { NoContext, ProjectContext }

Public Slots
virtual void	redo ()
	Starts (or enqueues) a redo.

virtual void	undo ()
	Starts (or enqueues) an undo.

Signals
void	creatingProgress (WorkOrder *)

void	deletingProgress (WorkOrder *)

void	finished (WorkOrder *)

void	statusChanged (WorkOrder *)

Public Member Functions
	ImageFileListViewWorkOrder (Project *project)

	ImageFileListViewWorkOrder (const ImageFileListViewWorkOrder &other)

virtual ImageFileListViewWorkOrder *	clone () const

bool	isExecutable (ImageList *images)
	Re-implement this method if your work order utilizes images for data in order to operate.

bool	execute ()
	The (child) implementation of this method should prompt the user/gather state by any means necessary.

virtual bool	isExecutable (Context)
	Re-implement this method if your work order utilizes controls for data in order to operate.

virtual bool	isExecutable (QList< Control * > controls)
	Re-implement this method if your work order utilizes controls for data in order to operate.

void	read (XmlStackedHandlerReader *xmlReader)
	Read this work order's data from disk.

void	save (QXmlStreamWriter &stream) const
	Output XML format:

virtual void	setData (Context)

virtual void	setData (ImageList *images)

virtual void	setData (QList< Control * > controls)

void	setNext (WorkOrder *nextWorkOrder)

void	setPrevious (WorkOrder *previousWorkOrder)

QString	bestText () const

bool	createsCleanState () const

QDateTime	executionTime () const

bool	isFinished () const

bool	isRedoing () const

bool	isRedone () const

bool	isUndoing () const

bool	isUndone () const

bool	modifiesDiskState () const

WorkOrder *	next () const

WorkOrder *	previous () const

QString	statusText () const

ProgressBar *	progressBar ()

Static Public Member Functions
static WorkOrderStatus	fromStatusString (QString)

static QString	toString (WorkOrderStatus)

Protected Slots
void	addCloneToProject ()

Protected Member Functions
void	syncRedo ()
	This method is designed to be implemented by children work orders.

void	syncUndo ()
	This method is designed to be implemented by children work orders.

ImageList *	imageList ()

const ImageList *	imageList () const

QList< Control * >	controlList ()

virtual bool	dependsOn (WorkOrder *other) const

Directory *	directory () const

Project *	project () const

void	setCreatesCleanState (bool createsCleanState)
	Declare that this work order is saving the project.

void	setModifiesDiskState (bool changesProjectOnDisk)

void	setInternalData (QStringList data)

int	progressMin () const

int	progressMax () const

int	progressValue () const

void	setProgressRange (int, int)

void	setProgressValue (int)

QStringList	internalData () const

virtual void	asyncRedo ()
	This method is designed to be implemented by children work orders.

virtual void	postSyncRedo ()
	This method is designed to be implemented by children work orders.

virtual void	asyncUndo ()
	This method is designed to be implemented by children work orders.

virtual void	postSyncUndo ()
	This method is designed to be implemented by children work orders.

Private Member Functions
ImageFileListViewWorkOrder &	operator= (const ImageFileListViewWorkOrder &rhs)

Detailed Description

View an image list in an image file list widget.

Author: 2012-??-?? ???

Definition at line 41 of file ImageFileListViewWorkOrder.h.

Member Enumeration Documentation

enum Isis::WorkOrder::WorkOrderStatus

inherited

Enumerator
WorkOrderFinished	This is used for work orders that will not undo or redo (See createsCleanState())

Definition at line 91 of file WorkOrder.h.

Member Function Documentation

void Isis::WorkOrder::asyncRedo ( )

protectedvirtualinherited

This method is designed to be implemented by children work orders.

The order of execution for redo is: syncRedo() - GUI thread asyncRedo() - Pooled thread* postSyncRedo() - GUI thread

State can be read from the parent WorkOrder class and from state set in syncRedo() while in this method. You can set state to be used in postSyncRedo() safely. Please be wary of creating QObjects inside of this method because they will associated with the pooled thread and must be moved back to the GUI thread with QObject::moveToThread(). This method is never executed in the GUI thread. You can update progress by calling setProgressRange() and setProgressValue(). Please do not manipulate any GUI objects here.

Reimplemented in Isis::ImportImagesWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ExportImagesWorkOrder, and Isis::ExportControlNetWorkOrder.

Definition at line 745 of file WorkOrder.cpp.

Referenced by Isis::WorkOrder::redo().

void Isis::WorkOrder::asyncUndo ( )

protectedvirtualinherited

This method is designed to be implemented by children work orders.

The order of execution for undo is: syncUndo() - GUI thread asyncUndo() - Pooled thread* postSyncUndo() - GUI thread

State can be read from the parent WorkOrder class and from state set in syncUndo() while in this method. You can set state to be used in postSyncUndo() safely. Please be wary of deleting QObjects inside of this method because they will cause unpredictable crashes. This method is never executed in the GUI thread. You can update progress by calling setProgressRange() and setProgressValue(). Please do not manipulate any GUI objects here.

Reimplemented in Isis::ImportImagesWorkOrder.

Definition at line 792 of file WorkOrder.cpp.

Referenced by Isis::WorkOrder::undo().

bool Isis::ImageFileListViewWorkOrder::execute ( )

virtual

The (child) implementation of this method should prompt the user/gather state by any means necessary.

This method is designed to be implemented by children work orders, but they need to call this version inside of their execute (at the beginning).

Prompts for file names, questions, warnings, etc.. should be done here.

Once the work order has enough data to execute, this method needs to set the state in the parent (this) WorkOrder class. Call setData(ImageList), setInternalData(QStringList), etc... with all of the data/state necessary to perform the work order. This could be a list of file names, an ImageList of images you're viewing, or really anything else.

Finally, the actual work needs done in *Redo(), using only state (data) stored by the parent (this) WorkOrder class. You do not have to call *Redo() - this is done for you by WorkOrder::redo(). WorkOrder::redo() is called from Project::addToProject() when the workOrder is pushed onto the undo stack.

We do it this way to ensure saving/restoring from history can be done automatically/simply and implemented only once per data type. This also gives us full undo/redo functionality.

Returns: False if this operation should be cancelled (the user clicked cancel, the operation turns out to be impossible, etc). This prevents the work order from making it into the history and redo will never be called.

The order of execution for work orders is: execute() - GUI thread, can ask user for input* syncRedo() - GUI thread, should not prompt the user for input asyncRedo() - Pooled thread postSyncRedo() - GUI thread

syncUndo() - GUI thread, always called after redo finishes asyncUndo() - Pooled thread postSyncUndo() - GUI thread

syncRedo() - GUI thread asyncRedo() - Pooled thread postSyncRedo() - GUI thread

and so on...

State should only be set in the parent WorkOrder class in this method. You can set arbitrary state using setInternalData(). This method is always executed in the GUI thread and is the only place to ask the user questions.

Reimplemented from Isis::WorkOrder.

Definition at line 59 of file ImageFileListViewWorkOrder.cpp.

References Isis::WorkOrder::execute(), and Isis::ImageList::name().

bool Isis::ImageFileListViewWorkOrder::isExecutable ( ImageList * images )

virtual

Re-implement this method if your work order utilizes images for data in order to operate.

For example, "Footprint2DViewWorkOrder" works sometimes on images - the logic in side of Footprint2DViewWorkOrder::isExecutable(ImageList) determines whethere or not a user is prompted with this work order as a possibility.

Parameters

images An image list that this work order should execute on

Reimplemented from Isis::WorkOrder.

Definition at line 54 of file ImageFileListViewWorkOrder.cpp.

bool Isis::WorkOrder::isExecutable ( Context context )

virtualinherited

Re-implement this method if your work order utilizes controls for data in order to operate.

For example, "CnetEditorViewWorkOrder" works sometimes on controls - the logic in side of CnetEditorViewWorkOrder::isExecutable() determines whethere or not a user is prompted with this work order as a possibility.

Reimplemented in Isis::RenameProjectWorkOrder.

Definition at line 153 of file WorkOrder.cpp.

bool Isis::WorkOrder::isExecutable ( QList< Control * > controls )

virtualinherited

Re-implement this method if your work order utilizes controls for data in order to operate.

For example, "CnetEditorViewWorkOrder" works sometimes on controls - the logic in side of CnetEditorViewWorkOrder::isExecutable() determines whethere or not a user is prompted with this work order as a possibility.

Reimplemented in Isis::CnetEditorViewWorkOrder, and Isis::ExportControlNetWorkOrder.

Definition at line 165 of file WorkOrder.cpp.

void Isis::WorkOrder::postSyncRedo ( )

protectedvirtualinherited

This method is designed to be implemented by children work orders.

The order of execution for redo is: syncRedo() - GUI thread asyncRedo() - Pooled thread postSyncRedo() - GUI thread*

State can be read from the parent WorkOrder class and from state set in either syncRedo() or asyncRedo() while in this method. You can not set state to be used in any of the undo code safely. This method is always executed in the GUI thread and has no progress.

Reimplemented in Isis::ImportImagesWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ExportImagesWorkOrder, and Isis::ExportControlNetWorkOrder.

Definition at line 760 of file WorkOrder.cpp.

void Isis::WorkOrder::postSyncUndo ( )

protectedvirtualinherited

This method is designed to be implemented by children work orders.

The order of execution for undo is: syncUndo() - GUI thread asyncUndo() - Pooled thread postSyncUndo() - GUI thread*

State can be read from the parent WorkOrder class and from state set in either syncUndo() or asyncUndo() while in this method. You can not set state to be used in any of the redo code safely. This method is always executed in the GUI thread and has no progress.

Reimplemented in Isis::ImportImagesWorkOrder.

Definition at line 807 of file WorkOrder.cpp.

void Isis::WorkOrder::read ( XmlStackedHandlerReader * xmlReader )

inherited

Read this work order's data from disk.

Definition at line 186 of file WorkOrder.cpp.

void Isis::WorkOrder::redo ( )

virtualslotinherited

Starts (or enqueues) a redo.

This should not be re-implemented by children.

Definition at line 475 of file WorkOrder.cpp.

References Isis::WorkOrder::asyncRedo(), and Isis::WorkOrder::syncRedo().

void Isis::WorkOrder::save ( QXmlStreamWriter & stream ) const

inherited

Output XML format:

  <workOrder actiontext="..." undotext="..." type="..." status="...">
    <images>
      <image id="...">
    </images>

    <internalDataValues>
      <dataValue value="...">
    </internalDataValues>
  </workOrder>

Definition at line 206 of file WorkOrder.cpp.

References _FILEINFO_, Isis::WorkOrder::m_executionTime, and Isis::IException::Unknown.

Referenced by Isis::Project::saveHistory().

void Isis::WorkOrder::setCreatesCleanState ( bool createsCleanState )

protectedinherited

Declare that this work order is saving the project.

This makes the work order not appear in the undo stack (cannot undo/redo), and instead is marked as a 'clean' state of the project. The QUndoCommand undo/redo will never be called. The default for createsCleanState is false.

Parameters

createsCleanState True if this work order is going to save the project to disk

Definition at line 971 of file WorkOrder.cpp.

References Isis::WorkOrder::m_createsCleanState.

void Isis::ImageFileListViewWorkOrder::syncRedo ( )

protectedvirtual

This method is designed to be implemented by children work orders.

The order of execution for redo is: syncRedo() - GUI thread* asyncRedo() - Pooled thread postSyncRedo() - GUI thread

State should only be read from the parent WorkOrder class in this method. You can set state to be used in asyncRedo() and postSyncRedo() safely. This method is always executed in the GUI thread and has no progress.

Reimplemented from Isis::WorkOrder.

Definition at line 117 of file ImageFileListViewWorkOrder.cpp.

void Isis::ImageFileListViewWorkOrder::syncUndo ( )

protectedvirtual

This method is designed to be implemented by children work orders.

The order of execution for undo is: syncUndo() - GUI thread* asyncUndo() - Pooled thread postSyncUndo() - GUI thread

State should only be read from the parent WorkOrder class in this method. You can set state to be used in asyncUndo() and postSyncUndo() safely. This method is always executed in the GUI thread and has no progress.

Reimplemented from Isis::WorkOrder.

Definition at line 132 of file ImageFileListViewWorkOrder.cpp.

void Isis::WorkOrder::undo ( )

virtualslotinherited

Starts (or enqueues) an undo.

This should not be re-implemented by children.

Definition at line 559 of file WorkOrder.cpp.

References Isis::WorkOrder::asyncUndo(), and Isis::WorkOrder::syncUndo().

The documentation for this class was generated from the following files:

src/qisis/objs/Directory/ImageFileListViewWorkOrder.h
src/qisis/objs/Directory/ImageFileListViewWorkOrder.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Private Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation