Parent class for anything that performs an action in Project. More...

#include <WorkOrder.h>

Inherited by Isis::CnetEditorViewWorkOrder, Isis::CubeViewportViewWorkOrder, Isis::ExportControlNetWorkOrder, Isis::ExportImagesWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::ImageListActionWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ImportImagesWorkOrder, Isis::MosaicSceneWorkOrder, Isis::OpenProjectWorkOrder, Isis::RenameProjectWorkOrder, Isis::SaveProjectAsWorkOrder, and Isis::SaveProjectWorkOrder.

Classes
class	XmlHandler

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

Public Slots
virtual bool	execute ()
	The (child) implementation of this method should prompt the user/gather state by any means necessary.
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
	WorkOrder (Project *project)
	Create a work order that will work with the given project.
virtual	~WorkOrder ()
virtual WorkOrder *	clone () const =0
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.
virtual bool	isExecutable (ImageList *images)
	Re-implement this method if your work order utilizes images 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
	WorkOrder (const WorkOrder &other)
	Copy the work order 'other' into this (new) instance.
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	syncRedo ()
	This method is designed to be implemented by children work orders.
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	syncUndo ()
	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.

Detailed Description

Parent class for anything that performs an action in Project.

This class should be used for any operation that affects a Project. This provides history, undo/redo capabilities (which need implemented correctly), and the ability for the project to guarantee a good state on disk.

State between the end of execute() and the beginning of the redo methods must be saved via the parent (WorkOrder) class. This is to ensure serializability. State between the redo methods and undo methods should work the same way. Child implementations may only save state (have member variables) that store state between syncRedo(), asyncRedo() and postSyncRedo() OR between syncUndo(), asyncUndo() and postSyncUndo(). Other forms of state will cause the work order to not function properly when saved/restored from disk.

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

Member Enumeration Documentation

enum Isis::WorkOrder::Context

Enumerator:

NoContext
ProjectContext

enum Isis::WorkOrder::WorkOrderStatus

Enumerator:

WorkOrderUnknownStatus
WorkOrderNotStarted
WorkOrderRedoing
WorkOrderRedone
WorkOrderUndoing
WorkOrderUndone
WorkOrderFinished	This is used for work orders that will not undo or redo (See createsCleanState())
WorkOrderLastStatus

Constructor & Destructor Documentation

Isis::WorkOrder::WorkOrder ( Project * project )

Create a work order that will work with the given project.

Parameters

project	The Project that this work order should be interacting with
parent	The Qt-relationship parent

References _FILEINFO_, addCloneToProject(), finished(), NoContext, Isis::IException::Programmer, project(), and WorkOrderNotStarted.

Isis::WorkOrder::~WorkOrder ( )

virtual

Isis::WorkOrder::WorkOrder ( const WorkOrder & other )

protected

Copy the work order 'other' into this (new) instance.

Parameters

other The work order being copied

References _FILEINFO_, addCloneToProject(), finished(), project(), and Isis::IException::Unknown.

Member Function Documentation

void Isis::WorkOrder::addCloneToProject ( )

protectedslot

References Isis::Project::addToProject(), clone(), and project().

Referenced by WorkOrder().

void Isis::WorkOrder::asyncRedo ( )

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 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.

Referenced by redo().

void Isis::WorkOrder::asyncUndo ( )

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 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.

Referenced by undo().

QString Isis::WorkOrder::bestText ( ) const

Referenced by redo(), save(), and undo().

QList< Control * > Isis::WorkOrder::controlList ( )

protected

Referenced by Isis::ExportControlNetWorkOrder::asyncRedo(), Isis::ExportControlNetWorkOrder::execute(), Isis::CnetEditorViewWorkOrder::execute(), and Isis::CnetEditorViewWorkOrder::syncRedo().

bool Isis::WorkOrder::createsCleanState ( ) const

Referenced by Isis::Project::addToProject(), execute(), and setCreatesCleanState().

void Isis::WorkOrder::creatingProgress ( WorkOrder * _t1 )

signal

void Isis::WorkOrder::deletingProgress ( WorkOrder * _t1 )

signal

bool Isis::WorkOrder::dependsOn ( WorkOrder * other ) const

protectedvirtual

Reimplemented in Isis::RenameProjectWorkOrder, Isis::CubeViewportViewWorkOrder, Isis::Footprint2DViewWorkOrder, and Isis::CnetEditorViewWorkOrder.

Referenced by redo().

Directory * Isis::WorkOrder::directory ( ) const

protected

References Isis::Project::directory(), and project().

Referenced by Isis::MosaicSceneWorkOrder::scene(), Isis::Footprint2DViewWorkOrder::syncRedo(), Isis::CubeViewportViewWorkOrder::syncRedo(), Isis::ImageFileListViewWorkOrder::syncRedo(), and Isis::ImageFileListViewWorkOrder::syncUndo().

bool Isis::WorkOrder::execute ( )

virtualslot

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 in Isis::ImageListActionWorkOrder, Isis::ImportImagesWorkOrder, Isis::ImportControlNetWorkOrder, Isis::SaveProjectAsWorkOrder, Isis::SaveProjectWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::RenameProjectWorkOrder, Isis::OpenProjectWorkOrder, Isis::CubeViewportViewWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::ExportImagesWorkOrder, and Isis::ExportControlNetWorkOrder.

References createsCleanState(), statusChanged(), and WorkOrderFinished.

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

QDateTime Isis::WorkOrder::executionTime ( ) const

void Isis::WorkOrder::finished ( WorkOrder * _t1 )

signal

Referenced by redo(), undo(), and WorkOrder().

