Add cubes to a project. More...

#include <ImportImagesWorkOrder.h>

Inheritance diagram for Isis::ImportImagesWorkOrder:

Collaboration diagram for Isis::ImportImagesWorkOrder:

Classes
class	OriginalFileToProjectCubeFunctor
	This copies the given cube(s) into the project. More...

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
	ImportImagesWorkOrder (Project *project)
	Creates an asynchronous WorkOrder for importing images to the project. More...

	ImportImagesWorkOrder (const ImportImagesWorkOrder &other)
	Copies the WorkOrder. More...

	~ImportImagesWorkOrder ()
	Destructor. More...

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

virtual bool	isExecutable (ProjectItem *item)
	This method returns true if the user clicked on a project tree node with the text "Images". More...

virtual bool	setupExecution ()
	Sets up this work order before being executed. 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...

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
virtual void	undoExecution ()
	Undoes the work order's execute. More...

virtual void	postExecution ()
	Associates the imported images to the project. More...

virtual void	postUndoExecution ()
	Cleans up memory (images) after the undo execution occurs. 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...

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 Member Functions
ImportImagesWorkOrder &	operator= (const ImportImagesWorkOrder &rhs)

void	importConfirmedImages (QStringList confirmedImages, bool copyDnData)
	Imports the images. More...

Private Attributes
ImageList *	m_newImages
	List of images that are being imported in this work order. More...

ImageList *	m_list
	List of images that was succesfully imported into project. More...

QString	m_warning
	String of any errors/warnings that occurred during import. More...

Detailed Description

Add cubes to a project.

Asks the user for a list of cube file names and whether they should be copied into the project. The cubes are then converted to external cube label files inside the project (and cube files if the user said to copy the DN data). These files are then handed off to the project.

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

History:

2012-08-24 Steven Lambright and Stuart Sides - Removed GUI-thread slowdown of image verification

2012-08-29 Steven Lambright - This work order should now work correctly even when just 1 QtConcurrent thread is enabled.

2012-10-02 Steven Lambright - Image ID's are now guaranteed to be the same after undo/redo. This is a beginning step for making work orders whose images are freed from memory undo/redo correctly.

2012-10-29 Steven Lambright - Added a prompt to save the project if importing a lot of images to a temporary project.

2017-04-05 Ian Humphrey and Makayla Shepherd - Renamed the following: execute() to setupExeuction(), asyncRedo() to execute(), syncUndo() to undoExecution(), postSyncRedo() to postExecution(), and postSyncUndo() to postUndoExecution(). Added isSynchronous(). This is related to the WorkOrder redesign. Fixes #4732.

2017-04-11 Ian Humphrey - Removed isSynchronous() and instead set inherited member m_isSynchronous to false in constructor to indicate this is an asynchronous work order. Updated documentation. References #4732.

2017-05-01 Ian Humphrey - Updated undoExecution() so that when undo, imported images are removed from the project tree. Fixes #4597.

2017-07-06 Cole Neubauer - Added ability to have cube lists without full file path Fixes #4956

2017-07-14 Cole Neubauer - Added ability successfully import after failing to import a set or list of images Fixes #5015

2017-07-14 Cole Neubauer - Made import statement more descriptive when importing a cube list Fixes #5042

2017-07-17 Makayla Shepherd - Added isExecutable(ProjectItem) to allow for importing in the context menu. Fixes #4968.

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

2017-07-26 Makayla Shepherd - Fixed a crash that occurs when a failed image import is undone. Fixes #5043.

2017-07-28 Cole Neubauer - Added a pointer to the project item added by the work order. This pointer is used in the Undo funtions #5064

2017-08-11 Cole Neubauer - Created a try catch around a previously unprotected error to handle errors thrown in the workorder that halted execution. Fixes #5026.

2017-11-02 Tyler Wilson - Added a null pointer check around ProjectItem *item pointer in isExecutable to prevent potential seg faults. References #4492.

2017-09-26 Tracie Sucharski - In ::importConfirmedImages, pass in the cube pointer to Image constructor rather than the future result. Null out the cube pointer after it is closed in the Image. After output ecub is created reopen created ecub as readOnly. When closing cube, the labels were being re-written because the cube was read/write. This caused a segfault when imported large number of images because of a label template file being opened too many times. Uncommented error checking in functor operator method. Fixes #4955.

