Write project images to a user-specified location. More...

#include <ExportImagesWorkOrder.h>

Inheritance diagram for Isis::ExportImagesWorkOrder:

Collaboration diagram for Isis::ExportImagesWorkOrder:

Classes
class	ProjectImageExportFunctor
	This functor is meant for QtConcurrentMap. More...

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
	ExportImagesWorkOrder (Project *project)

	ExportImagesWorkOrder (const ExportImagesWorkOrder &other)

virtual ExportImagesWorkOrder *	clone () const

bool	isExecutable (ImageList *images)
	Currently, this work order only works with either no data (file menu) or with any number of images.

bool	execute ()
	Prompts the user for input.

void	asyncRedo ()
	Use internalData() and write the images into the output directory.

void	postSyncRedo ()
	Display any warnings that occurred during the asynchronous computations.

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

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

Private Attributes
QString	m_warning

Detailed Description

Write project images to a user-specified location.

Takes an imageList and writes it's images to disk at a user-specified location. This works both with and without context (context menus and file menu).

internalData() stores: ImageList name [OPTIONAL] - need context if this isn't present (see WorkOrder::imageList()) Output directory name [REQUIRED]

Author: 2012-09-26 Tracie Sucharski

Definition at line 29 of file ExportImagesWorkOrder.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::ExportImagesWorkOrder::asyncRedo ( )

virtual

Use internalData() and write the images into the output directory.

Stores errors in m_warning which will be reported in postSyncRedo().

Reimplemented from Isis::WorkOrder.

Definition at line 126 of file ExportImagesWorkOrder.cpp.

References Isis::ExportImagesWorkOrder::ProjectImageExportFunctor::errors(), and Isis::IException::toString().

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::ExportImagesWorkOrder::execute ( )

virtual

Prompts the user for input.

If there is no context, we ask the user to select an image list. Once we have images (via context or asking the user), we then ask for a output directory. The relevant data is stored in internalData().

Returns: bool

Reimplemented from Isis::WorkOrder.

Definition at line 83 of file ExportImagesWorkOrder.cpp.

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

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

virtual

Currently, this work order only works with either no data (file menu) or with any number of images.

Parameters

controls The current context we're inquiring about

Returns: bool True if this work order functions with the given image list

Reimplemented from Isis::WorkOrder.

Definition at line 71 of file ExportImagesWorkOrder.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::ExportImagesWorkOrder::postSyncRedo ( )

virtual

Display any warnings that occurred during the asynchronous computations.

Reimplemented from Isis::WorkOrder.

Definition at line 159 of file ExportImagesWorkOrder.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::WorkOrder::syncRedo ( )

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

Definition at line 727 of file WorkOrder.cpp.

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

void Isis::WorkOrder::syncUndo ( )

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

Definition at line 775 of file WorkOrder.cpp.

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

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/ExportImagesWorkOrder.h
src/qisis/objs/Directory/ExportImagesWorkOrder.cpp

Classes

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation