Change the project's GUI name. More...

#include <RenameProjectWorkOrder.h>

Inheritance diagram for Isis::RenameProjectWorkOrder:

Collaboration diagram for Isis::RenameProjectWorkOrder:

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
	RenameProjectWorkOrder (QString newName, Project *project)
	Creates a work order to rename the project using the given new project name. More...

	RenameProjectWorkOrder (Project *project)
	Creates a work order to rename the project. More...

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

	~RenameProjectWorkOrder ()
	Destructor. More...

virtual RenameProjectWorkOrder *	clone () const
	This method clones the current RenameProjectWorkOrder and returns it. More...

virtual bool	isExecutable (Context context)
	This method returns true if the user clicked on the project name on the project tree, or selected "Rename Project" from the Project menu, otherwise False. More...

virtual bool	setupExecution ()
	Setup this WorkOrder for execution. More...

virtual void	execute ()
	This will rename the project. More...

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

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

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

virtual bool	isExecutable (CorrelationMatrix)

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

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

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

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

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

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

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

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

virtual void	setData (QString data)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static bool	isNameValid (QString nameToCheck)
	Check the validity of the given (proposed) project name. More...

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 ()
	Changes the project name back to the old name. More...

bool	dependsOn (WorkOrder *other) const
	This WorkOrder is only dependent on another RenameProjectWorkOrder. 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...

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

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

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

void	setModifiesDiskState (bool changesProjectOnDisk)

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

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

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

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

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

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

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

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

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

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

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

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

WorkOrderStatus	m_status

Detailed Description

Change the project's GUI name.

Author: 2012-11-20 Steven Lambright

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

Enumerator
NoContext
ProjectContext

◆ WorkOrderStatus

enum Isis::WorkOrder::WorkOrderStatus

inherited

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

Enumerator
WorkOrderUnknownStatus
WorkOrderNotStarted
WorkOrderRedoing
WorkOrderRedone
WorkOrderUndoing
WorkOrderUndone
WorkOrderFinished	This is used for work orders that will not undo or redo (See createsCleanState())
WorkOrderLastStatus

Constructor & Destructor Documentation

◆ RenameProjectWorkOrder() [1/3]

Isis::RenameProjectWorkOrder::RenameProjectWorkOrder	(	QString	newName,
		Project *	project
	)

Creates a work order to rename the project using the given new project name.

This constructor is only called if user double-clicks the project name on the project tree. This WorkOrder is undoable and runs synchronously.

Parameters

QString	newName New project name
Project	*project Pointer to the project this work order belongs to.

References Isis::WorkOrder::internalData(), Isis::WorkOrder::m_isUndoable, Isis::Project::name(), Isis::WorkOrder::project(), and Isis::WorkOrder::setInternalData().

Referenced by clone().

◆ RenameProjectWorkOrder() [2/3]

Isis::RenameProjectWorkOrder::RenameProjectWorkOrder ( Project * project )

Creates a work order to rename the project.

This WorkOrder is undoable and runs synchronously.

Parameters

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

References Isis::WorkOrder::m_isUndoable.

◆ RenameProjectWorkOrder() [3/3]

Isis::RenameProjectWorkOrder::RenameProjectWorkOrder ( const RenameProjectWorkOrder & other )

Copy constructor.

Creates a copy of the other RenameProjectWorkOrder.

Parameters

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

References Isis::WorkOrder::m_isUndoable.

◆ ~RenameProjectWorkOrder()

Isis::RenameProjectWorkOrder::~RenameProjectWorkOrder ( )

Destructor.

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

Member Function Documentation

◆ addCloneToProject

void Isis::WorkOrder::addCloneToProject ( )

protectedslotinherited

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

References Isis::Project::addToProject(), Isis::WorkOrder::clone(), 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.

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

◆ clone()

RenameProjectWorkOrder * Isis::RenameProjectWorkOrder::clone ( ) const

virtual

This method clones the current RenameProjectWorkOrder and returns it.

Returns: Footprint2DViewWorkOrder that was cloned

Implements Isis::WorkOrder.

References RenameProjectWorkOrder().

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

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.

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.

References Isis::WorkOrder::project().

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

◆ creatingProgress

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

signalinherited

◆ deletingProgress

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

signalinherited

◆ dependsOn()

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

protectedvirtual

This WorkOrder is only dependent on another RenameProjectWorkOrder.

It cannot be run if another RenameProjectWorkOrder is currently being executed.

Parameters

other The WorkOrder being checked for dependency.

Returns: bool True if there is the other WorkOrder is another RenameProjectWorkOrder, False otherwise.

Reimplemented from Isis::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.

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

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

◆ execute()

void Isis::RenameProjectWorkOrder::execute ( )

