Provide Undo/redo abilities, serialization, and history for an operation. More...

#include <WorkOrder.h>

Inheritance diagram for Isis::WorkOrder:

Collaboration diagram for Isis::WorkOrder:

Public Types
enum	WorkOrderStatus { WorkOrderUnknownStatus = 0, WorkOrderNotStarted, WorkOrderRedoing, WorkOrderRedone, WorkOrderUndoing, WorkOrderUndone, WorkOrderFinished, WorkOrderLastStatus = WorkOrderFinished }
	This enumeration is used by other functions to set and retrieve the current state of the WorkOrder. More...

enum	Context { NoContext, ProjectContext }
	This enumeration is for recording the context of the current Workorder (whether it is part of a project or not). More...

Public Slots
void	enableWorkOrder ()
	Enables the work order. More...

void	disableWorkOrder ()
	Disables the work order. More...

virtual bool	setupExecution ()
	This sets up the state for the work order. More...

virtual void	execute ()
	Execute the workorder. More...

virtual void	redo ()
	Starts (or enqueues) a redo. More...

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

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

virtual	~WorkOrder ()
	The Destructor. More...

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

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

virtual bool	isExecutable (ShapeList *shapes)
	Re-implement this method if your work order utilizes shapes for data in order to operate. More...

virtual bool	isExecutable (ControlList *controls)
	Re-implement this method if your work order utilizes a control for data in order to operate. More...

virtual bool	isExecutable (CorrelationMatrix)

virtual bool	isExecutable (TargetBodyQsp targetBody)
	Re-implement this method if your work order utilizes a control list (a list of control networks) for data in order to operate. More...

virtual bool	isExecutable (Template *currentTemplate)
	Re-implement this method if your work order utilizes a control list (a list of control networks) for data in order to operate. More...

virtual bool	isExecutable (GuiCameraQsp guiCamera)
	Re-implement this method if your WorkOrder utilizes GuiCameraQsp (a QSharedPointer to a GuiCamera object) for data in order to operate. More...

virtual bool	isExecutable (FileItemQsp fileItem)
	Re-implement this method if your WorkOrder utilizes FileItemQsp (a QSharedPointer to a FileItem object) for data in order to operate. More...

virtual bool	isExecutable (ProjectItem *item)
	Determines if the WorkOrder is execuatable on the data stored in a ProjectItem. More...

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

void	save (QXmlStreamWriter &stream) const
	: Saves a WorkOrder to a data stream. More...

virtual void	setData (Context)
	Sets the context data for this WorkOrder. More...

virtual void	setData (QString data)

virtual void	setData (ImageList *images)
	Sets the ImageList data for this WorkOrder. More...

virtual void	setData (ShapeList *shapes)
	Sets the ShapeList data for this WorkOrder. More...

virtual void	setData (ControlList *controls)
	Sets the Control data for this WorkOrder. More...

virtual void	setData (Template *currentTemplate)
	Sets the TargetBody data for this WorkOrder. More...

virtual void	setData (CorrelationMatrix)
	Sets the CorrelationMatrix data for this WorkOrder. More...

virtual void	setData (TargetBodyQsp targetBody)
	Sets the TargetBody data for this WorkOrder. More...

virtual void	setData (GuiCameraQsp guiCamera)
	Sets the GuiCamera data for this WorkOrder. More...

virtual void	setData (FileItemQsp fileItem)
	Sets the FileItem data for this WorkOrder. More...

virtual void	setData (ProjectItem *item)
	Sets the internal data to the data stored in a ProjectItem. More...

void	setNext (WorkOrder *nextWorkOrder)
	Sets the next WorkOrder in the sequence. More...

void	setPrevious (WorkOrder *previousWorkOrder)
	Sets the previous WorkOrder in the sequence. More...

QString	bestText () const
	Generate unique action names We don't use action text anymore because Directory likes to rename our actions. More...

bool	isUndoable () const
	Returns true if this work order is undoable, otherwise false. More...

bool	isSavedToHistory () const
	Returns true if this work order is to be shown in History, otherwise false. More...

bool	isSynchronous () const
	Returns true if this work order is run synchronously, otherwise false. More...

bool	createsCleanState () const
	Returns the CleanState status (whether the Project has been saved to disk or not). More...

QDateTime	executionTime () const
	Gets the execution time of this WorkOrder. More...

bool	isFinished () const
	Returns the finished state of this WorkOrder. More...

bool	isRedoing () const
	Returns the redoing status of this WorkOrder. More...

bool	isRedone () const
	Returns the WorkOrder redone status. More...

bool	isUndoing () const
	Returns the WorkOrderUndoing state. More...

bool	isUndone () const
	Returns the WorkOrder undo status. More...

bool	modifiesDiskState () const
	Returns the modified disk state. More...

WorkOrder *	next () const
	Gets the next WorkOrder. More...

WorkOrder *	previous () const
	Gets the previous WorkOrder. More...

QString	statusText () const
	WorkOrder::statusText. More...

ProgressBar *	progressBar ()
	Returns the ProgressBar. More...

Static Public Member Functions
static WorkOrderStatus	fromStatusString (QString)
	Attempts to query the current status of the WorkOrder. More...

static QString	toString (WorkOrderStatus)
	Gets the current status of the WorkOrder. More...

Protected Slots
void	addCloneToProject ()
	Runs a copy of the current WorkOrder and stores it in the project. More...

Protected Member Functions
	WorkOrder (const WorkOrder &other)
	Copy the work order 'other' into this (new) instance. More...

ImageList *	imageList ()
	Returns a pointer to the ImageList for this WorkOrder. More...

const ImageList *	imageList () const
	A thread-safe method for retrieving a pointer to the imageList. More...

ShapeList *	shapeList ()
	a pointer to the ShapeList for this WorkOrder. More...

const ShapeList *	shapeList () const
	A thread-safe method for retrieving a pointer to the shapeList. More...