2018-01-18 Tracie Sucharski - Add the targets and gui cameras to the project. Fixes #5181.

2018-07-12 Summer Stapleton - Updated how adding the targets and the gui cameras to the project is handled to address segfault. Instead of creating a camera and a target with every new image imported and adding them if needed, they are now no longer created in the first place except when needed. Fixes #5460.

2018-07-19 Tracie Sucharski - Changed default button for importing DN data to "No".

History:: 2017-11-13 Cole Neubauer - Fixed apsolute paths not being read correctly in cubelis Fixes #4956

Definition at line 109 of file ImportImagesWorkOrder.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 350 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 332 of file WorkOrder.h.

Constructor & Destructor Documentation

◆ ImportImagesWorkOrder() [1/2]

Isis::ImportImagesWorkOrder::ImportImagesWorkOrder ( Project * project )

Creates an asynchronous WorkOrder for importing images to the project.

Parameters

Project *project Project to import images into.

Definition at line 48 of file ImportImagesWorkOrder.cpp.

References Isis::WorkOrder::m_isSynchronous, m_list, m_newImages, and Isis::WorkOrder::setModifiesDiskState().

Referenced by clone().

◆ ImportImagesWorkOrder() [2/2]

Isis::ImportImagesWorkOrder::ImportImagesWorkOrder ( const ImportImagesWorkOrder & other )

Copies the WorkOrder.

Parameters

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

Definition at line 66 of file ImportImagesWorkOrder.cpp.

References m_list, and m_newImages.

◆ ~ImportImagesWorkOrder()

Isis::ImportImagesWorkOrder::~ImportImagesWorkOrder ( )

Destructor.

Releases the memory for the m_newImages member.

Definition at line 78 of file ImportImagesWorkOrder.cpp.

References m_list, and m_newImages.

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 1466 of file WorkOrder.cpp.

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

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

◆ 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 809 of file WorkOrder.cpp.

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

◆ clone()

ImportImagesWorkOrder * Isis::ImportImagesWorkOrder::clone ( ) const

virtual

Creates a clone of this work order.

See also: WorkOrder::clone()

Returns: ImportImagesWorkOrder* Returns a pointer to the newly cloned work order.

Implements Isis::WorkOrder.

Definition at line 93 of file ImportImagesWorkOrder.cpp.

References ImportImagesWorkOrder().

◆ 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 720 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

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

◆ correlationMatrix()

CorrelationMatrix Isis::WorkOrder::correlationMatrix ( )

protectedinherited

Returns the CorrleationMatrix for this WorkOrder.

Returns: A CorrelationMatrix.

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

Definition at line 795 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 1304 of file WorkOrder.cpp.

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

Referenced by Isis::ImageFileListViewWorkOrder::execute(), Isis::CubeDnViewWorkOrder::execute(), Isis::Footprint2DViewWorkOrder::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 1244 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 1232 of file WorkOrder.cpp.

◆ execute()

void Isis::ImportImagesWorkOrder::execute ( )

virtual

Executes the work order.

This actually "does" the work order task. In this case, this imports the images into memory and copies any necessary data to disk. This was renamed from asyncRedo() to execute() according to the WorkOrder redesign.

See also: ImportImagesWorkOrder::importConfirmedImages(QStringList confirmedImages, bool copyDnData); WorkOrder::execute()

Reimplemented from Isis::WorkOrder.

Definition at line 282 of file ImportImagesWorkOrder.cpp.

References importConfirmedImages(), Isis::WorkOrder::internalData(), Isis::WorkOrder::project(), Isis::Project::setClean(), and Isis::IException::what().

◆ executionTime()

QDateTime Isis::WorkOrder::executionTime ( ) const

inherited

Gets the execution time of this WorkOrder.

Returns: QDateTime The execution time.

Definition at line 878 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 780 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 1002 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 750 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 770 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 645 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 730 of file WorkOrder.cpp.

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

◆ importConfirmedImages()

void Isis::ImportImagesWorkOrder::importConfirmedImages	(	QStringList	confirmedImages,
		bool	copyDnData
	)

