Saves a project to disk (File->Save Project As...) More...

#include <SaveProjectAsWorkOrder.h>

Inheritance diagram for Isis::SaveProjectAsWorkOrder:

Collaboration diagram for Isis::SaveProjectAsWorkOrder:

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 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
	SaveProjectAsWorkOrder (Project *project)
	Creates a work order to save the project to a new location. More...

	SaveProjectAsWorkOrder (const SaveProjectAsWorkOrder &other)
	Copy constructor. More...

	~SaveProjectAsWorkOrder ()
	Destructor. More...

virtual SaveProjectAsWorkOrder *	clone () const
	Creates a clone of this work order. More...

virtual bool	setupExecution ()
	Sets up this work order prior to execution. More...

virtual void	execute ()
	Executes the work order. More...

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
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 ()
	@briefReturns 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

Private Types
enum	QueuedWorkOrderAction { NoQueuedAction, RedoQueuedAction, UndoQueuedAction }
	This enum describes the current state of a Queued WorkOrder. More...

Private Slots
void	attemptQueuedAction ()
	Attempts to execute an action on the action queue. More...

void	executionFinished ()
	Signals the Project that the WorkOrder is finished, deletes the update time for the Progress bar, and sets the finished status. More...

void	clearImageList ()
	Clears the list of images. More...

void	clearShapeList ()
	Clears the list of shapes. More...

void	updateProgress ()
	Updates the progress bar. More...

void	startRedo ()
	WorkOrder::startRedo This function is currently empty. More...

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

bool	isInStableState () const
	Determines if the WorkOrder is in a stable state, or if it's busy doing something. More...

void	listenForImageDestruction ()
	Checks to see if we have lost any images in the ImageList. More...

void	listenForShapeDestruction ()
	Checks to see if we have lost any shapes in the ShapeList. More...

void	resetProgressBar ()
	Resets the ProgressBar. More...

void	setProgressToFinalText ()
	Sets the ProgressBar to display the final status of the operation. More...

Private Attributes
bool	m_createsCleanState
	This is defaulted to false. More...

bool	m_modifiesDiskState
	This is defaulted to false. More...

QueuedWorkOrderAction	m_queuedAction

int	m_progressRangeMinValue
	The miniumum value of the Progess Bar. More...

int	m_progressRangeMaxValue
	The maximum value of the Progess Bar. More...

int	m_progressValue
	The current value of the Progress Bar. More...

Context	m_context

QString	m_data

QPointer< ImageList >	m_imageList

QPointer< ShapeList >	m_shapeList

QPointer< ControlList >	m_controlList

CorrelationMatrix	m_correlationMatrix