CorrelationMatrix	correlationMatrix ()
	Returns the CorrleationMatrix for this WorkOrder. More...

QPointer< ControlList >	controlList ()
	Returns the Control List for this WorkOrder (a list of control networks). More...

Template *	getTemplate ()
	WorkOrder::getTemplate. More...

TargetBodyQsp	targetBody ()
	WorkOrder::targetBody. More...

GuiCameraQsp	guiCamera ()
	WorkOrder::guiCamera. More...

FileItemQsp	fileItem ()
	WorkOrder::fileItem. More...

virtual bool	dependsOn (WorkOrder *other) const
	Indicate workorder dependency This is a virtual function whose role in child classes is to determine if this WorkOrder depends on the WorkOrder passed in as an argument. More...

Directory *	directory () const
	return the workorder project directory Returns the Directory object of the Project this WorkOrder is attached to. More...

Project *	project () const
	Returns the Project this WorkOrder is attached to. More...

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

void	setModifiesDiskState (bool changesProjectOnDisk)

void	setInternalData (QStringList data)
	Sets the internal data for this WorkOrder. More...

int	progressMin () const
	Gets the minimum value of the progress range of the WorkOrder. More...

int	progressMax () const
	Gets the maximum value of the progress range of the WorkOrder. More...

int	progressValue () const
	Gets the current progress value of the WorkOrder. More...

void	setProgressRange (int, int)
	Sets the progress range of the WorkOrder. More...

void	setProgressValue (int)
	Sets the current progress value for the WorkOrder. More...

QStringList	internalData () const
	Gets the internal data for this WorkOrder. More...

virtual void	postExecution ()
	Perform any necessary actions after execution of a workorder. More...

virtual void	undoExecution ()
	Execute the steps necessary to undo this workorder. More...

virtual void	postUndoExecution ()
	Perform any steps necessary after an undo of a workorder. More...

Protected Attributes
bool	m_isUndoable
	Set the workorder to be undoable/redoable This is defaulted to true - his will allow the workorder to be redone. More...

bool	m_isSynchronous
	This is defaulted to true. More...

bool	m_isSavedToHistory
	Set the work order to be shown in the HistoryTreeWidget. More...

WorkOrderStatus	m_status

Detailed Description

Provide Undo/redo abilities, serialization, and history for an operation.

This class should be used for operations that affect a Project and need to provide history and/or undo/redo capabilities, and the ability for the project to guarantee a good state on disk. It follows the Command Pattern using Qt's QUndoCommand framework. Not all actions require WorkOrders - many of the actions performed in the various widgets may not use WorkOrders.

The order of execution for work orders is: setupExecution() - GUI thread, can ask user for input execute() - run on either the GUI thread or a non-GUI thread as specified by the m_isSynchronous flag postExecution() - perform any cleanup after execute.

undoExecution() - run on either the GUI thread or a non-GUI thread as specified by the m_isSynchronous flag postUndoExecution() - perform any cleanup after undoExecution()

** Adding a new Workorder **

The WorkOrder will need to be determined to be either synchronous/asynchronous and whether it is undoable. These are decisions determined by the use case. Asynchronous WorkOrders will not block the GUI thread while running and are typically used for long-running operations. Note that WorkOrders are not reentrant - a new one is created for each action.

The constructor for the WorkOrder must set m_isUndoable and m_isSynchronous to the appropriate values. The constructor must call the base WorkOrder constructor. The default is synchronous and undoable. If an import WorkOrder is being implemented the import must be some type of object and implement certain slots.

All information required to execute the WorkOrder should be saved in the WorkOrder in the setupExecution() method. Since WorkOrders may be serialized and may run on non-GUI threads there are restrictions on how the WorkOrder may save state. To allow serialization the WorkOrders must save state to the base WorkOrder class using WorkOrder::setInternalData() in the following calls: setupExecution(), postExecution(), postUndoExecution(). Workorders may use member variables to pass data between the execute() and postExecution() methods and also between the undoExecution() and undoPostExecution() methods since serialization can not happen between these calls. For asynchronous WorkOrders the execute()/postExecution() and undoExecution()/undoPostExecution() methods are on different threads so any allocated memory moved between the non-GUI and GUI threads between methods.

Serialization is handled by the base WorkOrder class. Since all state is saved into the base class using setInternalData() the derived WorkOrders do not contain any data that needs to be serialized. The times when WorkOrders are allowed to use member variables are periods when the WorkOrder can not be serialized.

There are 5 key methods in the flow of the WorkOrder as shown in the WorkOrder Flow diagram below.

setupExecution The setupExecution() method gathers all required information to run the WorkOrder but does not execute it. The gathered information is stored in the WorkOrder. SetupExecution() is optional but typically required. It can bring up GUI elements to prompt the user for any necessary information. SetupExecution() is not called when a WorkOrder is redone.

execute execute() needs to be implemented perform the WorkOrder. All information neccessary to run the WorkOrder should already be stored in the WorkOrder. The data necessary for the WorkOrder can be retrieved via internalData() Execute() can not use any GUI elements. Each time a WorkOrder is redone execute() is called to redo the WorkOrder.

For synchronous WorkOrders the execute() method runs on the GUI thread and there are no special requirements on object ownership.

For asynchronous WorkOrders any memory allocations that aren't deallocated within execute() will need to be moved to the GUI thread.

See also: ImportImagesWorkOrder::execute for an example of an asynchronous WorkOrder that allocates memory. setProgressValue() can be used to update the progress bar in the GUI. Any member variables being accessed by an asynchronous workorder will need to have a QMutex locker so they can be thread safe

postExecution postExecution() runs on the GUI thread so it should not perform any long running operations. It is intended for any cleanup or GUI updates after execute(). Typically it would only be needed for asynchronous WorkOrders where they need to update the GUI and do cleanup. It is not required to implement this method.