WorkOrder::WorkOrderStatus Isis::WorkOrder::fromStatusString ( QString statusString )

static

References toString(), WorkOrderLastStatus, and WorkOrderUnknownStatus.

ImageList * Isis::WorkOrder::imageList ( )

protected

References Isis::Project::image(), and project().

const ImageList * Isis::WorkOrder::imageList ( ) const

protected

References imageList().

QStringList Isis::WorkOrder::internalData ( ) const

protected

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

virtual

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.

Referenced by Isis::Directory::supportedActions().

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

virtual

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.

bool Isis::WorkOrder::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 in Isis::ImageListActionWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::CubeViewportViewWorkOrder, Isis::Footprint2DViewWorkOrder, and Isis::ExportImagesWorkOrder.

bool Isis::WorkOrder::isFinished ( ) const

References WorkOrderFinished.

Referenced by redo(), and undo().

bool Isis::WorkOrder::isRedoing ( ) const

References WorkOrderRedoing.

Referenced by redo(), and undo().

bool Isis::WorkOrder::isRedone ( ) const

References WorkOrderRedone.

Referenced by redo().

bool Isis::WorkOrder::isUndoing ( ) const

References WorkOrderUndoing.

Referenced by Isis::Project::lastNotUndoneWorkOrder(), redo(), and undo().

bool Isis::WorkOrder::isUndone ( ) const

References WorkOrderUndone.

Referenced by Isis::Project::lastNotUndoneWorkOrder(), and undo().

bool Isis::WorkOrder::modifiesDiskState ( ) const

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

WorkOrder * Isis::WorkOrder::next ( ) const

Referenced by undo().

void Isis::WorkOrder::postSyncRedo ( )

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 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.

void Isis::WorkOrder::postSyncUndo ( )

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 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.

WorkOrder * Isis::WorkOrder::previous ( ) const

Referenced by Isis::Project::addToProject(), Isis::Project::lastNotUndoneWorkOrder(), and redo().

ProgressBar * Isis::WorkOrder::progressBar ( )

Referenced by Isis::OpenProjectWorkOrder::execute().

int Isis::WorkOrder::progressMax ( ) const

protected

int Isis::WorkOrder::progressMin ( ) const

protected

int Isis::WorkOrder::progressValue ( ) const

protected

Project * Isis::WorkOrder::project ( ) const

protected

References _FILEINFO_, and Isis::IException::Programmer.

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

Read this work order's data from disk.

References Isis::XmlStackedHandlerReader::pushContentHandler().

void Isis::WorkOrder::redo ( )

virtualslot

Starts (or enqueues) a redo.

This should not be re-implemented by children.

References asyncRedo(), bestText(), dependsOn(), finished(), imageList(), isFinished(), isRedoing(), isRedone(), isUndoing(), previous(), project(), statusChanged(), syncRedo(), and WorkOrderRedoing.

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

Output XML format:

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

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

References _FILEINFO_, bestText(), NoContext, toString(), and Isis::IException::Unknown.

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

protected

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

References createsCleanState().

Referenced by Isis::OpenProjectWorkOrder::OpenProjectWorkOrder(), Isis::SaveProjectAsWorkOrder::SaveProjectAsWorkOrder(), and Isis::SaveProjectWorkOrder::SaveProjectWorkOrder().

void Isis::WorkOrder::setData ( Context context )

virtual

Referenced by Isis::Footprint2DViewWorkOrder::execute(), Isis::Directory::supportedActions(), and Isis::MosaicSceneWidget::supportedActions().

void Isis::WorkOrder::setData ( ImageList * images )

virtual

Reimplemented in Isis::ImageListActionWorkOrder.

void Isis::WorkOrder::setData ( QList< Control * > controls )

virtual

void Isis::WorkOrder::setInternalData ( QStringList data )

protected

void Isis::WorkOrder::setModifiesDiskState ( bool changesProjectOnDisk )

protected

Referenced by Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), and Isis::ImportImagesWorkOrder::ImportImagesWorkOrder().

void Isis::WorkOrder::setNext ( WorkOrder * nextWorkOrder )

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

void Isis::WorkOrder::setPrevious ( WorkOrder * previousWorkOrder )

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

void Isis::WorkOrder::setProgressRange	(	int	minValue,
		int	maxValue
	)

protected

Referenced by Isis::ExportImagesWorkOrder::asyncRedo(), and Isis::ImportControlNetWorkOrder::asyncRedo().

void Isis::WorkOrder::setProgressValue ( int value )

protected

Referenced by Isis::ExportImagesWorkOrder::asyncRedo(), and Isis::ImportControlNetWorkOrder::asyncRedo().

void Isis::WorkOrder::statusChanged ( WorkOrder * _t1 )

signal

Referenced by execute(), redo(), and undo().

QString Isis::WorkOrder::statusText ( ) const

References toString().

void Isis::WorkOrder::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 in Isis::ImageListActionWorkOrder, Isis::ImportControlNetWorkOrder, Isis::RenameProjectWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::CubeViewportViewWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::MoveDownOneSceneWorkOrder, Isis::MoveToBottomSceneWorkOrder, Isis::MoveToTopSceneWorkOrder, and Isis::MoveUpOneSceneWorkOrder.

Referenced by redo().

void Isis::WorkOrder::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 in Isis::ImageListActionWorkOrder, Isis::ImportControlNetWorkOrder, Isis::RenameProjectWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::CubeViewportViewWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::MoveDownOneSceneWorkOrder, Isis::MoveToBottomSceneWorkOrder, Isis::MoveToTopSceneWorkOrder, and Isis::MoveUpOneSceneWorkOrder.