GuiCameraQsp	m_guiCamera
	A QSharedPointer to the GuiCamera (the Camera object but encapsulated within a Gui framework. More...

Template *	m_template
	A QSharedPointer to the Template (A Template object but encapsulated within a Gui framework. More...

TargetBodyQsp	m_targetBody
	A QSharedPointer to the TargetBody (A Target object but encapsulated within a Gui framework. More...

FileItemQsp	m_fileItem
	A QSharedPointer to the FileItem. More...

QStringList	m_imageIds
	A QStringList of unique image identifiers for all of the images this WorkOrder is dealing with. More...

QStringList	m_shapeIds
	A QStringList of unique shape identifiers for all of the shapes this WorkOrder is dealing with. More...

QStringList	m_internalData
	A QStringList of internal properties for this WorkOrder. More...

QPointer< WorkOrder >	m_nextWorkOrder
	A pointer to the next WorkOrder in the queue. More...

QPointer< WorkOrder >	m_previousWorkOrder
	A pointer to the previous WorkOrder in the queue. More...

QPointer< Project >	m_project
	A pointer to the Project this WorkOrder is attached to. More...

QMutex *	m_transparentConstMutex
	This is used to protect the integrity of data the WorkOrder is working on so that only one thread at a time cann access it. More...

QDateTime	m_executionTime
	This is the date/time that setupExecution() was called. More...

QPointer< QFutureWatcher< void > >	m_futureWatcher
	A pointer to a QFutureWatcher object which monitors a QFuture object using signals and slots. More...

QPointer< ProgressBar >	m_progressBar
	A pointer to the ProgressBar. More...

QPointer< QTimer >	m_progressBarUpdateTimer
	A pointer to the QTimer which updates the ProgressBar. More...

QPointer< QTimer >	m_progressBarDeletionTimer
	A pointer to the ProgressBar deletion timer. More...

QTime *	m_elapsedTimer
	A QTime object holding the excecution time of the WorkOrder. More...

double	m_secondsElapsed
	The seconds that have elapsed since the WorkOrder started executing. More...

Detailed Description

Saves a project to disk (File->Save Project As...)

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

History:: 2017-04-11 Ian Humphrey - Updated the work order according to the redesign of WorkOrder. Separated setup and execution steps into setupExecution and execution(). Fixes #4763.

History:: 2017-07-25 Cole Neubauer - Added project()->setClean call #4969

History:: 2017-08-08 Cole Neubauer - Removed project()->setClean call because project()->open() calls clear() which changes it appropriately, added open call in execution to load the newly saved project #5103

History:: 2017-10-20 Cole Neubauer - readded project()->setClean call because project()->open() was changed and this needed to be updated to be recognized as a clean state #5171

Definition at line 54 of file SaveProjectAsWorkOrder.h.

Member Enumeration Documentation

◆ Context

enum Isis::WorkOrder::Context

inherited

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

Definition at line 339 of file WorkOrder.h.

◆ QueuedWorkOrderAction

enum Isis::WorkOrder::QueuedWorkOrderAction

privateinherited

This enum describes the current state of a Queued WorkOrder.

Definition at line 483 of file WorkOrder.h.

◆ WorkOrderStatus

enum Isis::WorkOrder::WorkOrderStatus

inherited

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

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

Definition at line 321 of file WorkOrder.h.

Constructor & Destructor Documentation

◆ SaveProjectAsWorkOrder() [1/2]

Isis::SaveProjectAsWorkOrder::SaveProjectAsWorkOrder ( Project * project )

Creates a work order to save the project to a new location.

This work order is synchronous and not undoable.

Parameters

Project *project Pointer to the project this work order belongs to.

Definition at line 43 of file SaveProjectAsWorkOrder.cpp.

References Isis::WorkOrder::m_isUndoable, and Isis::WorkOrder::setCreatesCleanState().

Referenced by clone().

◆ SaveProjectAsWorkOrder() [2/2]

Isis::SaveProjectAsWorkOrder::SaveProjectAsWorkOrder ( const SaveProjectAsWorkOrder & other )

Copy constructor.

Creates a copy of the other SaveProjectAsWorkOrder.

Parameters

SaveProjectAsWorkOrder &other The other work order to copy state from.

Definition at line 59 of file SaveProjectAsWorkOrder.cpp.

◆ ~SaveProjectAsWorkOrder()

Isis::SaveProjectAsWorkOrder::~SaveProjectAsWorkOrder ( )

Destructor.

Destructor to clean up any memory that this work order allocates.

Definition at line 69 of file SaveProjectAsWorkOrder.cpp.

Member Function Documentation

◆ addCloneToProject

void Isis::WorkOrder::addCloneToProject ( )

protectedslotinherited

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

Definition at line 1452 of file WorkOrder.cpp.

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

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

◆ attemptQueuedAction

void Isis::WorkOrder::attemptQueuedAction ( )

privateslotinherited

Attempts to execute an action on the action queue.

Definition at line 1575 of file WorkOrder.cpp.

References Isis::WorkOrder::redo(), and Isis::WorkOrder::undo().

Referenced by Isis::WorkOrder::executionFinished(), Isis::WorkOrder::redo(), and Isis::WorkOrder::undo().

◆ bestText()

QString Isis::WorkOrder::bestText ( ) const

inherited

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.

Definition at line 795 of file WorkOrder.cpp.

Referenced by Isis::HistoryTreeWidget::addToHistory(), Isis::WorkOrder::redo(), Isis::WorkOrder::save(), and Isis::WorkOrder::undo().

◆ clearImageList

void Isis::WorkOrder::clearImageList ( )

privateslotinherited

Clears the list of images.

Definition at line 1623 of file WorkOrder.cpp.

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

◆ clearShapeList

void Isis::WorkOrder::clearShapeList ( )

privateslotinherited

Clears the list of shapes.

Definition at line 1631 of file WorkOrder.cpp.

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

◆ clone()

SaveProjectAsWorkOrder * Isis::SaveProjectAsWorkOrder::clone ( ) const

virtual

Creates a clone of this work order.

Returns: SaveProjectWorkOrder* Pointer to the newly cloned work order.

Implements Isis::WorkOrder.

Definition at line 79 of file SaveProjectAsWorkOrder.cpp.

References SaveProjectAsWorkOrder().

◆ controlList()

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

protectedinherited

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

Returns: QPointer<ControlList> Returns m_controlList.

Definition at line 706 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

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

◆ correlationMatrix()

CorrelationMatrix Isis::WorkOrder::correlationMatrix ( )

protectedinherited

Returns the CorrleationMatrix for this WorkOrder.

Returns: A CorrelationMatrix.

Definition at line 696 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

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

◆ createsCleanState()

bool Isis::WorkOrder::createsCleanState ( ) const

inherited

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.

Definition at line 854 of file WorkOrder.cpp.

References Isis::WorkOrder::m_createsCleanState, and Isis::WorkOrder::project().

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

◆ dependsOn()

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

protectedvirtualinherited

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::ViewControlNet3DWorkOrder, Isis::TemplateEditViewWorkOrder, Isis::TargetGetInfoWorkOrder, Isis::SensorGetInfoWorkOrder, Isis::RenameProjectWorkOrder, Isis::MatrixViewWorkOrder, Isis::JigsawWorkOrder, Isis::CubeDnViewWorkOrder, and Isis::CnetEditorViewWorkOrder.

Definition at line 781 of file WorkOrder.cpp.

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

◆ directory()

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

protectedinherited

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

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

Definition at line 1290 of file WorkOrder.cpp.

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

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

◆ disableWorkOrder

void Isis::WorkOrder::disableWorkOrder ( )

slotinherited

Disables the work order.

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

See also: Directory::initializeActions()

Definition at line 1230 of file WorkOrder.cpp.

◆ enableWorkOrder

void Isis::WorkOrder::enableWorkOrder ( )

slotinherited

Enables the work order.

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

See also: Directory::initializeActions()

Definition at line 1218 of file WorkOrder.cpp.

◆ execute()

void Isis::SaveProjectAsWorkOrder::execute ( )

virtual

Executes the work order.

Saves the project with the name and destination acquired in setupExecution.

Reimplemented from Isis::WorkOrder.

Definition at line 120 of file SaveProjectAsWorkOrder.cpp.

References Isis::WorkOrder::internalData(), Isis::Project::open(), Isis::WorkOrder::project(), Isis::Project::save(), and Isis::Project::setClean().

◆ executionFinished

void Isis::WorkOrder::executionFinished ( )

privateslotinherited

Signals the Project that the WorkOrder is finished, deletes the update time for the Progress bar, and sets the finished status.

Definition at line 1592 of file WorkOrder.cpp.

References Isis::WorkOrder::attemptQueuedAction(), Isis::WorkOrder::isUndoing(), Isis::WorkOrder::m_elapsedTimer, Isis::WorkOrder::m_progressBarUpdateTimer, Isis::WorkOrder::m_secondsElapsed, Isis::WorkOrder::postExecution(), Isis::WorkOrder::postUndoExecution(), and Isis::WorkOrder::setProgressToFinalText().

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

◆ executionTime()

QDateTime Isis::WorkOrder::executionTime ( ) const

inherited

Gets the execution time of this WorkOrder.

Returns: QDateTime The execution time.

Definition at line 864 of file WorkOrder.cpp.

References Isis::WorkOrder::m_executionTime, and Isis::WorkOrder::project().

Referenced by Isis::HistoryTreeWidget::addToHistory(), and Isis::WorkOrder::XmlHandler::startElement().

◆ fileItem()

FileItemQsp Isis::WorkOrder::fileItem ( )

protectedinherited

WorkOrder::fileItem.

Returns: QSharedPointer Returns a shared pointer to the fileItem.

Definition at line 766 of file WorkOrder.cpp.

References Isis::WorkOrder::m_fileItem, and Isis::WorkOrder::project().

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

◆ fromStatusString()

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

staticinherited

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.

Definition at line 988 of file WorkOrder.cpp.

References Isis::WorkOrder::toString().

Referenced by Isis::WorkOrder::XmlHandler::startElement().

◆ getTemplate()

Template * Isis::WorkOrder::getTemplate ( )

protectedinherited

WorkOrder::getTemplate.

Returns: QSharedPointer Returns a shared pointer to the Template.

Definition at line 736 of file WorkOrder.cpp.

References Isis::WorkOrder::m_template, and Isis::WorkOrder::project().

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

◆ guiCamera()

GuiCameraQsp Isis::WorkOrder::guiCamera ( )

protectedinherited

WorkOrder::guiCamera.

Returns: QSharedPointer Returns a shared pointer to the guiCamera.

Definition at line 756 of file WorkOrder.cpp.

References Isis::WorkOrder::m_guiCamera, and Isis::WorkOrder::project().

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

◆ imageList() [1/2]

ImageList * Isis::WorkOrder::imageList ( )

protectedinherited

Returns a pointer to the ImageList for this WorkOrder.

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

Definition at line 631 of file WorkOrder.cpp.

References Isis::Project::image(), Isis::WorkOrder::listenForImageDestruction(), Isis::WorkOrder::m_imageIds, and Isis::WorkOrder::project().

◆ imageList() [2/2]

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

protectedinherited

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

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

Definition at line 716 of file WorkOrder.cpp.

References Isis::WorkOrder::imageList(), and Isis::WorkOrder::m_transparentConstMutex.

◆ internalData()

QStringList Isis::WorkOrder::internalData ( ) const

protectedinherited

Gets the internal data for this WorkOrder.

Returns: QStringList Returns the internal data object.

Definition at line 1377 of file WorkOrder.cpp.

References Isis::WorkOrder::m_internalData, and Isis::WorkOrder::project().

◆ isExecutable() [1/9]

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

Definition at line 182 of file WorkOrder.cpp.

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

◆ isExecutable() [2/9]

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

virtualinherited

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::ViewControlNet3DWorkOrder, Isis::SetActiveControlWorkOrder, Isis::ExportControlNetWorkOrder, Isis::ControlHealthMonitorWorkOrder, and Isis::CnetEditorViewWorkOrder.

Definition at line 234 of file WorkOrder.cpp.

◆ isExecutable() [3/9]

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

virtualinherited

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.

Definition at line 446 of file WorkOrder.cpp.

◆ isExecutable() [4/9]

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

virtualinherited

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.

Definition at line 434 of file WorkOrder.cpp.

◆ isExecutable() [5/9]

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

virtualinherited

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::RemoveImagesWorkOrder, Isis::ImageFileListViewWorkOrder, Isis::Footprint2DViewWorkOrder, Isis::ExportImagesWorkOrder, Isis::CubeDnViewWorkOrder, and Isis::SetActiveImageListWorkOrder.

Definition at line 196 of file WorkOrder.cpp.

◆ isExecutable() [6/9]

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

virtualinherited

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::TemplateEditViewWorkOrder, Isis::ImportShapesWorkOrder, Isis::ImportRegistrationTemplateWorkOrder, Isis::ImportMapTemplateWorkOrder, Isis::ImportImagesWorkOrder, and Isis::ImportControlNetWorkOrder.

Definition at line 458 of file WorkOrder.cpp.

◆ isExecutable() [7/9]

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

virtualinherited

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.

Definition at line 210 of file WorkOrder.cpp.

◆ isExecutable() [8/9]

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

virtualinherited

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.

Definition at line 410 of file WorkOrder.cpp.

◆ isExecutable() [9/9]

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

virtualinherited

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.

Definition at line 422 of file WorkOrder.cpp.

◆ isFinished()

bool Isis::WorkOrder::isFinished ( ) const

inherited

Returns the finished state of this WorkOrder.

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

Definition at line 874 of file WorkOrder.cpp.

References Isis::WorkOrder::WorkOrderFinished.

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

◆ isInStableState()

bool Isis::WorkOrder::isInStableState ( ) const

privateinherited

Determines if the WorkOrder is in a stable state, or if it's busy doing something.

Returns: bool Returns True if the WorkOrder is in a stable state, and False if it is not.

Definition at line 1463 of file WorkOrder.cpp.

References Isis::WorkOrder::isRedoing(), and Isis::WorkOrder::isUndoing().

Referenced by Isis::WorkOrder::redo(), Isis::WorkOrder::save(), Isis::WorkOrder::undo(), and Isis::WorkOrder::WorkOrder().

◆ isRedoing()

bool Isis::WorkOrder::isRedoing ( ) const

inherited

Returns the redoing status of this WorkOrder.

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

Definition at line 883 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

Referenced by Isis::WorkOrder::isInStableState(), Isis::WorkOrder::redo(), Isis::WorkOrder::undo(), and Isis::WorkOrder::updateProgress().

◆ isRedone()

bool Isis::WorkOrder::isRedone ( ) const

inherited

Returns the WorkOrder redone status.

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

Definition at line 893 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

Referenced by Isis::WorkOrder::redo(), and Isis::WorkOrder::setProgressToFinalText().

◆ isSavedToHistory()

bool Isis::WorkOrder::isSavedToHistory ( ) const

inherited

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

Definition at line 830 of file WorkOrder.cpp.

References Isis::WorkOrder::m_isSavedToHistory, and Isis::WorkOrder::project().

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

◆ isSynchronous()

bool Isis::WorkOrder::isSynchronous ( ) const

inherited

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

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

Definition at line 841 of file WorkOrder.cpp.

References Isis::WorkOrder::m_isSynchronous, and Isis::WorkOrder::project().

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

◆ isUndoable()

bool Isis::WorkOrder::isUndoable ( ) const

inherited

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.

Definition at line 819 of file WorkOrder.cpp.

References Isis::WorkOrder::m_isUndoable, and Isis::WorkOrder::project().

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

◆ isUndoing()

bool Isis::WorkOrder::isUndoing ( ) const

inherited

Returns the WorkOrderUndoing state.

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

Definition at line 903 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

Referenced by Isis::WorkOrder::executionFinished(), Isis::WorkOrder::isInStableState(), Isis::Project::lastNotUndoneWorkOrder(), Isis::WorkOrder::redo(), Isis::WorkOrder::undo(), and Isis::WorkOrder::updateProgress().

◆ isUndone()

bool Isis::WorkOrder::isUndone ( ) const

inherited

Returns the WorkOrder undo status.

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

Definition at line 913 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

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

◆ listenForImageDestruction()

void Isis::WorkOrder::listenForImageDestruction ( )

privateinherited

Checks to see if we have lost any images in the ImageList.

If we have, then destroy the entire list. This will send a signal that the list needs to be rebuilt if requested.

Definition at line 1479 of file WorkOrder.cpp.

References Isis::WorkOrder::clearImageList(), Isis::Image::id(), and Isis::WorkOrder::m_imageIds.

Referenced by Isis::WorkOrder::imageList(), Isis::WorkOrder::setData(), and Isis::WorkOrder::WorkOrder().

◆ listenForShapeDestruction()

void Isis::WorkOrder::listenForShapeDestruction ( )

privateinherited

Checks to see if we have lost any shapes in the ShapeList.

If we have, then destroy the entire list. This will send a signal that the list needs to be rebuilt if requested.

TODO 2016-07-26 TLS Combine this with listenForImageDestruction() - Basically duplicate code.

Definition at line 1502 of file WorkOrder.cpp.

References Isis::WorkOrder::clearShapeList(), Isis::Shape::id(), and Isis::WorkOrder::m_shapeIds.

Referenced by Isis::WorkOrder::setData(), Isis::WorkOrder::shapeList(), and Isis::WorkOrder::WorkOrder().

◆ modifiesDiskState()

bool Isis::WorkOrder::modifiesDiskState ( ) const

inherited

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.

Definition at line 924 of file WorkOrder.cpp.

References Isis::WorkOrder::m_modifiesDiskState, and Isis::WorkOrder::project().

◆ next()

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

inherited

Gets the next WorkOrder.

Returns: QPointer pointing to the next WorkOrder.

Definition at line 934 of file WorkOrder.cpp.

References Isis::WorkOrder::m_nextWorkOrder, and Isis::WorkOrder::project().

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

◆ postExecution()

void Isis::WorkOrder::postExecution ( )

protectedvirtualinherited

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::ImportShapesWorkOrder, Isis::ImportImagesWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ExportImagesWorkOrder, and Isis::ExportControlNetWorkOrder.

Definition at line 1414 of file WorkOrder.cpp.

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

◆ postUndoExecution()

void Isis::WorkOrder::postUndoExecution ( )

protectedvirtualinherited

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::ImportShapesWorkOrder, and Isis::ImportImagesWorkOrder.

Definition at line 1445 of file WorkOrder.cpp.

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

◆ previous()

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

inherited

Gets the previous WorkOrder.

Returns: QPointer pointing to the previous WorkOrder.

Definition at line 944 of file WorkOrder.cpp.

References Isis::WorkOrder::m_previousWorkOrder, and Isis::WorkOrder::project().

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

◆ progressBar()

ProgressBar * Isis::WorkOrder::progressBar ( )

inherited

Returns the ProgressBar.

Returns: A QPointer to the ProgessBar.

Definition at line 975 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressBar, and Isis::WorkOrder::project().

Referenced by Isis::HistoryTreeWidget::addToHistory(), Isis::OpenProjectWorkOrder::setupExecution(), and Isis::HistoryTreeWidget::updateProgressWidgets().

◆ progressMax()

int Isis::WorkOrder::progressMax ( ) const

protectedinherited

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

Returns: int The maximum value.

Definition at line 1337 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressRangeMaxValue, and Isis::WorkOrder::project().

◆ progressMin()

int Isis::WorkOrder::progressMin ( ) const

protectedinherited

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

Returns: int The minimum value.

Definition at line 1327 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressRangeMinValue, and Isis::WorkOrder::project().

◆ progressValue()

int Isis::WorkOrder::progressValue ( ) const

protectedinherited

Gets the current progress value of the WorkOrder.

Returns: int Returns the current progress value.

Definition at line 1347 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressValue, and Isis::WorkOrder::project().

◆ project()

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

protectedinherited

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

Definition at line 1300 of file WorkOrder.cpp.

References Isis::WorkOrder::m_project, and Isis::IException::Programmer.

◆ read()

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

inherited

Read this work order's data from disk.

Definition at line 520 of file WorkOrder.cpp.

References Isis::XmlStackedHandlerReader::pushContentHandler().

◆ redo

void Isis::WorkOrder::redo ( )

virtualslotinherited

Starts (or enqueues) a redo.

This should not be re-implemented by children.

Definition at line 1043 of file WorkOrder.cpp.

Referenced by Isis::Project::addToProject(), and Isis::WorkOrder::attemptQueuedAction().

◆ resetProgressBar()

void Isis::WorkOrder::resetProgressBar ( )

privateinherited

Resets the ProgressBar.

Definition at line 1520 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressBar, Isis::WorkOrder::m_progressBarDeletionTimer, Isis::WorkOrder::m_progressBarUpdateTimer, Isis::WorkOrder::m_progressRangeMaxValue, Isis::WorkOrder::m_progressRangeMinValue, Isis::WorkOrder::m_progressValue, and Isis::WorkOrder::updateProgress().

Referenced by Isis::WorkOrder::redo(), Isis::WorkOrder::setupExecution(), and Isis::WorkOrder::undo().

◆ save()

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

inherited

: 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

Definition at line 544 of file WorkOrder.cpp.

References Isis::WorkOrder::bestText(), Isis::WorkOrder::isInStableState(), Isis::WorkOrder::m_executionTime, Isis::WorkOrder::m_imageIds, Isis::WorkOrder::m_internalData, Isis::WorkOrder::m_shapeIds, Isis::IException::Programmer, and Isis::WorkOrder::toString().

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

◆ setCreatesCleanState()

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

Definition at line 1663 of file WorkOrder.cpp.

References Isis::WorkOrder::createsCleanState(), and Isis::WorkOrder::m_createsCleanState.

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

◆ setData() [1/10]

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

virtualinherited

Sets the context data for this WorkOrder.

Parameters

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

Definition at line 248 of file WorkOrder.cpp.

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

◆ setData() [2/10]

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

virtualinherited

Sets the Control data for this WorkOrder.

Parameters

controls. A pointer to the Control

Sets the ControlList data for this WorkOrder.

Parameters

controls. A pointer to the ControlList (which is a list of control networks).

Definition at line 297 of file WorkOrder.cpp.

◆ setData() [3/10]

void Isis::WorkOrder::setData ( CorrelationMatrix correlationMatrix )

virtualinherited

Sets the CorrelationMatrix data for this WorkOrder.

Parameters

correlationMatrix The matrix data.

Definition at line 306 of file WorkOrder.cpp.

References Isis::WorkOrder::correlationMatrix().

◆ setData() [4/10]

void Isis::WorkOrder::setData ( FileItemQsp fileItem )

virtualinherited

Sets the FileItem data for this WorkOrder.

Parameters

FileItem A QSharedPointer to the FileItem.

Definition at line 344 of file WorkOrder.cpp.

References Isis::WorkOrder::fileItem(), and Isis::WorkOrder::m_fileItem.

◆ setData() [5/10]

void Isis::WorkOrder::setData ( GuiCameraQsp guiCamera )

virtualinherited

Sets the GuiCamera data for this WorkOrder.

Parameters

guiCamera A QSharedPointer to the GuiCamera.

Definition at line 335 of file WorkOrder.cpp.

References Isis::WorkOrder::guiCamera(), and Isis::WorkOrder::m_guiCamera.

◆ setData() [6/10]

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

virtualinherited

Sets the ImageList data for this WorkOrder.

Parameters

images A pointer to the updated ImageList.

Reimplemented in Isis::ImageListActionWorkOrder.

Definition at line 261 of file WorkOrder.cpp.

References Isis::WorkOrder::listenForImageDestruction(), and Isis::WorkOrder::m_imageIds.

◆ setData() [7/10]

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

virtualinherited

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

Parameters

item	The item containing the data.

Definition at line 353 of file WorkOrder.cpp.

◆ setData() [8/10]

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

virtualinherited

Sets the ShapeList data for this WorkOrder.

Parameters

images A pointer to the updated ShapeList.

Definition at line 274 of file WorkOrder.cpp.

References Isis::WorkOrder::listenForShapeDestruction(), and Isis::WorkOrder::m_shapeIds.

◆ setData() [9/10]

void Isis::WorkOrder::setData ( TargetBodyQsp targetBody )

virtualinherited

Sets the TargetBody data for this WorkOrder.

Parameters

targetBody A QSharedPointer to the TargetBody.

Definition at line 317 of file WorkOrder.cpp.

References Isis::WorkOrder::m_targetBody, and Isis::WorkOrder::targetBody().

◆ setData() [10/10]

void Isis::WorkOrder::setData ( Template * currentTemplate )

virtualinherited

Sets the TargetBody data for this WorkOrder.

Parameters

targetBody A QSharedPointer to the TargetBody.

Definition at line 326 of file WorkOrder.cpp.

References Isis::WorkOrder::m_template.

◆ setInternalData()

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

protectedinherited

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.

Definition at line 1318 of file WorkOrder.cpp.

References Isis::WorkOrder::m_internalData.

◆ setModifiesDiskState()

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

protectedinherited

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.

Definition at line 1674 of file WorkOrder.cpp.

References Isis::WorkOrder::m_modifiesDiskState.

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

◆ setNext()

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

inherited

Sets the next WorkOrder in the sequence.

Parameters

nextWorkOrder The next WorkOrder.

Definition at line 613 of file WorkOrder.cpp.

References Isis::WorkOrder::m_nextWorkOrder.

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

◆ setPrevious()

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

inherited

Sets the previous WorkOrder in the sequence.

Parameters

previousWorkOrder The previous WorkOrder.

Definition at line 622 of file WorkOrder.cpp.

References Isis::WorkOrder::m_previousWorkOrder.

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

◆ setProgressRange()

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

protectedinherited

Sets the progress range of the WorkOrder.

Parameters

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

Definition at line 1358 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressRangeMaxValue, and Isis::WorkOrder::m_progressRangeMinValue.

Referenced by Isis::ExportImagesWorkOrder::execute(), Isis::ImportControlNetWorkOrder::execute(), Isis::ImportImagesWorkOrder::importConfirmedImages(), and Isis::ImportShapesWorkOrder::importConfirmedShapes().

◆ setProgressToFinalText()

void Isis::WorkOrder::setProgressToFinalText ( )

privateinherited

Sets the ProgressBar to display the final status of the operation.

Definition at line 1544 of file WorkOrder.cpp.

References Isis::WorkOrder::isRedone(), Isis::WorkOrder::isUndone(), Isis::WorkOrder::m_progressBar, and Isis::WorkOrder::m_progressBarDeletionTimer.

Referenced by Isis::WorkOrder::executionFinished(), Isis::WorkOrder::redo(), Isis::WorkOrder::setupExecution(), and Isis::WorkOrder::undo().

◆ setProgressValue()

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

protectedinherited

Sets the current progress value for the WorkOrder.

Parameters

int	value The value to set the current progress to.

Definition at line 1368 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressValue.

Referenced by Isis::ExportImagesWorkOrder::execute(), Isis::ImportControlNetWorkOrder::execute(), Isis::ImportImagesWorkOrder::importConfirmedImages(), and Isis::ImportShapesWorkOrder::importConfirmedShapes().

◆ setupExecution()

bool Isis::SaveProjectAsWorkOrder::setupExecution ( )

virtual

Sets up this work order prior to execution.

This prompts the user for a location to save the project to and what name to save the project as. If the user provides an empty name, then this setup fails.

See also: WorkOrder::setupExecution()

Returns: bool Returns true if the provided project name is not empty, false otherwise.

Reimplemented from Isis::WorkOrder.

Definition at line 94 of file SaveProjectAsWorkOrder.cpp.

References Isis::WorkOrder::setInternalData(), and Isis::WorkOrder::setupExecution().

◆ shapeList() [1/2]

ShapeList * Isis::WorkOrder::shapeList ( )

protectedinherited

@briefReturns a pointer to the ShapeList for this WorkOrder.

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

Definition at line 663 of file WorkOrder.cpp.

References Isis::WorkOrder::listenForShapeDestruction(), Isis::WorkOrder::m_shapeIds, Isis::WorkOrder::project(), and Isis::Project::shape().

Referenced by Isis::WorkOrder::isExecutable(), Isis::WorkOrder::redo(), Isis::WorkOrder::setData(), and Isis::WorkOrder::shapeList().

◆ shapeList() [2/2]

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

protectedinherited

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

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

Definition at line 726 of file WorkOrder.cpp.

References Isis::WorkOrder::m_transparentConstMutex, and Isis::WorkOrder::shapeList().

◆ startRedo

void Isis::WorkOrder::startRedo ( )

privateslotinherited

WorkOrder::startRedo This function is currently empty.

Definition at line 1650 of file WorkOrder.cpp.

◆ statusText()

QString Isis::WorkOrder::statusText ( ) const

inherited

WorkOrder::statusText.

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

Definition at line 954 of file WorkOrder.cpp.

References Isis::WorkOrder::m_secondsElapsed, Isis::WorkOrder::project(), and Isis::WorkOrder::toString().

◆ targetBody()

TargetBodyQsp Isis::WorkOrder::targetBody ( )

protectedinherited

WorkOrder::targetBody.

Returns: QSharedPointer Returns a shared pointer to the TargetBody.

Definition at line 746 of file WorkOrder.cpp.

References Isis::WorkOrder::m_targetBody, and Isis::WorkOrder::project().

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

◆ toString()

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

staticinherited

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.

Definition at line 1009 of file WorkOrder.cpp.

References Isis::WorkOrder::WorkOrderFinished.

Referenced by Isis::WorkOrder::fromStatusString(), Isis::WorkOrder::save(), and Isis::WorkOrder::statusText().

◆ undo

void Isis::WorkOrder::undo ( )

virtualslotinherited

Starts (or enqueues) an undo.

This should not be re-implemented by children.

Definition at line 1146 of file WorkOrder.cpp.

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

◆ undoExecution()

void Isis::WorkOrder::undoExecution ( )

protectedvirtualinherited

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::MoveUpOneSceneWorkOrder, Isis::MoveToTopSceneWorkOrder, Isis::MoveToBottomSceneWorkOrder, Isis::MoveDownOneSceneWorkOrder, Isis::ImageListActionWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::SensorGetInfoWorkOrder, Isis::RenameProjectWorkOrder, Isis::MatrixViewWorkOrder, Isis::ImportShapesWorkOrder, Isis::ImportRegistrationTemplateWorkOrder, Isis::ImportMapTemplateWorkOrder, Isis::ImportImagesWorkOrder, and Isis::CnetEditorViewWorkOrder.

Definition at line 1434 of file WorkOrder.cpp.

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

◆ updateProgress

void Isis::WorkOrder::updateProgress ( )

privateslotinherited

Updates the progress bar.

Definition at line 1639 of file WorkOrder.cpp.

References Isis::WorkOrder::isRedoing(), Isis::WorkOrder::isUndoing(), Isis::WorkOrder::m_progressBar, Isis::WorkOrder::m_progressRangeMaxValue, Isis::WorkOrder::m_progressRangeMinValue, and Isis::WorkOrder::m_progressValue.

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

Member Data Documentation

◆ m_createsCleanState

bool Isis::WorkOrder::m_createsCleanState

privateinherited

This is defaulted to false.

If a work order saves the project to disk, this causes a 'clean' (non-dirty) state. These work orders should call setCreatesCleanState(true) in their constructor.

Definition at line 549 of file WorkOrder.h.

Referenced by Isis::WorkOrder::createsCleanState(), Isis::WorkOrder::setCreatesCleanState(), and Isis::WorkOrder::WorkOrder().

◆ m_elapsedTimer

QTime* Isis::WorkOrder::m_elapsedTimer

privateinherited

A QTime object holding the excecution time of the WorkOrder.

Definition at line 677 of file WorkOrder.h.

Referenced by Isis::WorkOrder::executionFinished(), Isis::WorkOrder::redo(), Isis::WorkOrder::undo(), and Isis::WorkOrder::WorkOrder().

◆ m_executionTime

QDateTime Isis::WorkOrder::m_executionTime

privateinherited

This is the date/time that setupExecution() was called.

Definition at line 647 of file WorkOrder.h.

Referenced by Isis::WorkOrder::executionTime(), Isis::WorkOrder::save(), Isis::WorkOrder::setupExecution(), and Isis::WorkOrder::WorkOrder().

◆ m_fileItem

FileItemQsp Isis::WorkOrder::m_fileItem

privateinherited

A QSharedPointer to the FileItem.

Definition at line 603 of file WorkOrder.h.

Referenced by Isis::WorkOrder::fileItem(), Isis::WorkOrder::setData(), and Isis::WorkOrder::WorkOrder().

◆ m_futureWatcher

QPointer< QFutureWatcher<void> > Isis::WorkOrder::m_futureWatcher

privateinherited

A pointer to a QFutureWatcher object which monitors a QFuture object using signals and slots.

A QFuture object represents the results of an asynchrounous operation.

Definition at line 654 of file WorkOrder.h.

Referenced by Isis::WorkOrder::redo(), Isis::WorkOrder::undo(), Isis::WorkOrder::WorkOrder(), and Isis::WorkOrder::~WorkOrder().

◆ m_guiCamera

GuiCameraQsp Isis::WorkOrder::m_guiCamera

privateinherited

A QSharedPointer to the GuiCamera (the Camera object but encapsulated within a Gui framework.

Definition at line 583 of file WorkOrder.h.

Referenced by Isis::WorkOrder::guiCamera(), Isis::WorkOrder::setData(), and Isis::WorkOrder::WorkOrder().

◆ m_imageIds

QStringList Isis::WorkOrder::m_imageIds

privateinherited

A QStringList of unique image identifiers for all of the images this WorkOrder is dealing with.

Definition at line 610 of file WorkOrder.h.

Referenced by Isis::WorkOrder::imageList(), Isis::WorkOrder::listenForImageDestruction(), Isis::WorkOrder::save(), Isis::WorkOrder::setData(), and Isis::WorkOrder::WorkOrder().

◆ m_internalData

QStringList Isis::WorkOrder::m_internalData

privateinherited

A QStringList of internal properties for this WorkOrder.

Definition at line 621 of file WorkOrder.h.

Referenced by Isis::WorkOrder::internalData(), Isis::WorkOrder::save(), Isis::WorkOrder::setInternalData(), and Isis::WorkOrder::WorkOrder().

◆ m_isSavedToHistory

bool Isis::WorkOrder::m_isSavedToHistory

protectedinherited

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.

Definition at line 537 of file WorkOrder.h.

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

◆ m_isSynchronous

bool Isis::WorkOrder::m_isSynchronous

protectedinherited

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.

Definition at line 530 of file WorkOrder.h.

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

◆ m_isUndoable

bool Isis::WorkOrder::m_isUndoable

protectedinherited

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.

Definition at line 523 of file WorkOrder.h.

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

◆ m_modifiesDiskState

bool Isis::WorkOrder::m_modifiesDiskState

privateinherited

This is defaulted to false.

If a WorkOrder modifies the project on disk to perform its actions (for example, an import WorkOrder), the WorkOrder should call setModifiesDiskState(true) in its constructor.

Definition at line 556 of file WorkOrder.h.

Referenced by Isis::WorkOrder::modifiesDiskState(), Isis::WorkOrder::setModifiesDiskState(), and Isis::WorkOrder::WorkOrder().

◆ m_nextWorkOrder

QPointer<WorkOrder> Isis::WorkOrder::m_nextWorkOrder

privateinherited

A pointer to the next WorkOrder in the queue.

Definition at line 626 of file WorkOrder.h.

Referenced by Isis::WorkOrder::next(), Isis::WorkOrder::setNext(), and Isis::WorkOrder::~WorkOrder().

◆ m_previousWorkOrder

QPointer<WorkOrder> Isis::WorkOrder::m_previousWorkOrder

privateinherited

A pointer to the previous WorkOrder in the queue.

Definition at line 631 of file WorkOrder.h.

Referenced by Isis::WorkOrder::previous(), Isis::WorkOrder::setPrevious(), and Isis::WorkOrder::~WorkOrder().

◆ m_progressBar

QPointer<ProgressBar> Isis::WorkOrder::m_progressBar

privateinherited

A pointer to the ProgressBar.

Definition at line 661 of file WorkOrder.h.

Referenced by Isis::WorkOrder::progressBar(), Isis::WorkOrder::redo(), Isis::WorkOrder::resetProgressBar(), Isis::WorkOrder::setProgressToFinalText(), Isis::WorkOrder::setupExecution(), Isis::WorkOrder::undo(), and Isis::WorkOrder::updateProgress().

◆ m_progressBarDeletionTimer

QPointer<QTimer> Isis::WorkOrder::m_progressBarDeletionTimer

privateinherited

A pointer to the ProgressBar deletion timer.

Definition at line 671 of file WorkOrder.h.

Referenced by Isis::WorkOrder::resetProgressBar(), Isis::WorkOrder::setProgressToFinalText(), and Isis::WorkOrder::~WorkOrder().

◆ m_progressBarUpdateTimer

QPointer<QTimer> Isis::WorkOrder::m_progressBarUpdateTimer

privateinherited

A pointer to the QTimer which updates the ProgressBar.

Definition at line 666 of file WorkOrder.h.

Referenced by Isis::WorkOrder::executionFinished(), Isis::WorkOrder::resetProgressBar(), and Isis::WorkOrder::~WorkOrder().

◆ m_progressRangeMaxValue

int Isis::WorkOrder::m_progressRangeMaxValue

privateinherited

The maximum value of the Progess Bar.

Definition at line 567 of file WorkOrder.h.

Referenced by Isis::WorkOrder::progressMax(), Isis::WorkOrder::resetProgressBar(), Isis::WorkOrder::setProgressRange(), Isis::WorkOrder::updateProgress(), and Isis::WorkOrder::WorkOrder().

◆ m_progressRangeMinValue

int Isis::WorkOrder::m_progressRangeMinValue

privateinherited

The miniumum value of the Progess Bar.

Definition at line 563 of file WorkOrder.h.

Referenced by Isis::WorkOrder::progressMin(), Isis::WorkOrder::resetProgressBar(), Isis::WorkOrder::setProgressRange(), Isis::WorkOrder::updateProgress(), and Isis::WorkOrder::WorkOrder().

◆ m_progressValue

int Isis::WorkOrder::m_progressValue

privateinherited

The current value of the Progress Bar.

Definition at line 571 of file WorkOrder.h.

Referenced by Isis::WorkOrder::progressValue(), Isis::WorkOrder::resetProgressBar(), Isis::WorkOrder::setProgressValue(), Isis::WorkOrder::updateProgress(), and Isis::WorkOrder::WorkOrder().

◆ m_project

QPointer<Project> Isis::WorkOrder::m_project

privateinherited

A pointer to the Project this WorkOrder is attached to.

Definition at line 636 of file WorkOrder.h.

Referenced by Isis::ImportControlNetWorkOrder::CreateControlsFunctor::operator()(), Isis::WorkOrder::project(), Isis::WorkOrder::WorkOrder(), and Isis::WorkOrder::~WorkOrder().

◆ m_secondsElapsed

double Isis::WorkOrder::m_secondsElapsed

privateinherited

The seconds that have elapsed since the WorkOrder started executing.

Definition at line 682 of file WorkOrder.h.

Referenced by Isis::WorkOrder::executionFinished(), Isis::WorkOrder::statusText(), and Isis::WorkOrder::WorkOrder().

◆ m_shapeIds

QStringList Isis::WorkOrder::m_shapeIds

privateinherited

A QStringList of unique shape identifiers for all of the shapes this WorkOrder is dealing with.

Definition at line 616 of file WorkOrder.h.

Referenced by Isis::WorkOrder::listenForShapeDestruction(), Isis::WorkOrder::save(), Isis::WorkOrder::setData(), Isis::WorkOrder::shapeList(), and Isis::WorkOrder::WorkOrder().

◆ m_targetBody

TargetBodyQsp Isis::WorkOrder::m_targetBody

privateinherited

A QSharedPointer to the TargetBody (A Target object but encapsulated within a Gui framework.

Definition at line 597 of file WorkOrder.h.

Referenced by Isis::WorkOrder::setData(), Isis::WorkOrder::targetBody(), and Isis::WorkOrder::WorkOrder().

◆ m_template

Template* Isis::WorkOrder::m_template

privateinherited

A QSharedPointer to the Template (A Template object but encapsulated within a Gui framework.

Definition at line 590 of file WorkOrder.h.

Referenced by Isis::WorkOrder::getTemplate(), Isis::WorkOrder::setData(), and Isis::WorkOrder::WorkOrder().

◆ m_transparentConstMutex

QMutex* Isis::WorkOrder::m_transparentConstMutex

privateinherited

This is used to protect the integrity of data the WorkOrder is working on so that only one thread at a time cann access it.

Definition at line 642 of file WorkOrder.h.

Referenced by Isis::WorkOrder::imageList(), Isis::WorkOrder::shapeList(), Isis::WorkOrder::WorkOrder(), and Isis::WorkOrder::~WorkOrder().

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

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

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Private Types

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Context

◆ QueuedWorkOrderAction

◆ WorkOrderStatus

Constructor & Destructor Documentation

◆ SaveProjectAsWorkOrder() [1/2]

◆ SaveProjectAsWorkOrder() [2/2]

◆ ~SaveProjectAsWorkOrder()

Member Function Documentation

◆ addCloneToProject

◆ attemptQueuedAction

◆ bestText()

◆ clearImageList

◆ clearShapeList

◆ clone()

◆ controlList()

◆ correlationMatrix()

◆ createsCleanState()

◆ dependsOn()

◆ directory()

◆ disableWorkOrder

◆ enableWorkOrder

◆ execute()

◆ executionFinished

◆ executionTime()

◆ fileItem()

◆ fromStatusString()

◆ getTemplate()

◆ guiCamera()

◆ imageList() [1/2]

◆ imageList() [2/2]

◆ internalData()

◆ isExecutable() [1/9]

◆ isExecutable() [2/9]

◆ isExecutable() [3/9]

◆ isExecutable() [4/9]

◆ isExecutable() [5/9]

◆ isExecutable() [6/9]

◆ isExecutable() [7/9]

◆ isExecutable() [8/9]

◆ isExecutable() [9/9]

◆ isFinished()

◆ isInStableState()

◆ isRedoing()

◆ isRedone()

◆ isSavedToHistory()

◆ isSynchronous()

◆ isUndoable()

◆ isUndoing()

◆ isUndone()

◆ listenForImageDestruction()

◆ listenForShapeDestruction()

◆ modifiesDiskState()

◆ next()

◆ postExecution()

◆ postUndoExecution()

◆ previous()

◆ progressBar()

◆ progressMax()

◆ progressMin()

◆ progressValue()

◆ project()

◆ read()

◆ redo

◆ resetProgressBar()

◆ save()

◆ setCreatesCleanState()