undoExecution undoExecution() is only required for undoable WorkOrders. undoExecution() should undo the effects of the execute() only using state stored in the WorkOrder. It will run on the GUI thread if synchronous or a non-GUI thread if asynchronous. The same restrictions as execute() apply to this method.

postUndoExecution() This is not required. If needed, it should perform any cleanup after undoExecution(). postUndoExecution() has the same restrictions as postExecution().

Other methods the WorkOrder may need to implement are:

isExecutable(<various type>) IsExecutable() determines if the WorkOrder should show up in the context menus (this has no bearing on how the main menu is populated). Note that isExecutable will need to be implemented for each type of parameter this WorkOrder should show in the context menu.

dependsOn This is currently not implemented properly for most WorkOrders. In theory this should determine if the workOrder parameter passed in must be completed prior to this workOrder completing. Most current WorkOrders just check if the WorkOrder parameter is the same type.

setCreatesCleanState This is used to indicate the WorkOrder has set the state back to an unchanged state from which the project was originally opened. This is used by open, save, and close project WorkOrders. Unlikely to be needed by other WorkOrders. This can needs to be set to false to be able to have an undoable workorder

setModifiesDiskState WorkOrders should call this to indicate they modify the disk state, this should be set to true to be able to have an undoable workorder. The WorkOrder should implement the undoExecution method if this is set to true.

WorkOrder Diagrams

Author: 2012-??-?? Steven Lambright and Stuart Sides

Member Enumeration Documentation

◆ Context

enum Isis::WorkOrder::Context

This enumeration is for recording the context of the current Workorder (whether it is part of a project or not).

Enumerator
NoContext
ProjectContext

◆ WorkOrderStatus

enum Isis::WorkOrder::WorkOrderStatus

This enumeration is used by other functions to set and retrieve the current state of the WorkOrder.

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

◆ WorkOrder() [1/2]

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

Exceptions

IException::Programmer This exception is thrown if the WorkOrder is not attached to a Project.

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

◆ ~WorkOrder()

Isis::WorkOrder::~WorkOrder ( )

virtual

The Destructor.

◆ WorkOrder() [2/2]

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

protected

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

Parameters

other The work order being copied.

Exceptions

IException::Unknown This Excecption is thrown if the WorkOrder being copies is currently running.

References _FILEINFO_, addCloneToProject(), finished(), m_isSavedToHistory, m_isSynchronous, m_isUndoable, m_status, project(), and Isis::IException::Unknown.

Member Function Documentation

◆ addCloneToProject

void Isis::WorkOrder::addCloneToProject ( )

protectedslot

Runs a copy of the current WorkOrder and stores it in the project.

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

Referenced by WorkOrder().

◆ bestText()

QString Isis::WorkOrder::bestText ( ) const

Generate unique action names We don't use action text anymore because Directory likes to rename our actions.

It converts a set of actions that have the same text, like Zoom Fit, to be in a menu named Zoom Fit with items that name their widgets. Widget names are unhelpful as a description of the action.

See also: Directory::restructureActions

Returns: QString A textual description of the action.

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

◆ clone()

virtual WorkOrder* Isis::WorkOrder::clone ( ) const

pure virtual

Implemented in Isis::ImportImagesWorkOrder, Isis::ImageListActionWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ImportShapesWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::JigsawWorkOrder, Isis::CubeDnViewWorkOrder, Isis::OpenProjectWorkOrder, Isis::RemoveImagesWorkOrder, Isis::SaveProjectAsWorkOrder, Isis::SetActiveImageListWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::SetActiveControlWorkOrder, Isis::TargetGetInfoWorkOrder, Isis::CloseProjectWorkOrder, Isis::MatrixViewWorkOrder, Isis::SaveProjectWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::SensorGetInfoWorkOrder, Isis::BundleObservationViewWorkOrder, Isis::RenameProjectWorkOrder, Isis::TemplateEditViewWorkOrder, Isis::ImportMapTemplateWorkOrder, Isis::ImportRegistrationTemplateWorkOrder, Isis::ControlHealthMonitorWorkOrder, Isis::ExportControlNetWorkOrder, Isis::ExportImagesWorkOrder, Isis::MoveDownOneSceneWorkOrder, Isis::MoveToBottomSceneWorkOrder, Isis::MoveToTopSceneWorkOrder, and Isis::MoveUpOneSceneWorkOrder.

Referenced by addCloneToProject(), and Isis::Directory::supportedActions().

◆ controlList()

QPointer< ControlList > Isis::WorkOrder::controlList ( )

protected

Returns the Control List for this WorkOrder (a list of control networks).

Returns: QPointer<ControlList> Returns m_controlList.

References project().

Referenced by Isis::ExportControlNetWorkOrder::execute(), Isis::SetActiveControlWorkOrder::execute(), Isis::CnetEditorViewWorkOrder::execute(), isExecutable(), setData(), Isis::ExportControlNetWorkOrder::setupExecution(), Isis::ControlHealthMonitorWorkOrder::setupExecution(), Isis::SetActiveControlWorkOrder::setupExecution(), and Isis::CnetEditorViewWorkOrder::setupExecution().

◆ correlationMatrix()

CorrelationMatrix Isis::WorkOrder::correlationMatrix ( )

protected

Returns the CorrleationMatrix for this WorkOrder.

Returns: A CorrelationMatrix.

References project().

Referenced by Isis::MatrixViewWorkOrder::execute(), setData(), and Isis::MatrixViewWorkOrder::setupExecution().

◆ createsCleanState()

bool Isis::WorkOrder::createsCleanState ( ) const

Returns the CleanState status (whether the Project has been saved to disk or not).

If this is set to true the work order will avoid being put on the undo stack, meaning it will not be undoable. It will also set the undo stack to a clean state, by doing this it makes all previous workorders done before the save to be no longer undoable.

Returns: Returns True if the Project has been saved to disk. False if it has not.

References project().

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