private

Imports the images.

Creates a project image folder and copies the cubes into it. This will create the *.ecub and *.cub files inside of the project. This can be thought of as:

  mkdir project/images/import1
  cp in1.cub in2.cub project/images/import1

This should be called in a non-GUI thread.

Parameters

confirmedImages	This is a list of cube file names outside of the project folder
copyDnData	If this is true, this will create both the .cub and .ecub files in the project. Otherwise, only the external label files (*.ecub) will be created inside of the project.

Definition at line 482 of file ImportImagesWorkOrder.cpp.

References Isis::Project::addCamera(), Isis::Project::addImageFolder(), Isis::Project::addTarget(), Isis::ImageList::append(), Isis::Cube::camera(), Isis::Image::closeCube(), Isis::Image::displayProperties(), Isis::ImportImagesWorkOrder::OriginalFileToProjectCubeFunctor::errors(), Isis::PvlObject::findGroup(), Isis::Image::id(), Isis::WorkOrder::internalData(), Isis::Cube::label(), m_newImages, m_warning, Isis::WorkOrder::project(), Isis::Image::setId(), Isis::WorkOrder::setInternalData(), Isis::WorkOrder::setProgressRange(), Isis::WorkOrder::setProgressValue(), Isis::Spice::target(), Isis::IException::toString(), and Isis::IException::what().

Referenced by execute().

◆ internalData()

QStringList Isis::WorkOrder::internalData ( ) const

protectedinherited

Gets the internal data for this WorkOrder.

Returns: QStringList Returns the internal data object.

Definition at line 1391 of file WorkOrder.cpp.

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

◆ isExecutable() [1/9]

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

virtual

This method returns true if the user clicked on a project tree node with the text "Images".

This is used by Directory::supportedActions(DataType data) to determine what actions are appended to context menus.

Parameters

item	The ProjectItem that was clicked

Returns: bool True if the user clicked on a project tree node named "Shapes"

Reimplemented from Isis::WorkOrder.

Definition at line 107 of file ImportImagesWorkOrder.cpp.

