Loading [MathJax]/jax/output/NativeMML/config.js
Isis 3 Programmer Reference
Isis::ViewControlNet3DWorkOrder Class Reference

This work order displays a control network in 3D in an OpenGL view. More...

#include <ViewControlNet3DWorkOrder.h>

Inheritance diagram for Isis::ViewControlNet3DWorkOrder:
Inheritance graph
Collaboration diagram for Isis::ViewControlNet3DWorkOrder:
Collaboration graph

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.
 
void disableWorkOrder ()
 Disables the work order.
 
virtual void redo ()
 Starts (or enqueues) a redo.
 
virtual void undo ()
 Starts (or enqueues) an undo.
 

Signals

void creatingProgress (WorkOrder *)
 
void deletingProgress (WorkOrder *)
 
void finished (WorkOrder *)
 
void statusChanged (WorkOrder *)
 

Public Member Functions

 ViewControlNet3DWorkOrder (Project *project)
 Creates a WorkOrder that will display a control net.
 
 ViewControlNet3DWorkOrder (const ViewControlNet3DWorkOrder &other)
 Copies the 'other' work order instance into this new instance.
 
 ~ViewControlNet3DWorkOrder ()
 The Destructor.
 
virtual ViewControlNet3DWorkOrderclone () const
 Returns a copy of this ViewControlNet3DWorkOrder instance.
 
virtual bool isExecutable (ControlList *controls)
 Determines if there is a control net to display.
 
bool setupExecution ()
 Prompt user for any information need to display the control network.
 
virtual bool isExecutable (Context)
 Re-implement this method if your work order utilizes controls for data in order to operate.
 
virtual bool isExecutable (ImageList *images)
 Re-implement this method if your work order utilizes images for data in order to operate.
 
virtual bool isExecutable (ShapeList *shapes)
 Re-implement this method if your work order utilizes shapes for data in order to operate.
 
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.
 
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.
 
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.
 
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.
 
virtual bool isExecutable (ProjectItem *item)
 Determines if the WorkOrder is execuatable on the data stored in a ProjectItem.
 
void save (QXmlStreamWriter &stream) const
 : Saves a WorkOrder to a data stream.
 
virtual void setData (Context)
 Sets the context data for this WorkOrder.
 
virtual void setData (QString data)
 
virtual void setData (ImageList *images)
 Sets the ImageList data for this WorkOrder.
 
virtual void setData (ShapeList *shapes)
 Sets the ShapeList data for this WorkOrder.
 
virtual void setData (ControlList *controls)
 Sets the Control data for this WorkOrder.
 
virtual void setData (Template *currentTemplate)
 Sets the TargetBody data for this WorkOrder.
 
virtual void setData (CorrelationMatrix)
 Sets the CorrelationMatrix data for this WorkOrder.
 
virtual void setData (TargetBodyQsp targetBody)
 Sets the TargetBody data for this WorkOrder.
 
virtual void setData (GuiCameraQsp guiCamera)
 Sets the GuiCamera data for this WorkOrder.
 
virtual void setData (FileItemQsp fileItem)
 Sets the FileItem data for this WorkOrder.
 
virtual void setData (ProjectItem *item)
 Sets the internal data to the data stored in a ProjectItem.
 
void setNext (WorkOrder *nextWorkOrder)
 Sets the next WorkOrder in the sequence.
 
void setPrevious (WorkOrder *previousWorkOrder)
 Sets the previous WorkOrder in the sequence.
 
QString bestText () const
 Generate unique action names We don't use action text anymore because Directory likes to rename our actions.
 
bool isUndoable () const
 Returns true if this work order is undoable, otherwise false.
 
bool isSavedToHistory () const
 Returns true if this work order is to be shown in History, otherwise false.
 
bool isSynchronous () const
 Returns true if this work order is run synchronously, otherwise false.
 
bool createsCleanState () const
 Returns the CleanState status (whether the Project has been saved to disk or not).
 
QDateTime executionTime () const
 Gets the execution time of this WorkOrder.
 
bool isFinished () const
 Returns the finished state of this WorkOrder.
 
bool isRedoing () const
 Returns the redoing status of this WorkOrder.
 
bool isRedone () const
 Returns the WorkOrder redone status.
 
bool isUndoing () const
 Returns the WorkOrderUndoing state.
 
bool isUndone () const
 Returns the WorkOrder undo status.
 
bool modifiesDiskState () const
 Returns the modified disk state.
 
WorkOrdernext () const
 Gets the next WorkOrder.
 
WorkOrderprevious () const
 Gets the previous WorkOrder.
 
QString statusText () const
 WorkOrder::statusText.
 
ProgressBarprogressBar ()
 Returns the ProgressBar.
 

Static Public Member Functions

static WorkOrderStatus fromStatusString (QString)
 Attempts to query the current status of the WorkOrder.
 
static QString toString (WorkOrderStatus)
 Gets the current status of the WorkOrder.
 

Protected Slots

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

Protected Member Functions

bool dependsOn (WorkOrder *other) const
 Determines whether a WorkOrder depends upon ViewControlNet3DWorkOrder.
 
void execute ()
 Display the 3D control network.
 
void undoExecution ()
 Deletes the last view.
 
ImageListimageList ()
 Returns a pointer to the ImageList for this WorkOrder.
 
const ImageListimageList () const
 A thread-safe method for retrieving a pointer to the imageList.
 
ShapeListshapeList ()
 @briefReturns a pointer to the ShapeList for this WorkOrder.
 