◆ creatingProgress

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

signal

◆ deletingProgress

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

signal

◆ dependsOn()

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

protectedvirtual

Indicate workorder dependency This is a virtual function whose role in child classes is to determine if this WorkOrder depends on the WorkOrder passed in as an argument.

Parameters

WorkOrder * The WorkOrder we are checking for dependency with this one.

Returns: bool Returns True if there is a dependency, and False if there is no dependency.

Reimplemented in Isis::CubeDnViewWorkOrder, Isis::JigsawWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::MatrixViewWorkOrder, Isis::TargetGetInfoWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::RenameProjectWorkOrder, Isis::SensorGetInfoWorkOrder, and Isis::TemplateEditViewWorkOrder.

Referenced by redo().

◆ directory()

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

protected

return the workorder project directory Returns the Directory object of the Project this WorkOrder is attached to.

Returns: (Directory *) A pointer to the Directory.

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

Referenced by Isis::ImageFileListViewWorkOrder::execute(), Isis::CubeDnViewWorkOrder::execute(), Isis::Footprint2DViewWorkOrder::execute(), Isis::JigsawWorkOrder::isExecutable(), and Isis::MosaicSceneWorkOrder::scene().

◆ disableWorkOrder

void Isis::WorkOrder::disableWorkOrder ( )

slot

Disables the work order.

Disables the work order so it cannot be triggered (grayed-out).

See also: Directory::initializeActions()

◆ enableWorkOrder

void Isis::WorkOrder::enableWorkOrder ( )

slot

Enables the work order.

Enables the work order so that it can be triggered (clicked).

See also: Directory::initializeActions()

◆ execute

void Isis::WorkOrder::execute ( )

virtualslot

Execute the workorder.

Execute() does the actual work in the work order. All necessary data for the execution (and undo) of the workorder should have been saved in the workorder prior to execute(). Execute() is also called to redo a workorder for redoable workorders. If the workorder is a synchrounous workorder the workorder will be run on the GUI thread, otherwise it will be queued and run on a separate thread.

For Synchronous workorders: State should only be read from the parent WorkOrder class in this method. You can set state to postExecution() safely. This method is always executed in the GUI thread.

For asynchronous workorders: State can be read from the parent WorkOrder class while in this method. You can set state to be used in postExecution() 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(). You can update progress by calling setProgressRange() and setProgressValue(). Do not manipulate any GUI objects here.

Reimplemented in Isis::ImportImagesWorkOrder, Isis::ImageListActionWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ImportShapesWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::CubeDnViewWorkOrder, Isis::JigsawWorkOrder, Isis::RemoveImagesWorkOrder, Isis::OpenProjectWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::SaveProjectAsWorkOrder, Isis::SetActiveImageListWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::SetActiveControlWorkOrder, Isis::SensorGetInfoWorkOrder, Isis::TargetGetInfoWorkOrder, Isis::CloseProjectWorkOrder, Isis::MatrixViewWorkOrder, Isis::BundleObservationViewWorkOrder, Isis::RenameProjectWorkOrder, Isis::TemplateEditViewWorkOrder, Isis::ImportMapTemplateWorkOrder, Isis::ControlHealthMonitorWorkOrder, Isis::ImportRegistrationTemplateWorkOrder, Isis::ExportControlNetWorkOrder, Isis::ExportImagesWorkOrder, Isis::MoveDownOneSceneWorkOrder, Isis::MoveToBottomSceneWorkOrder, Isis::MoveToTopSceneWorkOrder, and Isis::MoveUpOneSceneWorkOrder.

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

◆ executionTime()

QDateTime Isis::WorkOrder::executionTime ( ) const

Gets the execution time of this WorkOrder.

Returns: QDateTime The execution time.

References project().

◆ fileItem()

FileItemQsp Isis::WorkOrder::fileItem ( )

protected

WorkOrder::fileItem.

Returns: QSharedPointer Returns a shared pointer to the fileItem.

References project().

Referenced by Isis::BundleObservationViewWorkOrder::execute(), Isis::BundleObservationViewWorkOrder::isExecutable(), and setData().

◆ finished

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

signal

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

◆ fromStatusString()

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

static

Attempts to query the current status of the WorkOrder.

Parameters

statusString The status we want information about.

Returns: WorkOrderStatus Returns WorkOrderUnknownStatus if the statusString does not match the current status. If there is a result, then it returns the status which matches the statusString.

References toString(), WorkOrderLastStatus, and WorkOrderUnknownStatus.

◆ getTemplate()

Template * Isis::WorkOrder::getTemplate ( )

protected

WorkOrder::getTemplate.

Returns: QSharedPointer Returns a shared pointer to the Template.

References project().

Referenced by Isis::TemplateEditViewWorkOrder::execute(), and Isis::TemplateEditViewWorkOrder::setupExecution().

◆ guiCamera()

GuiCameraQsp Isis::WorkOrder::guiCamera ( )

protected

WorkOrder::guiCamera.

Returns: QSharedPointer Returns a shared pointer to the guiCamera.

References project().

Referenced by Isis::SensorGetInfoWorkOrder::execute(), Isis::SensorGetInfoWorkOrder::isExecutable(), setData(), and Isis::SensorGetInfoWorkOrder::setupExecution().

◆ imageList() [1/2]

ImageList * Isis::WorkOrder::imageList ( )

protected

Returns a pointer to the ImageList for this WorkOrder.

Returns: (ImageList*) A pointer to the ImageList.

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

◆ imageList() [2/2]

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

protected

A thread-safe method for retrieving a pointer to the imageList.

Returns: (ImageList *) A pointer to the image list for this WorkOrder.

References imageList().

◆ internalData()

QStringList Isis::WorkOrder::internalData ( ) const

protected

Gets the internal data for this WorkOrder.

Returns: QStringList Returns the internal data object.

References project().

◆ isExecutable() [1/10]

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