◆ isExecutable() [2/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 196 of file WorkOrder.cpp.

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

◆ isExecutable() [3/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::Footprint2DViewWorkOrder, Isis::CubeDnViewWorkOrder, Isis::RemoveImagesWorkOrder, Isis::SetActiveImageListWorkOrder, Isis::ImageFileListViewWorkOrder, and Isis::ExportImagesWorkOrder.

Definition at line 210 of file WorkOrder.cpp.

◆ isExecutable() [4/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 224 of file WorkOrder.cpp.

◆ isExecutable() [5/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::CnetEditorViewWorkOrder, Isis::SetActiveControlWorkOrder, Isis::ViewControlNet3DWorkOrder, Isis::ControlHealthMonitorWorkOrder, and Isis::ExportControlNetWorkOrder.

Definition at line 248 of file WorkOrder.cpp.

◆ isExecutable() [6/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 424 of file WorkOrder.cpp.

◆ isExecutable() [7/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 436 of file WorkOrder.cpp.

◆ isExecutable() [8/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 448 of file WorkOrder.cpp.

◆ isExecutable() [9/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 460 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 888 of file WorkOrder.cpp.

References Isis::WorkOrder::WorkOrderFinished.

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

◆ 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 897 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 907 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 844 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 855 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 833 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 917 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 927 of file WorkOrder.cpp.

References Isis::WorkOrder::project().

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

◆ 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 938 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 948 of file WorkOrder.cpp.

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

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

◆ postExecution()

void Isis::ImportImagesWorkOrder::postExecution ( )

protectedvirtual

Associates the imported images to the project.

After execute finishes, associates the imported images to the project. This will also notify the project if there are any warnings that occurred related to the import. This was renamed from postSyncRedo() to postExecution() according to the WorkOrder redesign.

See also: Project::addImages(Imagelist newImages); WorkOrder::postExecution()

Reimplemented from Isis::WorkOrder.

Definition at line 308 of file ImportImagesWorkOrder.cpp.

References Isis::Project::addImages(), Isis::Project::images(), m_list, m_newImages, m_warning, Isis::WorkOrder::project(), Isis::IException::what(), and Isis::WorkOrder::WorkOrderFinished.

◆ postUndoExecution()

void Isis::ImportImagesWorkOrder::postUndoExecution ( )

protectedvirtual

Cleans up memory (images) after the undo execution occurs.

After the undoExecution() occurs, this cleans up memory that was allocated for the images from this import. This was renamed from postSyncUndo() to postUndoExecution() according to the WorkOrder redesign.

See also: WorkOrder::postUndoExecution()

Reimplemented from Isis::WorkOrder.

Definition at line 262 of file ImportImagesWorkOrder.cpp.

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

◆ previous()

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

inherited

Gets the previous WorkOrder.

Returns: QPointer pointing to the previous WorkOrder.

Definition at line 958 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 989 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 1351 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 1341 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 1361 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 1314 of file WorkOrder.cpp.

References _FILEINFO_, 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 534 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 1057 of file WorkOrder.cpp.

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

◆ 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 558 of file WorkOrder.cpp.

References _FILEINFO_, 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 1677 of file WorkOrder.cpp.

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

Referenced by Isis::CloseProjectWorkOrder::CloseProjectWorkOrder(), Isis::OpenProjectWorkOrder::OpenProjectWorkOrder(), Isis::SaveProjectAsWorkOrder::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 262 of file WorkOrder.cpp.

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

◆ setData() [2/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 275 of file WorkOrder.cpp.

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

◆ setData() [3/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 288 of file WorkOrder.cpp.

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

◆ setData() [4/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.
controls.	A pointer to the ControlList (which is a list of control networks).

Definition at line 311 of file WorkOrder.cpp.

◆ setData() [5/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 340 of file WorkOrder.cpp.

References Isis::WorkOrder::m_template.

◆ setData() [6/10]

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

virtualinherited

Sets the CorrelationMatrix data for this WorkOrder.

Parameters

correlationMatrix The matrix data.

Definition at line 320 of file WorkOrder.cpp.

References Isis::WorkOrder::correlationMatrix().

◆ setData() [7/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 331 of file WorkOrder.cpp.

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

◆ setData() [8/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 349 of file WorkOrder.cpp.

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

◆ setData() [9/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 358 of file WorkOrder.cpp.

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

◆ setData() [10/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 367 of file WorkOrder.cpp.

◆ 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 1332 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 1688 of file WorkOrder.cpp.

References Isis::WorkOrder::m_modifiesDiskState.

Referenced by Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), 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 627 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 636 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 1372 of file WorkOrder.cpp.

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

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

◆ 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 1382 of file WorkOrder.cpp.

References Isis::WorkOrder::m_progressValue.

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

◆ setupExecution()

bool Isis::ImportImagesWorkOrder::setupExecution ( )

virtual

Sets up this work order before being executed.

First invokes WorkOrder's setupExecution(). Prompts the user for cubes and image list files to import and stores them via a setInternalData() call. If there are more than 100 images to import, the user is prompted if they want to save their project before the import occurs. If yes, a SaveProjectWorkOrder will be executed. This setup is considered successful if the user does not hit cancel on a dialog prompt and if there is at least one image has been selected by the user to import. This method was renamed from execute() to setupExecution() according to the WorkOrder redesign.

See also: WorkOrder::setupExecution()

Returns: bool Returns true if the setup was successful.

Reimplemented from Isis::WorkOrder.

Definition at line 132 of file ImportImagesWorkOrder.cpp.

References Isis::FileName::expanded(), Isis::FileName::extension(), Isis::FileName::fileExists(), Isis::Project::isTemporaryProject(), Isis::FileName::original(), Isis::FileName::path(), Isis::WorkOrder::project(), Isis::WorkOrder::setInternalData(), Isis::WorkOrder::setupExecution(), and Isis::IException::what().

◆ shapeList() [1/2]

ShapeList * Isis::WorkOrder::shapeList ( )

protectedinherited

a pointer to the ShapeList for this WorkOrder.

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

Definition at line 677 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 740 of file WorkOrder.cpp.

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

◆ statusText()

QString Isis::WorkOrder::statusText ( ) const

inherited

WorkOrder::statusText.

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

Definition at line 968 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 760 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 1023 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 1160 of file WorkOrder.cpp.

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

◆ undoExecution()

void Isis::ImportImagesWorkOrder::undoExecution ( )

protectedvirtual

Undoes the work order's execute.

After this ImportImagesWorkOrder has executed and finished (all the images have been read), this removes the images from this import from disk in the project's directory. This was renamed from asyncUndo() to undoExecution() according to the WorkOrder redesign.

See also: WorkOrder::undoExecution()

Reimplemented from Isis::WorkOrder.

Definition at line 240 of file ImportImagesWorkOrder.cpp.

References Isis::ImageList::deleteFromDisk(), Isis::Project::directory(), Isis::ProjectItemModel::findItemData(), m_list, Isis::Directory::model(), Isis::WorkOrder::project(), Isis::ProjectItemModel::removeItem(), and Isis::Project::waitForImageReaderFinished().

Member Data Documentation

◆ 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 548 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 541 of file WorkOrder.h.

Referenced by Isis::ExportControlNetWorkOrder::ExportControlNetWorkOrder(), Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), 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 534 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(), Isis::SaveProjectAsWorkOrder::SaveProjectAsWorkOrder(), Isis::SensorGetInfoWorkOrder::SensorGetInfoWorkOrder(), Isis::SetActiveControlWorkOrder::SetActiveControlWorkOrder(), Isis::SetActiveImageListWorkOrder::SetActiveImageListWorkOrder(), Isis::TargetGetInfoWorkOrder::TargetGetInfoWorkOrder(), Isis::TemplateEditViewWorkOrder::TemplateEditViewWorkOrder(), and Isis::WorkOrder::WorkOrder().

◆ m_list

ImageList* Isis::ImportImagesWorkOrder::m_list

private

List of images that was succesfully imported into project.

Definition at line 169 of file ImportImagesWorkOrder.h.

Referenced by ImportImagesWorkOrder(), postExecution(), postUndoExecution(), undoExecution(), and ~ImportImagesWorkOrder().

◆ m_newImages

ImageList* Isis::ImportImagesWorkOrder::m_newImages

private

List of images that are being imported in this work order.

Definition at line 168 of file ImportImagesWorkOrder.h.

Referenced by importConfirmedImages(), ImportImagesWorkOrder(), postExecution(), and ~ImportImagesWorkOrder().

◆ m_warning

QString Isis::ImportImagesWorkOrder::m_warning

private

String of any errors/warnings that occurred during import.

Definition at line 170 of file ImportImagesWorkOrder.h.

Referenced by importConfirmedImages(), and postExecution().

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

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

Classes

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Context

◆ WorkOrderStatus

Constructor & Destructor Documentation

◆ ImportImagesWorkOrder() [1/2]

◆ ImportImagesWorkOrder() [2/2]

◆ ~ImportImagesWorkOrder()

Member Function Documentation

◆ addCloneToProject

◆ bestText()

◆ clone()

◆ controlList()

◆ correlationMatrix()

◆ createsCleanState()

◆ dependsOn()

◆ directory()

◆ disableWorkOrder

◆ enableWorkOrder

◆ execute()

◆ executionTime()

◆ fileItem()

◆ fromStatusString()

◆ getTemplate()

◆ guiCamera()

◆ imageList() [1/2]

◆ imageList() [2/2]

◆ importConfirmedImages()

◆ 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()

◆ isRedoing()

◆ isRedone()

◆ isSavedToHistory()

◆ isSynchronous()

◆ isUndoable()

◆ isUndoing()

◆ isUndone()

◆ modifiesDiskState()

◆ next()

◆ postExecution()

◆ postUndoExecution()

◆ previous()

◆ progressBar()

◆ progressMax()

◆ progressMin()

◆ progressValue()

◆ project()

◆ read()

◆ redo

◆ save()

◆ setCreatesCleanState()

◆ setData() [1/10]

◆ setData() [2/10]

◆ setData() [3/10]

◆ setData() [4/10]

◆ setData() [5/10]

◆ setData() [6/10]

◆ setData() [7/10]

◆ setData() [8/10]

◆ setData() [9/10]