virtual

This will rename the project.

Reimplemented from Isis::WorkOrder.

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

◆ executionTime()

QDateTime Isis::WorkOrder::executionTime ( ) const

inherited

Gets the execution time of this WorkOrder.

Returns: QDateTime The execution time.

References Isis::WorkOrder::project().

◆ fileItem()

FileItemQsp Isis::WorkOrder::fileItem ( )

protectedinherited

WorkOrder::fileItem.

Returns: QSharedPointer Returns a shared pointer to the fileItem.

References Isis::WorkOrder::project().

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

◆ finished

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

signalinherited

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

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

References Isis::WorkOrder::toString(), Isis::WorkOrder::WorkOrderLastStatus, and Isis::WorkOrder::WorkOrderUnknownStatus.

◆ getTemplate()

Template * Isis::WorkOrder::getTemplate ( )

protectedinherited

WorkOrder::getTemplate.

Returns: QSharedPointer Returns a shared pointer to the Template.

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

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

References Isis::Project::image(), 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.

References Isis::WorkOrder::imageList().

◆ internalData()

QStringList Isis::WorkOrder::internalData ( ) const

protectedinherited

Gets the internal data for this WorkOrder.

Returns: QStringList Returns the internal data object.

References Isis::WorkOrder::project().

◆ isExecutable() [1/10]

bool Isis::RenameProjectWorkOrder::isExecutable ( Context context )

virtual

This method returns true if the user clicked on the project name on the project tree, or selected "Rename Project" from the Project menu, otherwise False.

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

Parameters

Context context This indicates whether this WorkOrder is part of a Project. Context is an enum defined in WorkOrder with two possible values: NoContext,ProjectContext.

Returns: bool True if user selected

Reimplemented from Isis::WorkOrder.

References Isis::WorkOrder::ProjectContext.