context This is an enum variable with two values: NoContext,ProjectContext.

Returns
bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

Reimplemented in Isis::RenameProjectWorkOrder.

Referenced by isExecutable(), and Isis::Directory::supportedActions().

◆ isExecutable() [2/10]

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

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

Reimplemented in Isis::ImageListActionWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::CubeDnViewWorkOrder, Isis::RemoveImagesWorkOrder, Isis::SetActiveImageListWorkOrder, Isis::ImageFileListViewWorkOrder, and Isis::ExportImagesWorkOrder.

◆ isExecutable() [3/10]

bool Isis::WorkOrder::isExecutable ( ShapeList * shapes )

virtual

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

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

Parameters

shapes A shape list that this work order should execute on

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

Reimplemented in Isis::Footprint2DViewWorkOrder, and Isis::CubeDnViewWorkOrder.

◆ isExecutable() [4/10]

bool Isis::WorkOrder::isExecutable ( ControlList * controls )

virtual

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

Parameters

control A control networks.

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not. Re-implement this method if your work order utilizes a control list (a list of control networks) for data in order to operate.

Parameters

controls A list of control networks.

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

Reimplemented in Isis::CnetEditorViewWorkOrder, Isis::SetActiveControlWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::ControlHealthMonitorWorkOrder, and Isis::ExportControlNetWorkOrder.

◆ isExecutable() [5/10]

bool Isis::WorkOrder::isExecutable ( CorrelationMatrix correlationMatrix )

virtual

Reimplemented in Isis::MatrixViewWorkOrder.

◆ isExecutable() [6/10]

bool Isis::WorkOrder::isExecutable ( TargetBodyQsp targetBody )

virtual

Re-implement this method if your work order utilizes a control list (a list of control networks) for data in order to operate.

Parameters

controls A list of control networks.

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

Reimplemented in Isis::TargetGetInfoWorkOrder.

◆ isExecutable() [7/10]

bool Isis::WorkOrder::isExecutable ( Template * currentTemplate )

virtual

Re-implement this method if your work order utilizes a control list (a list of control networks) for data in order to operate.

Parameters

controls A list of control networks.

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

◆ isExecutable() [8/10]

bool Isis::WorkOrder::isExecutable ( GuiCameraQsp guiCamera )

virtual

Re-implement this method if your WorkOrder utilizes GuiCameraQsp (a QSharedPointer to a GuiCamera object) for data in order to operate.

Parameters

GuiCameraQsp

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

Reimplemented in Isis::SensorGetInfoWorkOrder.

◆ isExecutable() [9/10]

bool Isis::WorkOrder::isExecutable ( FileItemQsp fileItem )

virtual

Re-implement this method if your WorkOrder utilizes FileItemQsp (a QSharedPointer to a FileItem object) for data in order to operate.

Parameters

FileItemQsp

Returns: bool Upon re-implementation, returns True if the WorkOrder is executable, and False if it is not.

Reimplemented in Isis::BundleObservationViewWorkOrder.

◆ isExecutable() [10/10]

bool Isis::WorkOrder::isExecutable ( ProjectItem * item )

virtual

Determines if the WorkOrder is execuatable on the data stored in a ProjectItem.

Parameters

item	(ProjectItem *) The item containing the data.

Returns: bool Returns True if the WorkOrder is executable on data stored in a ProjectItem.

Reimplemented in Isis::ImportImagesWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ImportShapesWorkOrder, Isis::TemplateEditViewWorkOrder, Isis::ImportMapTemplateWorkOrder, and Isis::ImportRegistrationTemplateWorkOrder.

◆ isFinished()

bool Isis::WorkOrder::isFinished ( ) const

Returns the finished state of this WorkOrder.

Returns: bool Returns True if the WorkOrder is finished, False otherwise.

References m_status, and WorkOrderFinished.

Referenced by redo(), and undo().

◆ isRedoing()

bool Isis::WorkOrder::isRedoing ( ) const

Returns the redoing status of this WorkOrder.

Returns: bool Returns True if the WorkOrder is executing a redo. Returns False if it is not.

References m_status, project(), and WorkOrderRedoing.

Referenced by redo(), and undo().

◆ isRedone()

bool Isis::WorkOrder::isRedone ( ) const

Returns the WorkOrder redone status.

Returns: bool Returns True if the WorkOrder has completed a Redo. False if it has not.

References m_status, project(), and WorkOrderRedone.

Referenced by redo().

◆ isSavedToHistory()

bool Isis::WorkOrder::isSavedToHistory ( ) const

Returns true if this work order is to be shown in History, otherwise false.

Returns: (bool) Returns True if this work order is to be shown in History

References m_isSavedToHistory, and project().

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

◆ isSynchronous()

bool Isis::WorkOrder::isSynchronous ( ) const

Returns true if this work order is run synchronously, otherwise false.

Returns: (bool) Returns True if this work order is run synchronously

References m_isSynchronous, and project().

Referenced by redo(), and undo().

◆ isUndoable()

bool Isis::WorkOrder::isUndoable ( ) const

Returns true if this work order is undoable, otherwise false.

This needs to be set to true and createsCleanState needs to be set to false in order for a WorkOrder to appear on the undoStack. This should be done by setting the member variable and should not be overloading this function.

Returns: (bool) Returns True if this work order is undoable, false if it is not.

References m_isUndoable, and project().

Referenced by Isis::Project::addToProject(), and setupExecution().

◆ isUndoing()

bool Isis::WorkOrder::isUndoing ( ) const

Returns the WorkOrderUndoing state.

Returns: bool Returns True if the current status is WorkOrderUndoing, False otherwise.

References m_status, project(), and WorkOrderUndoing.

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

◆ isUndone()

bool Isis::WorkOrder::isUndone ( ) const

Returns the WorkOrder undo status.

Returns: bool Returns True if the WorkOrder has been undone. False if it has not.

References m_status, project(), and WorkOrderUndone.

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