const ShapeListshapeList () const
 A thread-safe method for retrieving a pointer to the shapeList.
 
CorrelationMatrix correlationMatrix ()
 Returns the CorrleationMatrix for this WorkOrder.
 
QPointer< ControlListcontrolList ()
 Returns the Control List for this WorkOrder (a list of control networks).
 
TemplategetTemplate ()
 WorkOrder::getTemplate.
 
TargetBodyQsp targetBody ()
 WorkOrder::targetBody.
 
GuiCameraQsp guiCamera ()
 WorkOrder::guiCamera.
 
FileItemQsp fileItem ()
 WorkOrder::fileItem.
 
Directorydirectory () const
 return the workorder project directory Returns the Directory object of the Project this WorkOrder is attached to.
 
Projectproject () const
 Returns the Project this WorkOrder is attached to.
 
void setCreatesCleanState (bool createsCleanState)
 Declare that this work order is saving the project.
 
void setModifiesDiskState (bool changesProjectOnDisk)
 
void setInternalData (QStringList data)
 Sets the internal data for this WorkOrder.
 
int progressMin () const
 Gets the minimum value of the progress range of the WorkOrder.
 
int progressMax () const
 Gets the maximum value of the progress range of the WorkOrder.
 
int progressValue () const
 Gets the current progress value of the WorkOrder.
 
void setProgressRange (int, int)
 Sets the progress range of the WorkOrder.
 
void setProgressValue (int)
 Sets the current progress value for the WorkOrder.
 
QStringList internalData () const
 Gets the internal data for this WorkOrder.
 
virtual void postExecution ()
 Perform any necessary actions after execution of a workorder.
 
virtual void postUndoExecution ()
 Perform any steps necessary after an undo of a workorder.
 

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.
 
bool m_isSynchronous
 This is defaulted to true.
 
bool m_isSavedToHistory
 Set the work order to be shown in the HistoryTreeWidget.
 
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.
 
void executionFinished ()
 Signals the Project that the WorkOrder is finished, deletes the update time for the Progress bar, and sets the finished status.
 
void clearImageList ()
 Clears the list of images.
 
void clearShapeList ()
 Clears the list of shapes.
 
void updateProgress ()
 Updates the progress bar.
 
void startRedo ()
 WorkOrder::startRedo This function is currently empty.
 

Private Member Functions

ViewControlNet3DWorkOrderoperator= (const ViewControlNet3DWorkOrder &rhs)
 
bool isInStableState () const
 Determines if the WorkOrder is in a stable state, or if it's busy doing something.
 
void listenForImageDestruction ()
 Checks to see if we have lost any images in the ImageList.
 
void listenForShapeDestruction ()
 Checks to see if we have lost any shapes in the ShapeList.
 
void resetProgressBar ()
 Resets the ProgressBar.
 
void setProgressToFinalText ()
 Sets the ProgressBar to display the final status of the operation.
 

Private Attributes

bool m_createsCleanState
 This is defaulted to false.
 
bool m_modifiesDiskState
 This is defaulted to false.
 
QueuedWorkOrderAction m_queuedAction
 
int m_progressRangeMinValue
 The miniumum value of the Progess Bar.
 
int m_progressRangeMaxValue
 The maximum value of the Progess Bar.
 
int m_progressValue
 The current value of the Progress Bar.
 
Context m_context
 
QString m_data
 
QPointer< ImageListm_imageList
 
QPointer< ShapeListm_shapeList
 
QPointer< ControlListm_controlList
 
CorrelationMatrix m_correlationMatrix
 