◆ isExecutable() [2/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

images An image list that this work order should execute on

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

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

◆ isExecutable() [3/10]

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

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.

◆ isExecutable() [4/10]

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.

◆ isExecutable() [5/10]

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

virtualinherited

Reimplemented in Isis::MatrixViewWorkOrder.

◆ isExecutable() [6/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

controls A list of control networks.

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

Reimplemented in Isis::TargetGetInfoWorkOrder.

◆ isExecutable() [7/10]

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

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.

◆ isExecutable() [8/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.

◆ isExecutable() [9/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.

◆ isExecutable() [10/10]

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

virtualinherited

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

Parameters

item	(ProjectItem *) The item containing the data.

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

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

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

References Isis::WorkOrder::m_status, and Isis::WorkOrder::WorkOrderFinished.

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

◆ isNameValid()

bool Isis::RenameProjectWorkOrder::isNameValid ( QString nameToCheck )

static

Check the validity of the given (proposed) project name.

Returns true if it's acceptable, false otherwise.

Referenced by setupExecution().

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

References Isis::WorkOrder::m_status, Isis::WorkOrder::project(), and Isis::WorkOrder::WorkOrderRedoing.

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

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

References Isis::WorkOrder::m_status, Isis::WorkOrder::project(), and Isis::WorkOrder::WorkOrderRedone.

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

◆ 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

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

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.

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

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

References Isis::WorkOrder::m_status, Isis::WorkOrder::project(), and Isis::WorkOrder::WorkOrderUndoing.

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

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

References Isis::WorkOrder::m_status, Isis::WorkOrder::project(), and Isis::WorkOrder::WorkOrderUndone.

Referenced by Isis::Project::lastNotUndoneWorkOrder(), 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.

References Isis::WorkOrder::project().

◆ next()

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

inherited

Gets the next WorkOrder.

Returns: QPointer pointing to the next WorkOrder.

References Isis::WorkOrder::project().

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

◆ postExecution()

void Isis::WorkOrder::postExecution ( )

protectedvirtualinherited

Perform any necessary actions after execution of a workorder.

State can be read from the parent WorkOrder class and from state set in either synchronous() or asyncRedo() while in this method. You can not set state to be used in any of the undo code safely. This method is always executed in the GUI thread and has no progress.

Reimplemented in Isis::ImportImagesWorkOrder, Isis::ImportControlNetWorkOrder, Isis::ImportShapesWorkOrder, Isis::ExportControlNetWorkOrder, and Isis::ExportImagesWorkOrder.

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

◆ previous()

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

inherited

Gets the previous WorkOrder.

Returns: QPointer pointing to the previous WorkOrder.

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

References Isis::WorkOrder::project().

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

◆ progressMax()

int Isis::WorkOrder::progressMax ( ) const

protectedinherited

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

Returns: int The maximum value.

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

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

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

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

◆ read()

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

inherited

Read this work order's data from disk.

References Isis::XmlStackedHandlerReader::pushContentHandler().

◆ redo

void Isis::WorkOrder::redo ( )

virtualslotinherited

Starts (or enqueues) a redo.

This should not be re-implemented by children.

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

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

◆ 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

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

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

References Isis::WorkOrder::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

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

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

◆ setData() [2/11]

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

virtualinherited

◆ setData() [3/11]

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.

◆ setData() [4/11]

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

virtualinherited

Sets the ShapeList data for this WorkOrder.

Parameters

images A pointer to the updated ShapeList.

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

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.

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

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

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

◆ setNext()

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

inherited

Sets the next WorkOrder in the sequence.

Parameters

nextWorkOrder The next WorkOrder.

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.

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.

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

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

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

◆ setupExecution()

bool Isis::RenameProjectWorkOrder::setupExecution ( )

virtual

Setup this WorkOrder for execution.

Prompt for new project name and make sure it is a valid directory location. This calls WorkOrder::setupExecution().

Returns: bool True if WorkOrder::execute() returns true and footprints can be created, otherwise returns False.

Reimplemented from Isis::WorkOrder.

References Isis::WorkOrder::internalData(), isNameValid(), Isis::Project::name(), Isis::WorkOrder::project(), Isis::WorkOrder::setInternalData(), and Isis::WorkOrder::setupExecution().

◆ shapeList() [1/2]

ShapeList * Isis::WorkOrder::shapeList ( )

protectedinherited

a pointer to the ShapeList for this WorkOrder.

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

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

References Isis::WorkOrder::shapeList().

◆ statusChanged

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

signalinherited

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

◆ statusText()

QString Isis::WorkOrder::statusText ( ) const

inherited

WorkOrder::statusText.

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

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

◆ targetBody()

TargetBodyQsp Isis::WorkOrder::targetBody ( )

protectedinherited

WorkOrder::targetBody.

Returns: QSharedPointer Returns a shared pointer to the TargetBody.

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

References Isis::WorkOrder::WorkOrderFinished, Isis::WorkOrder::WorkOrderNotStarted, Isis::WorkOrder::WorkOrderRedoing, Isis::WorkOrder::WorkOrderRedone, Isis::WorkOrder::WorkOrderUndoing, Isis::WorkOrder::WorkOrderUndone, and Isis::WorkOrder::WorkOrderUnknownStatus.

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.

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

◆ undoExecution()

void Isis::RenameProjectWorkOrder::undoExecution ( )

protectedvirtual

Changes the project name back to the old name.

This will undo this WorkOrder's execute by renaming the project back to the old name. The old name was saved in the first internal data value.

See also: WorkOrder::undoExecution()

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

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

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

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Context

◆ WorkOrderStatus

Constructor & Destructor Documentation

◆ RenameProjectWorkOrder() [1/3]

◆ RenameProjectWorkOrder() [2/3]

◆ RenameProjectWorkOrder() [3/3]

◆ ~RenameProjectWorkOrder()

Member Function Documentation

◆ addCloneToProject

◆ bestText()

◆ clone()

◆ controlList()

◆ correlationMatrix()

◆ createsCleanState()

◆ creatingProgress

◆ deletingProgress

◆ dependsOn()

◆ directory()

◆ disableWorkOrder

◆ enableWorkOrder

◆ execute()

◆ executionTime()

◆ fileItem()

◆ finished

◆ fromStatusString()

◆ getTemplate()

◆ guiCamera()

◆ imageList() [1/2]

◆ imageList() [2/2]

◆ internalData()

◆ isExecutable() [1/10]

◆ isExecutable() [2/10]

◆ isExecutable() [3/10]

◆ isExecutable() [4/10]

◆ isExecutable() [5/10]

◆ isExecutable() [6/10]

◆ isExecutable() [7/10]

◆ isExecutable() [8/10]

◆ isExecutable() [9/10]

◆ isExecutable() [10/10]

◆ isFinished()

◆ isNameValid()

◆ isRedoing()

◆ isRedone()

◆ isSavedToHistory()

◆ isSynchronous()

◆ isUndoable()

◆ isUndoing()

◆ isUndone()

◆ modifiesDiskState()

◆ next()

◆ postExecution()

◆ postUndoExecution()

◆ previous()

◆ progressBar()

◆ progressMax()

◆ progressMin()

◆ progressValue()

◆ project()

◆ read()

◆ redo

◆ save()

◆ setCreatesCleanState()

◆ setData() [1/11]

◆ setData() [2/11]

◆ setData() [3/11]

◆ setData() [4/11]

◆ setData() [5/11]

◆ setData() [6/11]

◆ setData() [7/11]