◆ modifiesDiskState()

bool Isis::WorkOrder::modifiesDiskState ( ) const

Returns the modified disk state.

Returns: Returns True if the WorkOrder has modified the Project on disk to perform it's actions. Returns False if it has not.

References project().

◆ next()

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

Gets the next WorkOrder.

Returns: QPointer pointing to the next WorkOrder.

References project().

Referenced by undo().

◆ postExecution()

void Isis::WorkOrder::postExecution ( )

protectedvirtual

Perform any necessary actions after execution of a workorder.

State can be read from the parent WorkOrder class and from state set in either synchronous() 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::ImportShapesWorkOrder, Isis::ExportControlNetWorkOrder, and Isis::ExportImagesWorkOrder.

◆ postUndoExecution()

void Isis::WorkOrder::postUndoExecution ( )

protectedvirtual

Perform any steps necessary after an undo of a workorder.

State can be read from the parent WorkOrder class and from state set undoExecution() 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, and Isis::ImportShapesWorkOrder.

◆ previous()

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

Gets the previous WorkOrder.

Returns: QPointer pointing to the previous WorkOrder.

References project().

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

◆ progressBar()

ProgressBar * Isis::WorkOrder::progressBar ( )

Returns the ProgressBar.

Returns: A QPointer to the ProgessBar.

References project().

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

◆ progressMax()

int Isis::WorkOrder::progressMax ( ) const

protected

Gets the maximum value of the progress range of the WorkOrder.

Returns: int The maximum value.

References project().

◆ progressMin()

int Isis::WorkOrder::progressMin ( ) const

protected

Gets the minimum value of the progress range of the WorkOrder.

Returns: int The minimum value.

References project().

◆ progressValue()

int Isis::WorkOrder::progressValue ( ) const

protected

Gets the current progress value of the WorkOrder.

Returns: int Returns the current progress value.

References project().

◆ project()

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

protected

Returns the Project this WorkOrder is attached to.

Returns: (Project *) A pointer to the Project.

Exceptions

IException::Programmer "This work order no longer has a project."

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

◆ read()

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

Read this work order's data from disk.

References Isis::XmlStackedHandlerReader::pushContentHandler().

◆ redo

void Isis::WorkOrder::redo ( )

virtualslot

Starts (or enqueues) a redo.

This should not be re-implemented by children.

References bestText(), dependsOn(), execute(), finished(), imageList(), isFinished(), isRedoing(), isRedone(), isSynchronous(), isUndoing(), m_status, previous(), project(), shapeList(), statusChanged(), and WorkOrderRedoing.

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

◆ save()

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

: Saves a WorkOrder to a data stream.

The XML output format looks like this:

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

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

Parameters

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

Referenced by Isis::CloseProjectWorkOrder::setupExecution(), and Isis::OpenProjectWorkOrder::setupExecution().

◆ setCreatesCleanState()

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 it is marked as a 'clean' state of the project. The QUndoCommand undo/redo will never be called. The default for createsCleanState is false. If this is set to true all wrokorders before this call will be locked.

Parameters

createsCleanState True if this work order is going to save the project to disk, False otherwise.

References createsCleanState().

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

◆ setData() [1/11]

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

virtual

Sets the context data for this WorkOrder.

Parameters

context This is an enum variable with two values: NoContext,ProjectContext.

Referenced by Isis::ImageListActionWorkOrder::setData(), setData(), Isis::ExportControlNetWorkOrder::setupExecution(), Isis::MosaicSceneWidget::supportedActions(), and Isis::Directory::supportedActions().

◆ setData() [2/11]

void Isis::WorkOrder::setData ( QString data )

virtual

◆ setData() [3/11]

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

virtual

Sets the ImageList data for this WorkOrder.

Parameters

images A pointer to the updated ImageList.

Reimplemented in Isis::ImageListActionWorkOrder.

◆ setData() [4/11]

void Isis::WorkOrder::setData ( ShapeList * shapes )

virtual

Sets the ShapeList data for this WorkOrder.

Parameters

images A pointer to the updated ShapeList.

◆ setData() [5/11]

void Isis::WorkOrder::setData ( ControlList * controls )

virtual

Sets the Control data for this WorkOrder.

Parameters

controls.	A pointer to the Control Sets the ControlList data for this WorkOrder.
controls.	A pointer to the ControlList (which is a list of control networks).

void Isis::WorkOrder::setData ( ProjectItem * item )

virtual

Sets the internal data to the data stored in a ProjectItem.

Parameters

item	The item containing the data.

◆ setInternalData()

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

protected

Sets the internal data for this WorkOrder.

WorkOrders may not use member variables to store data. Any data needed for the workorder should be saved in to the base WorkOrder using setInternalData.

Parameters

data	The data to set the internal data to.

◆ setModifiesDiskState()

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

protected

By default, m_modifiesDiskState is False. If a WorkOrder modifies the Project on disk as a result of it's action, this should be set to true.

Parameters

changesProjectOnDisk True if this WorkOrder modifies the Project on disk. False if it does not.

Referenced by Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), Isis::ImportImagesWorkOrder::ImportImagesWorkOrder(), Isis::ImportMapTemplateWorkOrder::ImportMapTemplateWorkOrder(), Isis::ImportRegistrationTemplateWorkOrder::ImportRegistrationTemplateWorkOrder(), Isis::ImportShapesWorkOrder::ImportShapesWorkOrder(), and Isis::RemoveImagesWorkOrder::RemoveImagesWorkOrder().

◆ setNext()

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

Sets the next WorkOrder in the sequence.

Parameters

nextWorkOrder The next WorkOrder.

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

◆ setPrevious()

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

Sets the previous WorkOrder in the sequence.

Parameters

previousWorkOrder The previous WorkOrder.

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

◆ setProgressRange()

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

protected

Sets the progress range of the WorkOrder.

Parameters