GuiCameraQsp m_guiCamera
 A QSharedPointer to the GuiCamera (the Camera object but encapsulated within a Gui framework.
 
Templatem_template
 A QSharedPointer to the Template (A Template object but encapsulated within a Gui framework.
 
TargetBodyQsp m_targetBody
 A QSharedPointer to the TargetBody (A Target object but encapsulated within a Gui framework.
 
FileItemQsp m_fileItem
 A QSharedPointer to the FileItem.
 
QStringList m_imageIds
 A QStringList of unique image identifiers for all of the images this WorkOrder is dealing with.
 
QStringList m_shapeIds
 A QStringList of unique shape identifiers for all of the shapes this WorkOrder is dealing with.
 
QStringList m_internalData
 A QStringList of internal properties for this WorkOrder.
 
QPointer< WorkOrderm_nextWorkOrder
 A pointer to the next WorkOrder in the queue.
 
QPointer< WorkOrderm_previousWorkOrder
 A pointer to the previous WorkOrder in the queue.
 
QPointer< Projectm_project
 A pointer to the Project this WorkOrder is attached to.
 
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.
 
QDateTime m_executionTime
 This is the date/time that setupExecution() was called.
 
QPointer< QFutureWatcher< void > > m_futureWatcher
 A pointer to a QFutureWatcher object which monitors a QFuture object using signals and slots.
 
QPointer< ProgressBarm_progressBar
 A pointer to the ProgressBar.
 
QPointer< QTimer > m_progressBarUpdateTimer
 A pointer to the QTimer which updates the ProgressBar.
 
QPointer< QTimer > m_progressBarDeletionTimer
 A pointer to the ProgressBar deletion timer.
 
QElapsedTimer * m_elapsedTimer
 A QElapsedTimer object holding the excecution time of the WorkOrder.
 
double m_secondsElapsed
 The seconds that have elapsed since the WorkOrder started executing.
 

Detailed Description

This work order displays a control network in 3D in an OpenGL view.

This runs synchronously and is undoable. This is non-functioning and mostly unimplemented.

Author
2014-04-04 Ken Edmundson
Author
2016-06-06 Tyler Wilson - Added documentation for the functions and brought the code into compliance with ISIS coding standards. References #3944.
History

2017-04-16 J Bonn - Updated to new workorder design #4764.

2017-07-24 Cole Neuabuer - Set m_isSavedToHistory to false on construction Fixes #4715

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

2017-11-02 Tyler Wilson - Added a null pointer check on the controls pointer in the isExecutable function to prevent potential seg faults. References #4492.

Definition at line 47 of file ViewControlNet3DWorkOrder.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

This enum describes the current state of a Queued WorkOrder.

Definition at line 482 of file WorkOrder.h.

◆ WorkOrderStatus

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

◆ ViewControlNet3DWorkOrder() [1/2]

Isis::ViewControlNet3DWorkOrder::ViewControlNet3DWorkOrder ( Project * project)

Creates a WorkOrder that will display a control net.

Parameters
projectThe Project that this work order should be interacting with.

Definition at line 41 of file ViewControlNet3DWorkOrder.cpp.

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

Referenced by clone(), dependsOn(), and ViewControlNet3DWorkOrder().

◆ ViewControlNet3DWorkOrder() [2/2]

Isis::ViewControlNet3DWorkOrder::ViewControlNet3DWorkOrder ( const ViewControlNet3DWorkOrder & other)

Copies the 'other' work order instance into this new instance.

Parameters
otherThe work order being copied.

Definition at line 52 of file ViewControlNet3DWorkOrder.cpp.

References ViewControlNet3DWorkOrder(), and Isis::WorkOrder::WorkOrder().

◆ ~ViewControlNet3DWorkOrder()

Isis::ViewControlNet3DWorkOrder::~ViewControlNet3DWorkOrder ( )

The Destructor.

Definition at line 60 of file ViewControlNet3DWorkOrder.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 1440 of file WorkOrder.cpp.

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

Referenced by WorkOrder(), and WorkOrder().

◆ attemptQueuedAction

void Isis::WorkOrder::attemptQueuedAction ( )
privateslotinherited

Attempts to execute an action on the action queue.

Definition at line 1563 of file WorkOrder.cpp.

References redo(), and undo().

Referenced by executionFinished(), redo(), and 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 783 of file WorkOrder.cpp.

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

◆ clearImageList

void Isis::WorkOrder::clearImageList ( )
privateslotinherited

Clears the list of images.

Definition at line 1611 of file WorkOrder.cpp.

Referenced by listenForImageDestruction().

◆ clearShapeList

void Isis::WorkOrder::clearShapeList ( )
privateslotinherited

Clears the list of shapes.

Definition at line 1619 of file WorkOrder.cpp.

Referenced by listenForShapeDestruction().

◆ clone()

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

Returns a copy of this ViewControlNet3DWorkOrder instance.

Returns
(ViewControlNet3DWorkOrder *) A pointer to a copy of this WorkOrder.

Implements Isis::WorkOrder.

Definition at line 68 of file ViewControlNet3DWorkOrder.cpp.

References ViewControlNet3DWorkOrder().

◆ controlList()

◆ correlationMatrix()

CorrelationMatrix Isis::WorkOrder::correlationMatrix ( )
protectedinherited

Returns the CorrleationMatrix for this WorkOrder.

Returns
A CorrelationMatrix.

Definition at line 684 of file WorkOrder.cpp.

References project().

Referenced by Isis::MatrixViewWorkOrder::execute(), 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 842 of file WorkOrder.cpp.

References m_createsCleanState, and project().

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

◆ dependsOn()

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

Determines whether a WorkOrder depends upon ViewControlNet3DWorkOrder.

Parameters
otherThe WorkOrder being checked for dependency.
Returns
bool True if their is a dependency, False otherwise.

Reimplemented from Isis::WorkOrder.

Definition at line 114 of file ViewControlNet3DWorkOrder.cpp.

References ViewControlNet3DWorkOrder(), and Isis::WorkOrder::WorkOrder().

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

References Isis::Project::directory(), and 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 1218 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 1206 of file WorkOrder.cpp.

◆ execute()

void Isis::ViewControlNet3DWorkOrder::execute ( )
protectedvirtual

Display the 3D control network.

Currently not implemented.

Reimplemented from Isis::WorkOrder.

Definition at line 123 of file ViewControlNet3DWorkOrder.cpp.

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

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

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

◆ executionTime()

QDateTime Isis::WorkOrder::executionTime ( ) const
inherited

Gets the execution time of this WorkOrder.

Returns
QDateTime The execution time.

Definition at line 852 of file WorkOrder.cpp.

References m_executionTime, and project().

Referenced by Isis::HistoryTreeWidget::addToHistory().

◆ fileItem()

FileItemQsp Isis::WorkOrder::fileItem ( )
protectedinherited

WorkOrder::fileItem.

Returns
QSharedPointer Returns a shared pointer to the fileItem.

Definition at line 754 of file WorkOrder.cpp.

References m_fileItem, and project().

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

◆ fromStatusString()

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

Attempts to query the current status of the WorkOrder.

Parameters
statusStringThe 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 976 of file WorkOrder.cpp.

References toString().

◆ getTemplate()

Template * Isis::WorkOrder::getTemplate ( )
protectedinherited

WorkOrder::getTemplate.

Returns
QSharedPointer Returns a shared pointer to the Template.

Definition at line 724 of file WorkOrder.cpp.

References m_template, and project().

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

◆ guiCamera()

GuiCameraQsp Isis::WorkOrder::guiCamera ( )
protectedinherited

◆ imageList() [1/2]

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

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

◆ internalData()

QStringList Isis::WorkOrder::internalData ( ) const
protectedinherited

Gets the internal data for this WorkOrder.

Returns
QStringList Returns the internal data object.

Definition at line 1365 of file WorkOrder.cpp.

References m_internalData, and project().

Referenced by Isis::CubeDnViewWorkOrder::execute(), Isis::ExportControlNetWorkOrder::execute(), Isis::ExportImagesWorkOrder::execute(), Isis::Footprint2DViewWorkOrder::execute(), Isis::ImageFileListViewWorkOrder::execute(), Isis::ImageListActionWorkOrder::execute(), Isis::ImportControlNetWorkOrder::execute(), Isis::ImportImagesWorkOrder::execute(), Isis::ImportMapTemplateWorkOrder::execute(), Isis::ImportRegistrationTemplateWorkOrder::execute(), Isis::ImportShapesWorkOrder::execute(), Isis::RenameProjectWorkOrder::execute(), Isis::SaveProjectAsWorkOrder::execute(), Isis::ImageListActionWorkOrder::ImageListActionWorkOrder(), Isis::ImportImagesWorkOrder::importConfirmedImages(), Isis::ImportShapesWorkOrder::importConfirmedShapes(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::MosaicSceneWorkOrder::restoreZPositions(), Isis::MosaicSceneWorkOrder::scene(), Isis::ImageListActionWorkOrder::setData(), Isis::CubeDnViewWorkOrder::setupExecution(), Isis::ExportControlNetWorkOrder::setupExecution(), Isis::ExportImagesWorkOrder::setupExecution(), Isis::Footprint2DViewWorkOrder::setupExecution(), Isis::ImageFileListViewWorkOrder::setupExecution(), Isis::ImageListActionWorkOrder::setupExecution(), Isis::ImportControlNetWorkOrder::setupExecution(), Isis::MatrixViewWorkOrder::setupExecution(), Isis::RenameProjectWorkOrder::setupExecution(), Isis::SensorGetInfoWorkOrder::setupExecution(), Isis::TargetGetInfoWorkOrder::setupExecution(), Isis::TemplateEditViewWorkOrder::setupExecution(), Isis::ImageListActionWorkOrder::undoExecution(), Isis::MatrixViewWorkOrder::undoExecution(), and Isis::RenameProjectWorkOrder::undoExecution().

◆ isExecutable() [1/10]

bool Isis::ViewControlNet3DWorkOrder::isExecutable ( ControlList * controls)
virtual

Determines if there is a control net to display.

Parameters
controlsA list of all the control networks in the Project.
Returns
bool Returns True if there is exactly one control network to display, False otherwise.

Reimplemented from Isis::WorkOrder.

Definition at line 80 of file ViewControlNet3DWorkOrder.cpp.

◆ isExecutable() [2/10]

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

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

◆ isExecutable() [3/10]

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

Reimplemented in Isis::MatrixViewWorkOrder.

Definition at line 236 of file WorkOrder.cpp.

◆ isExecutable() [4/10]

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

References fileItem().

◆ isExecutable() [5/10]

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

References guiCamera().

◆ isExecutable() [6/10]

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

Definition at line 193 of file WorkOrder.cpp.

◆ isExecutable() [7/10]

◆ isExecutable() [8/10]

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
shapesA 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::CubeDnViewWorkOrder, and Isis::Footprint2DViewWorkOrder.

Definition at line 207 of file WorkOrder.cpp.

◆ isExecutable() [9/10]

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

References targetBody().

◆ isExecutable() [10/10]

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
controlsA 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 419 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 862 of file WorkOrder.cpp.

References WorkOrderFinished.

Referenced by redo(), and 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 1451 of file WorkOrder.cpp.

References isRedoing(), and isUndoing().

Referenced by redo(), save(), undo(), and 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 871 of file WorkOrder.cpp.

References project().

Referenced by isInStableState(), redo(), undo(), and 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 881 of file WorkOrder.cpp.

References project().

Referenced by redo(), and 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 818 of file WorkOrder.cpp.

References m_isSavedToHistory, and 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 829 of file WorkOrder.cpp.

References m_isSynchronous, and project().

Referenced by redo(), and 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 807 of file WorkOrder.cpp.

References m_isUndoable, and project().

Referenced by Isis::HistoryTreeWidget::addToHistory(), Isis::Project::addToProject(), and 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 891 of file WorkOrder.cpp.

References project().

Referenced by executionFinished(), isInStableState(), Isis::Project::lastNotUndoneWorkOrder(), Isis::Project::lastNotUndoneWorkOrder(), redo(), undo(), and 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 901 of file WorkOrder.cpp.

References project().

Referenced by Isis::Project::lastNotUndoneWorkOrder(), Isis::Project::lastNotUndoneWorkOrder(), setProgressToFinalText(), and 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 1467 of file WorkOrder.cpp.

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

Referenced by imageList(), setData(), and 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 1490 of file WorkOrder.cpp.

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

Referenced by setData(), shapeList(), and 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 912 of file WorkOrder.cpp.

References m_modifiesDiskState, and project().

◆ next()

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

Gets the next WorkOrder.

Returns
QPointer pointing to the next WorkOrder.

Definition at line 922 of file WorkOrder.cpp.

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

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

Definition at line 1402 of file WorkOrder.cpp.

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

Definition at line 1433 of file WorkOrder.cpp.

Referenced by executionFinished().

◆ previous()

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

Gets the previous WorkOrder.

Returns
QPointer pointing to the previous WorkOrder.

Definition at line 932 of file WorkOrder.cpp.

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

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

◆ progressBar()

ProgressBar * Isis::WorkOrder::progressBar ( )
inherited

Returns the ProgressBar.

Returns
A QPointer to the ProgessBar.

Definition at line 963 of file WorkOrder.cpp.

References m_progressBar, and 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 1325 of file WorkOrder.cpp.

References m_progressRangeMaxValue, and 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 1315 of file WorkOrder.cpp.

References m_progressRangeMinValue, and 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 1335 of file WorkOrder.cpp.

References m_progressValue, and 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 1288 of file WorkOrder.cpp.

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

Referenced by addCloneToProject(), Isis::BundleObservationViewWorkOrder::BundleObservationViewWorkOrder(), Isis::CloseProjectWorkOrder::CloseProjectWorkOrder(), Isis::ImportControlNetWorkOrder::cnetReady(), Isis::ControlHealthMonitorWorkOrder::ControlHealthMonitorWorkOrder(), controlList(), correlationMatrix(), Isis::ImportControlNetWorkOrder::CreateControlsFunctor::CreateControlsFunctor(), createsCleanState(), Isis::CubeDnViewWorkOrder::CubeDnViewWorkOrder(), directory(), Isis::BundleObservationViewWorkOrder::execute(), Isis::CloseProjectWorkOrder::execute(), Isis::CnetEditorViewWorkOrder::execute(), Isis::ControlHealthMonitorWorkOrder::execute(), Isis::CubeDnViewWorkOrder::execute(), Isis::ExportControlNetWorkOrder::execute(), Isis::ExportImagesWorkOrder::execute(), Isis::Footprint2DViewWorkOrder::execute(), Isis::ImageFileListViewWorkOrder::execute(), Isis::ImportControlNetWorkOrder::execute(), Isis::ImportImagesWorkOrder::execute(), Isis::ImportMapTemplateWorkOrder::execute(), Isis::ImportRegistrationTemplateWorkOrder::execute(), Isis::ImportShapesWorkOrder::execute(), Isis::JigsawWorkOrder::execute(), Isis::MatrixViewWorkOrder::execute(), Isis::OpenProjectWorkOrder::execute(), Isis::RemoveImagesWorkOrder::execute(), Isis::RenameProjectWorkOrder::execute(), Isis::SaveProjectAsWorkOrder::execute(), Isis::SensorGetInfoWorkOrder::execute(), Isis::SetActiveControlWorkOrder::execute(), Isis::SetActiveImageListWorkOrder::execute(), Isis::TargetGetInfoWorkOrder::execute(), Isis::TemplateEditViewWorkOrder::execute(), executionTime(), Isis::ExportControlNetWorkOrder::ExportControlNetWorkOrder(), fileItem(), Isis::Footprint2DViewWorkOrder::Footprint2DViewWorkOrder(), getTemplate(), guiCamera(), imageList(), Isis::ImageListActionWorkOrder::ImageListActionWorkOrder(), Isis::ImageListActionWorkOrder::ImageListActionWorkOrder(), Isis::ImportImagesWorkOrder::importConfirmedImages(), Isis::ImportShapesWorkOrder::importConfirmedShapes(), Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), Isis::ImportImagesWorkOrder::ImportImagesWorkOrder(), Isis::ImportMapTemplateWorkOrder::ImportMapTemplateWorkOrder(), Isis::ImportRegistrationTemplateWorkOrder::ImportRegistrationTemplateWorkOrder(), Isis::ImportShapesWorkOrder::ImportShapesWorkOrder(), internalData(), Isis::JigsawWorkOrder::isExecutable(), Isis::SensorGetInfoWorkOrder::isExecutable(), Isis::SetActiveControlWorkOrder::isExecutable(), Isis::SetActiveImageListWorkOrder::isExecutable(), Isis::TargetGetInfoWorkOrder::isExecutable(), Isis::TemplateEditViewWorkOrder::isExecutable(), isRedoing(), isRedone(), isSavedToHistory(), isSynchronous(), isUndoable(), isUndoing(), isUndone(), Isis::JigsawWorkOrder::JigsawWorkOrder(), Isis::MatrixViewWorkOrder::MatrixViewWorkOrder(), modifiesDiskState(), next(), Isis::OpenProjectWorkOrder::OpenProjectWorkOrder(), Isis::ExportControlNetWorkOrder::postExecution(), Isis::ExportImagesWorkOrder::postExecution(), Isis::ImportControlNetWorkOrder::postExecution(), Isis::ImportImagesWorkOrder::postExecution(), Isis::ImportShapesWorkOrder::postExecution(), Isis::ImportImagesWorkOrder::postUndoExecution(), Isis::ImportShapesWorkOrder::postUndoExecution(), previous(), progressBar(), progressMax(), progressMin(), progressValue(), redo(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::SaveProjectAsWorkOrder::SaveProjectAsWorkOrder(), Isis::SaveProjectWorkOrder::SaveProjectWorkOrder(), Isis::SensorGetInfoWorkOrder::SensorGetInfoWorkOrder(), Isis::SetActiveControlWorkOrder::SetActiveControlWorkOrder(), Isis::SetActiveImageListWorkOrder::SetActiveImageListWorkOrder(), Isis::CloseProjectWorkOrder::setupExecution(), Isis::CubeDnViewWorkOrder::setupExecution(), Isis::ExportControlNetWorkOrder::setupExecution(), Isis::ExportImagesWorkOrder::setupExecution(), Isis::Footprint2DViewWorkOrder::setupExecution(), Isis::ImageFileListViewWorkOrder::setupExecution(), Isis::ImportImagesWorkOrder::setupExecution(), Isis::MatrixViewWorkOrder::setupExecution(), Isis::OpenProjectWorkOrder::setupExecution(), Isis::RemoveImagesWorkOrder::setupExecution(), Isis::RenameProjectWorkOrder::setupExecution(), Isis::SaveProjectWorkOrder::setupExecution(), Isis::SetActiveControlWorkOrder::setupExecution(), shapeList(), statusText(), targetBody(), Isis::TargetGetInfoWorkOrder::TargetGetInfoWorkOrder(), Isis::TemplateEditViewWorkOrder::TemplateEditViewWorkOrder(), Isis::CnetEditorViewWorkOrder::undoExecution(), Isis::ImportImagesWorkOrder::undoExecution(), Isis::ImportMapTemplateWorkOrder::undoExecution(), Isis::ImportRegistrationTemplateWorkOrder::undoExecution(), Isis::ImportShapesWorkOrder::undoExecution(), Isis::MatrixViewWorkOrder::undoExecution(), Isis::RenameProjectWorkOrder::undoExecution(), Isis::ViewControlNet3DWorkOrder::ViewControlNet3DWorkOrder(), WorkOrder(), and WorkOrder().

◆ redo

void Isis::WorkOrder::redo ( )
virtualslotinherited

◆ resetProgressBar()

void Isis::WorkOrder::resetProgressBar ( )
privateinherited

◆ 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

b QXmlStreamWriter stream The data stream we are saving the WorkOrder to.

Exceptions
IException::UnknownThis exception is thrown if save is called while the WorkOrder is currently running.

Definition at line 532 of file WorkOrder.cpp.

References bestText(), isInStableState(), m_executionTime, m_imageIds, m_internalData, m_shapeIds, Isis::IException::Programmer, and 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
createsCleanStateTrue if this work order is going to save the project to disk, False otherwise.

Definition at line 1651 of file WorkOrder.cpp.

References createsCleanState(), and m_createsCleanState.

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

◆ setData() [1/11]

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

Sets the context data for this WorkOrder.

Parameters
contextThis is an enum variable with two values: NoContext,ProjectContext.

Definition at line 245 of file WorkOrder.cpp.

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

◆ setData() [2/11]

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

◆ setData() [3/11]

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

Sets the CorrelationMatrix data for this WorkOrder.

Parameters
correlationMatrixThe matrix data.

Definition at line 303 of file WorkOrder.cpp.

References correlationMatrix().

◆ setData() [4/11]

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

Sets the FileItem data for this WorkOrder.

Parameters
FileItemA QSharedPointer to the FileItem.

Definition at line 341 of file WorkOrder.cpp.

References fileItem(), and m_fileItem.

◆ setData() [5/11]

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

Sets the GuiCamera data for this WorkOrder.

Parameters
guiCameraA QSharedPointer to the GuiCamera.

Definition at line 332 of file WorkOrder.cpp.

References guiCamera(), and m_guiCamera.

◆ setData() [6/11]

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

Sets the ImageList data for this WorkOrder.

Parameters
imagesA pointer to the updated ImageList.

Reimplemented in Isis::ImageListActionWorkOrder.

Definition at line 258 of file WorkOrder.cpp.

References listenForImageDestruction(), and m_imageIds.

◆ setData() [7/11]

◆ setData() [8/11]

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

Definition at line 249 of file WorkOrder.cpp.

◆ setData() [9/11]

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

Sets the ShapeList data for this WorkOrder.

Parameters
imagesA pointer to the updated ShapeList.

Definition at line 271 of file WorkOrder.cpp.

References listenForShapeDestruction(), and m_shapeIds.

◆ setData() [10/11]

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

Sets the TargetBody data for this WorkOrder.

Parameters
targetBodyA QSharedPointer to the TargetBody.

Definition at line 314 of file WorkOrder.cpp.

References m_targetBody, and targetBody().

◆ setData() [11/11]

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

Sets the TargetBody data for this WorkOrder.

Parameters
targetBodyA QSharedPointer to the TargetBody.

Definition at line 323 of file WorkOrder.cpp.

References 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
dataThe data to set the internal data to.

Definition at line 1306 of file WorkOrder.cpp.

References m_internalData.

Referenced by Isis::ImageListActionWorkOrder::execute(), Isis::ImageListActionWorkOrder::ImageListActionWorkOrder(), Isis::ImportImagesWorkOrder::importConfirmedImages(), Isis::ImportShapesWorkOrder::importConfirmedShapes(), Isis::ImportMapTemplateWorkOrder::isExecutable(), Isis::ImportRegistrationTemplateWorkOrder::isExecutable(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::CubeDnViewWorkOrder::setupExecution(), Isis::ExportControlNetWorkOrder::setupExecution(), Isis::ExportImagesWorkOrder::setupExecution(), Isis::Footprint2DViewWorkOrder::setupExecution(), Isis::ImageFileListViewWorkOrder::setupExecution(), Isis::ImageListActionWorkOrder::setupExecution(), Isis::ImportControlNetWorkOrder::setupExecution(), Isis::ImportImagesWorkOrder::setupExecution(), Isis::ImportMapTemplateWorkOrder::setupExecution(), Isis::ImportRegistrationTemplateWorkOrder::setupExecution(), Isis::ImportShapesWorkOrder::setupExecution(), Isis::MatrixViewWorkOrder::setupExecution(), Isis::RenameProjectWorkOrder::setupExecution(), Isis::SaveProjectAsWorkOrder::setupExecution(), Isis::SensorGetInfoWorkOrder::setupExecution(), Isis::TargetGetInfoWorkOrder::setupExecution(), Isis::TemplateEditViewWorkOrder::setupExecution(), and Isis::ImageListActionWorkOrder::undoExecution().

◆ 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
changesProjectOnDiskTrue if this WorkOrder modifies the Project on disk. False if it does not.

Definition at line 1662 of file WorkOrder.cpp.

References 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
nextWorkOrderThe next WorkOrder.

Definition at line 601 of file WorkOrder.cpp.

References m_nextWorkOrder, and WorkOrder().

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

◆ setPrevious()

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

Sets the previous WorkOrder in the sequence.

Parameters
previousWorkOrderThe previous WorkOrder.

Definition at line 610 of file WorkOrder.cpp.

References m_previousWorkOrder, and WorkOrder().

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

◆ setProgressRange()

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

Sets the progress range of the WorkOrder.

Parameters
minValueThe progress range minimum value.
maxValueThe progress range maximum value.

Definition at line 1346 of file WorkOrder.cpp.

References m_progressRangeMaxValue, and 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 1532 of file WorkOrder.cpp.

References isRedone(), isUndone(), m_progressBar, and m_progressBarDeletionTimer.

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

◆ setProgressValue()

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

Sets the current progress value for the WorkOrder.

Parameters
intvalue The value to set the current progress to.

Definition at line 1356 of file WorkOrder.cpp.

References m_progressValue.

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

◆ setupExecution()

bool Isis::ViewControlNet3DWorkOrder::setupExecution ( )
virtual

Prompt user for any information need to display the control network.

Returns
bool True upon success, False otherwise.

Reimplemented from Isis::WorkOrder.

Definition at line 91 of file ViewControlNet3DWorkOrder.cpp.

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

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

Referenced by isExecutable(), redo(), setData(), and 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 714 of file WorkOrder.cpp.

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

◆ startRedo

void Isis::WorkOrder::startRedo ( )
privateslotinherited

WorkOrder::startRedo This function is currently empty.

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

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

◆ targetBody()

TargetBodyQsp Isis::WorkOrder::targetBody ( )
protectedinherited

◆ toString()

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

Gets the current status of the WorkOrder.

Parameters
statusAn enumeration of all possible WorkOrder states.
Returns
QString Returns a string representation of the current status of the WorkOrder.

Definition at line 997 of file WorkOrder.cpp.

References WorkOrderFinished.

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

◆ undo

void Isis::WorkOrder::undo ( )
virtualslotinherited

◆ undoExecution()

void Isis::ViewControlNet3DWorkOrder::undoExecution ( )
protectedvirtual

Deletes the last view.

Currently not implemented.

Reimplemented from Isis::WorkOrder.

Definition at line 133 of file ViewControlNet3DWorkOrder.cpp.

◆ updateProgress

void Isis::WorkOrder::updateProgress ( )
privateslotinherited

Updates the progress bar.

Definition at line 1627 of file WorkOrder.cpp.

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

Referenced by resetProgressBar().

Member Data Documentation

◆ m_context

Context Isis::WorkOrder::m_context
privateinherited

Definition at line 547 of file WorkOrder.h.

◆ m_controlList

QPointer<ControlList> Isis::WorkOrder::m_controlList
privateinherited

Definition at line 551 of file WorkOrder.h.

◆ m_correlationMatrix

CorrelationMatrix Isis::WorkOrder::m_correlationMatrix
privateinherited

Definition at line 552 of file WorkOrder.h.

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

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

◆ m_data

QString Isis::WorkOrder::m_data
privateinherited

Definition at line 548 of file WorkOrder.h.

◆ m_elapsedTimer

QElapsedTimer* Isis::WorkOrder::m_elapsedTimer
privateinherited

A QElapsedTimer object holding the excecution time of the WorkOrder.

Definition at line 651 of file WorkOrder.h.

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

◆ m_executionTime

QDateTime Isis::WorkOrder::m_executionTime
privateinherited

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

Definition at line 621 of file WorkOrder.h.

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

◆ m_fileItem

FileItemQsp Isis::WorkOrder::m_fileItem
privateinherited

A QSharedPointer to the FileItem.

Definition at line 577 of file WorkOrder.h.

Referenced by fileItem(), setData(), WorkOrder(), and 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 628 of file WorkOrder.h.

Referenced by redo(), undo(), WorkOrder(), WorkOrder(), and ~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 557 of file WorkOrder.h.

Referenced by guiCamera(), setData(), WorkOrder(), and 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 584 of file WorkOrder.h.

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

◆ m_imageList

QPointer<ImageList> Isis::WorkOrder::m_imageList
privateinherited

Definition at line 549 of file WorkOrder.h.

◆ m_internalData

QStringList Isis::WorkOrder::m_internalData
privateinherited

A QStringList of internal properties for this WorkOrder.

Definition at line 595 of file WorkOrder.h.

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

◆ m_isSavedToHistory

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

Referenced by Isis::ExportControlNetWorkOrder::ExportControlNetWorkOrder(), Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), Isis::ImportImagesWorkOrder::ImportImagesWorkOrder(), Isis::ImportShapesWorkOrder::ImportShapesWorkOrder(), isSynchronous(), WorkOrder(), and 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 497 of file WorkOrder.h.

Referenced by Isis::BundleObservationViewWorkOrder::BundleObservationViewWorkOrder(), Isis::BundleObservationViewWorkOrder::BundleObservationViewWorkOrder(), Isis::CloseProjectWorkOrder::CloseProjectWorkOrder(), Isis::ControlHealthMonitorWorkOrder::ControlHealthMonitorWorkOrder(), Isis::CubeDnViewWorkOrder::CubeDnViewWorkOrder(), Isis::ExportControlNetWorkOrder::ExportControlNetWorkOrder(), Isis::Footprint2DViewWorkOrder::Footprint2DViewWorkOrder(), Isis::Footprint2DViewWorkOrder::Footprint2DViewWorkOrder(), Isis::ImportControlNetWorkOrder::ImportControlNetWorkOrder(), Isis::ImportMapTemplateWorkOrder::ImportMapTemplateWorkOrder(), Isis::ImportRegistrationTemplateWorkOrder::ImportRegistrationTemplateWorkOrder(), Isis::ImportShapesWorkOrder::ImportShapesWorkOrder(), isUndoable(), Isis::JigsawWorkOrder::JigsawWorkOrder(), Isis::OpenProjectWorkOrder::OpenProjectWorkOrder(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::RenameProjectWorkOrder::RenameProjectWorkOrder(), Isis::SaveProjectAsWorkOrder::SaveProjectAsWorkOrder(), Isis::SensorGetInfoWorkOrder::SensorGetInfoWorkOrder(), Isis::SetActiveControlWorkOrder::SetActiveControlWorkOrder(), Isis::SetActiveImageListWorkOrder::SetActiveImageListWorkOrder(), Isis::TargetGetInfoWorkOrder::TargetGetInfoWorkOrder(), Isis::TemplateEditViewWorkOrder::TemplateEditViewWorkOrder(), WorkOrder(), and 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 530 of file WorkOrder.h.

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

◆ m_nextWorkOrder

QPointer<WorkOrder> Isis::WorkOrder::m_nextWorkOrder
privateinherited

A pointer to the next WorkOrder in the queue.

Definition at line 600 of file WorkOrder.h.

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

◆ m_previousWorkOrder

QPointer<WorkOrder> Isis::WorkOrder::m_previousWorkOrder
privateinherited

A pointer to the previous WorkOrder in the queue.

Definition at line 605 of file WorkOrder.h.

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

◆ m_progressBar

QPointer<ProgressBar> Isis::WorkOrder::m_progressBar
privateinherited

◆ m_progressBarDeletionTimer

QPointer<QTimer> Isis::WorkOrder::m_progressBarDeletionTimer
privateinherited

A pointer to the ProgressBar deletion timer.

Definition at line 645 of file WorkOrder.h.

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

◆ m_progressBarUpdateTimer

QPointer<QTimer> Isis::WorkOrder::m_progressBarUpdateTimer
privateinherited

A pointer to the QTimer which updates the ProgressBar.

Definition at line 640 of file WorkOrder.h.

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

◆ m_progressRangeMaxValue

int Isis::WorkOrder::m_progressRangeMaxValue
privateinherited

The maximum value of the Progess Bar.

Definition at line 541 of file WorkOrder.h.

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

◆ m_progressRangeMinValue

int Isis::WorkOrder::m_progressRangeMinValue
privateinherited

The miniumum value of the Progess Bar.

Definition at line 537 of file WorkOrder.h.

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

◆ m_progressValue

int Isis::WorkOrder::m_progressValue
privateinherited

The current value of the Progress Bar.

Definition at line 545 of file WorkOrder.h.

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

◆ m_project

QPointer<Project> Isis::WorkOrder::m_project
privateinherited

A pointer to the Project this WorkOrder is attached to.

Definition at line 610 of file WorkOrder.h.

Referenced by project(), WorkOrder(), WorkOrder(), and ~WorkOrder().

◆ m_queuedAction

QueuedWorkOrderAction Isis::WorkOrder::m_queuedAction
privateinherited

Definition at line 532 of file WorkOrder.h.

◆ m_secondsElapsed

double Isis::WorkOrder::m_secondsElapsed
privateinherited

The seconds that have elapsed since the WorkOrder started executing.

Definition at line 656 of file WorkOrder.h.

Referenced by executionFinished(), statusText(), WorkOrder(), and 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 590 of file WorkOrder.h.

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

◆ m_shapeList

QPointer<ShapeList> Isis::WorkOrder::m_shapeList
privateinherited

Definition at line 550 of file WorkOrder.h.

◆ m_status

WorkOrderStatus Isis::WorkOrder::m_status
protectedinherited

Definition at line 513 of file WorkOrder.h.

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

Referenced by setData(), targetBody(), WorkOrder(), and 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 564 of file WorkOrder.h.

Referenced by getTemplate(), setData(), WorkOrder(), and 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 616 of file WorkOrder.h.

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


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