minValue	The progress range minimum value.
maxValue	The progress range maximum value.

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

◆ setProgressValue()

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

protected

Sets the current progress value for the WorkOrder.

Parameters

int	value The value to set the current progress to.

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

◆ setupExecution

bool Isis::WorkOrder::setupExecution ( )

virtualslot

This sets up the state for the work order.

Child should implement this to get user input.

This method is designed to be implemented by children work orders, but they need to call the base class setupExecution (at the beginning).

State should only be set in the WorkOrder class in this method. You can set arbitrary state using setInternalData(). 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. This method is always executed in the GUI thread and is the only place to ask the user questions.

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

If this method returns false the workorder will be cancelled and will not be executed.

Returns: bool Returns True upon successful preparation of the WorkOrder, 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 executing and it will not be entered into the history.

Reimplemented in Isis::ImportImagesWorkOrder, Isis::ImageListActionWorkOrder, Isis::ImportControlNetWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::ImportShapesWorkOrder, Isis::CubeDnViewWorkOrder, Isis::OpenProjectWorkOrder, Isis::RemoveImagesWorkOrder, Isis::SaveProjectAsWorkOrder, Isis::SetActiveImageListWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::SetActiveControlWorkOrder, Isis::TargetGetInfoWorkOrder, Isis::CloseProjectWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::MatrixViewWorkOrder, Isis::SaveProjectWorkOrder, Isis::SensorGetInfoWorkOrder, Isis::BundleObservationViewWorkOrder, Isis::RenameProjectWorkOrder, Isis::TemplateEditViewWorkOrder, Isis::ImportMapTemplateWorkOrder, Isis::ControlHealthMonitorWorkOrder, Isis::ImportRegistrationTemplateWorkOrder, Isis::ExportControlNetWorkOrder, and Isis::ExportImagesWorkOrder.

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

◆ shapeList() [1/2]

ShapeList * Isis::WorkOrder::shapeList ( )

protected

a pointer to the ShapeList for this WorkOrder.

Returns: (ShapeList*) A pointer to the ShapeList.

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

Referenced by isExecutable(), redo(), setData(), and shapeList().

◆ shapeList() [2/2]

const ShapeList * Isis::WorkOrder::shapeList ( ) const

protected

A thread-safe method for retrieving a pointer to the shapeList.

Returns: (ShapeList *) A pointer to the shape list for this WorkOrder.

References shapeList().

◆ statusChanged

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

signal

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

◆ statusText()

QString Isis::WorkOrder::statusText ( ) const

WorkOrder::statusText.

Returns: QString A string representation of the current WorkOrder status.

References m_status, project(), and toString().

◆ targetBody()

TargetBodyQsp Isis::WorkOrder::targetBody ( )

protected

WorkOrder::targetBody.

Returns: QSharedPointer Returns a shared pointer to the TargetBody.

References project().

Referenced by Isis::TargetGetInfoWorkOrder::execute(), Isis::TargetGetInfoWorkOrder::isExecutable(), setData(), and Isis::TargetGetInfoWorkOrder::setupExecution().

◆ toString()

QString Isis::WorkOrder::toString ( WorkOrderStatus status )

static

Gets the current status of the WorkOrder.

Parameters

status An enumeration of all possible WorkOrder states.

Returns: QString Returns a string representation of the current status of the WorkOrder.

References WorkOrderFinished, WorkOrderNotStarted, WorkOrderRedoing, WorkOrderRedone, WorkOrderUndoing, WorkOrderUndone, and WorkOrderUnknownStatus.

Referenced by fromStatusString(), save(), and statusText().

◆ undo

void Isis::WorkOrder::undo ( )

virtualslot

Starts (or enqueues) an undo.

This should not be re-implemented by children.

References bestText(), finished(), isFinished(), isRedoing(), isSynchronous(), isUndoing(), isUndone(), m_status, next(), statusChanged(), undoExecution(), WorkOrderNotStarted, and WorkOrderUndoing.

◆ undoExecution()

void Isis::WorkOrder::undoExecution ( )

protectedvirtual

Execute the steps necessary to undo this workorder.

The workorder should have all state necessary to undo itself stored in the workorder.

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

For Asynchronous workorders: State can be read from the parent WorkOrder class 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(). Do not manipulate any GUI objects here.

Reimplemented in Isis::ImportImagesWorkOrder, Isis::ImageListActionWorkOrder, Isis::ImportShapesWorkOrder, Isis::CnetEditorViewWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::SensorGetInfoWorkOrder, Isis::MatrixViewWorkOrder, Isis::RenameProjectWorkOrder, Isis::ImportMapTemplateWorkOrder, Isis::ImportRegistrationTemplateWorkOrder, Isis::MoveDownOneSceneWorkOrder, Isis::MoveToBottomSceneWorkOrder, Isis::MoveToTopSceneWorkOrder, and Isis::MoveUpOneSceneWorkOrder.

Referenced by undo().

Member Data Documentation

◆ m_isSavedToHistory

bool Isis::WorkOrder::m_isSavedToHistory

protected

Set the work order to be shown in the HistoryTreeWidget.

This is defaulted to true. If true the work order will be shown in the HistoryTreeWidget if false it will not be shown.

Referenced by Isis::BundleObservationViewWorkOrder::BundleObservationViewWorkOrder(), Isis::CloseProjectWorkOrder::CloseProjectWorkOrder(), Isis::CnetEditorViewWorkOrder::CnetEditorViewWorkOrder(), Isis::CubeDnViewWorkOrder::CubeDnViewWorkOrder(), Isis::Footprint2DViewWorkOrder::Footprint2DViewWorkOrder(), Isis::ImageFileListViewWorkOrder::ImageFileListViewWorkOrder(), Isis::ImageListActionWorkOrder::ImageListActionWorkOrder(), isSavedToHistory(), Isis::MatrixViewWorkOrder::MatrixViewWorkOrder(), Isis::SensorGetInfoWorkOrder::SensorGetInfoWorkOrder(), Isis::TargetGetInfoWorkOrder::TargetGetInfoWorkOrder(), Isis::TemplateEditViewWorkOrder::TemplateEditViewWorkOrder(), Isis::ViewControlNet3DWorkOrder::ViewControlNet3DWorkOrder(), and WorkOrder().

◆ m_isSynchronous

bool Isis::WorkOrder::m_isSynchronous

protected

This is defaulted to true.

If true, the work order will be executed on the GUI thread synchronously. If false, then the work order will be queued for execution on a non-GUI thread and will not block the GUI.

Referenced by Isis::ExportControlNetWorkOrder::ExportControlNetWorkOrder(), Isis::ExportImagesWorkOrder::ExportImagesWorkOrder(), Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), Isis::ImportImagesWorkOrder::ImportImagesWorkOrder(), Isis::ImportShapesWorkOrder::ImportShapesWorkOrder(), isSynchronous(), and WorkOrder().

◆ m_isUndoable

bool Isis::WorkOrder::m_isUndoable

protected

Set the workorder to be undoable/redoable This is defaulted to true - his will allow the workorder to be redone.

Note the workorder undoExecution() method must be implemented. This will result on the workorder being placed on the QUndoStack and being displayed in the history as being undoable. If set to false, the work order will not be put on the QUndoStack and the workorder will not be able to be undone.

Referenced by Isis::BundleObservationViewWorkOrder::BundleObservationViewWorkOrder(), Isis::CloseProjectWorkOrder::CloseProjectWorkOrder(), Isis::CnetEditorViewWorkOrder::CnetEditorViewWorkOrder(), Isis::ControlHealthMonitorWorkOrder::ControlHealthMonitorWorkOrder(), Isis::CubeDnViewWorkOrder::CubeDnViewWorkOrder(), Isis::ExportControlNetWorkOrder::ExportControlNetWorkOrder(), Isis::ExportImagesWorkOrder::ExportImagesWorkOrder(), Isis::Footprint2DViewWorkOrder::Footprint2DViewWorkOrder(), Isis::ImageFileListViewWorkOrder::ImageFileListViewWorkOrder(), Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), Isis::ImportMapTemplateWorkOrder::ImportMapTemplateWorkOrder(), Isis::ImportRegistrationTemplateWorkOrder::ImportRegistrationTemplateWorkOrder(), Isis::ImportShapesWorkOrder::ImportShapesWorkOrder(), isUndoable(), Isis::JigsawWorkOrder::JigsawWorkOrder(), Isis::OpenProjectWorkOrder::OpenProjectWorkOrder(), Isis::RemoveImagesWorkOrder::RemoveImagesWorkOrder(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::SaveProjectAsWorkOrder::SaveProjectAsWorkOrder(), Isis::SensorGetInfoWorkOrder::SensorGetInfoWorkOrder(), Isis::SetActiveControlWorkOrder::SetActiveControlWorkOrder(), Isis::SetActiveImageListWorkOrder::SetActiveImageListWorkOrder(), Isis::TargetGetInfoWorkOrder::TargetGetInfoWorkOrder(), Isis::TemplateEditViewWorkOrder::TemplateEditViewWorkOrder(), and WorkOrder().

◆ m_status

WorkOrderStatus Isis::WorkOrder::m_status

protected

Referenced by Isis::ControlHealthMonitorWorkOrder::execute(), Isis::MatrixViewWorkOrder::execute(), Isis::SetActiveControlWorkOrder::execute(), Isis::SetActiveImageListWorkOrder::execute(), isFinished(), isRedoing(), isRedone(), isUndoing(), isUndone(), Isis::ImportControlNetWorkOrder::postExecution(), Isis::ImportImagesWorkOrder::postExecution(), redo(), save(), setupExecution(), statusText(), undo(), and WorkOrder().

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

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/qisis/objs/WorkOrder/WorkOrder.h
/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/qisis/objs/WorkOrder/WorkOrder.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Context

◆ WorkOrderStatus

Constructor & Destructor Documentation

◆ WorkOrder() [1/2]

◆ ~WorkOrder()

◆ WorkOrder() [2/2]

Member Function Documentation

◆ addCloneToProject

◆ bestText()

◆ clone()

◆ controlList()

◆ correlationMatrix()

◆ createsCleanState()

◆ creatingProgress

◆ deletingProgress

◆ dependsOn()

◆ directory()

◆ disableWorkOrder

◆ enableWorkOrder

◆ execute

◆ executionTime()

◆ fileItem()

◆ finished

◆ fromStatusString()

◆ getTemplate()

◆ guiCamera()

◆ imageList() [1/2]

◆ imageList() [2/2]

◆ internalData()

◆ isExecutable() [1/10]

◆ isExecutable() [2/10]

◆ isExecutable() [3/10]

◆ isExecutable() [4/10]

◆ isExecutable() [5/10]

◆ isExecutable() [6/10]

◆ isExecutable() [7/10]

◆ isExecutable() [8/10]

◆ isExecutable() [9/10]

◆ isExecutable() [10/10]

◆ isFinished()

◆ isRedoing()

◆ isRedone()

◆ isSavedToHistory()

◆ isSynchronous()

◆ isUndoable()

◆ isUndoing()

◆ isUndone()

◆ modifiesDiskState()

◆ next()

◆ postExecution()

◆ postUndoExecution()

◆ previous()

◆ progressBar()

◆ progressMax()

◆ progressMin()

◆ progressValue()

◆ project()

◆ read()

◆ redo

◆ save()

◆ setCreatesCleanState()

◆ setData() [1/11]

◆ setData() [2/11]

◆ setData() [3/11]

◆ setData() [4/11]

◆ setData() [5/11]

◆ setData() [6/11]

◆ setData() [7/11]

◆ setData() [8/11]

◆ setData() [9/11]