PROG: Re-adding class TargetGetInfoWorkOrder (66f4ffdb) · Commits · aflab / astrogeology / ISIS3

isis/src/qisis/objs/Directory/TargetGetInfoWorkOrder.cpp

0 → 100644

+146 −0

Original line number	Diff line number	Diff line
		/**
		* @file
		* $Revision: 1.19 $
		* $Date: 2010/03/22 19:44:53 $
		*
		* Unless noted otherwise, the portions of Isis written by the USGS are
		* public domain. See individual third-party library and package descriptions
		* for intellectual property information, user agreements, and related
		* information.
		*
		* Although Isis has been used by the USGS, no warranty, expressed or
		* implied, is made by the USGS as to the accuracy and functioning of such
		* software and related material nor shall the fact of distribution
		* constitute any such warranty, and no responsibility is assumed by the
		* USGS in connection therewith.
		*
		* For additional information, launch
		* $ISISROOT/doc//documents/Disclaimers/Disclaimers.html
		* in a browser or see the Privacy & Disclaimers page on the Isis website,
		* http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
		* http://www.usgs.gov/privacy.html.
		*/
		#include "TargetGetInfoWorkOrder.h"

		#include <QFileDialog>
		#include <QInputDialog>
		#include <QtDebug>

		#include "Directory.h"
		#include "IException.h"
		#include "Project.h"
		#include "TargetBody.h"
		#include "TargetInfoWidget.h"

		namespace Isis {

		/**
		* @brief Creates a WorkOrder that will retrieve Target info.
		* @param project The Project that this work order should be interacting with.
		*/
		TargetGetInfoWorkOrder::TargetGetInfoWorkOrder(Project *project) :
		WorkOrder(project) {
		QAction::setText(tr("Get Info...") );
		}


		/**
		* @brief Copies the 'other' WorkOrdeer instance into this new instance.
		* @param other The WorkOrder being copied.
		*/
		TargetGetInfoWorkOrder::TargetGetInfoWorkOrder(const TargetGetInfoWorkOrder &other) :
		WorkOrder(other) {
		}


		/**
		* @brief The Destructor.
		*/
		TargetGetInfoWorkOrder::~TargetGetInfoWorkOrder() {
		}


		/**
		* @brief Returns a copy of this TargetGetInfoWorkOrder instance.
		* @return @b (TargetGetInfoWorkOrder *) A pointer to a copy of this WorkOrder.
		*/
		TargetGetInfoWorkOrder *TargetGetInfoWorkOrder::clone() const {
		return new TargetGetInfoWorkOrder(*this);
		}


		/**
		* @brief Determines if we already have a view for the target. If we do, then we
		* do not need to redisplay the object.
		* @param targetBody
		* @return @b bool True if a view already exists, False otherwise.
		*/
		bool TargetGetInfoWorkOrder::isExecutable(TargetBodyQsp targetBody) {
		if (!targetBody)
		return false;

		// if we already have a view for this target, don't redisplay
		QList<TargetInfoWidget *> existingViews = project()->directory()->targetInfoViews();
		for (int i = 0; i < existingViews.size(); i++) {
		if (existingViews.at(i)->objectName() == targetBody->displayProperties()->displayName() )
		return false;
		}

		return true;
		}


		/**
		* @brief Attempt to retrieve the Target info and view it.
		* @return @b bool True if successful, False otherwise.
		*/
		bool TargetGetInfoWorkOrder::execute() {
		bool success = WorkOrder::execute();

		if (success) {
		QString targetDisplayName = targetBody()->displayProperties()->displayName();
		QUndoCommand::setText(tr("Get %1 target info").arg(targetDisplayName));

		QStringList internalData;
		internalData.append(targetDisplayName);
		setInternalData(internalData);
		}

		return success;
		}


		/**
		* @brief Determines whether another WorkOrder depends upon TargetGetInfoWorkOrder.
		* @param other The WorkOrder being checked for dependency.
		* @return @b bool True if there is a dependency, False otherwise.
		*/
		bool TargetGetInfoWorkOrder::dependsOn(WorkOrder *other) const {
		// depend on types of ourselves.
		return dynamic_cast<TargetGetInfoWorkOrder *>(other);
		}


		/**
		* @brief Redisplays the Target info.
		*/
		void TargetGetInfoWorkOrder::syncRedo() {
		TargetInfoWidget *targetInfoWidget =
		project()->directory()->addTargetInfoView(targetBody());


		if (!targetInfoWidget) {
		QString msg = "error displaying target info";
		throw IException(IException::Programmer, msg, _FILEINFO_);
		}
		}


		/**
		* @brief Deletes the last view. Currently this function is not implemented.
		*/
		void TargetGetInfoWorkOrder::syncUndo() {
		//delete project()->directory()->cnetEditorViews().last();
		}
		}

isis/src/qisis/objs/Directory/TargetGetInfoWorkOrder.h

0 → 100644

+65 −0

Original line number	Diff line number	Diff line
		#ifndef TargetGetInfoWorkOrder_H
		#define TargetGetInfoWorkOrder_H
		/**
		* @file
		* $Revision: 1.19 $
		* $Date: 2010/03/22 19:44:53 $
		*
		* Unless noted otherwise, the portions of Isis written by the USGS are
		* public domain. See individual third-party library and package descriptions
		* for intellectual property information, user agreements, and related
		* information.
		*
		* Although Isis has been used by the USGS, no warranty, expressed or
		* implied, is made by the USGS as to the accuracy and functioning of such
		* software and related material nor shall the fact of distribution
		* constitute any such warranty, and no responsibility is assumed by the
		* USGS in connection therewith.
		*
		* For additional information, launch
		* $ISISROOT/doc//documents/Disclaimers/Disclaimers.html
		* in a browser or see the Privacy & Disclaimers page on the Isis website,
		* http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
		* http://www.usgs.gov/privacy.html.
		*/
		#include "WorkOrder.h"

		namespace Isis {
		class TargetBody;

		/**
		* @brief This is a child of class WorkOrder which is used for anything that performs
		* an action in a Project. This work order allows the user to view target body info.
		*
		* @author 2015-06-12 Ken Edmundson
		*
		* @internal
		* @author 2016-06-06 Tyler Wilson - Added documentation for the functions and
		* brought the code into compliance with ISIS3 coding standards.
		* References #3944.
		*
		*/

		class TargetGetInfoWorkOrder : public WorkOrder {
		Q_OBJECT
		public:
		TargetGetInfoWorkOrder(Project *project);
		TargetGetInfoWorkOrder(const TargetGetInfoWorkOrder &other);
		~TargetGetInfoWorkOrder();

		virtual TargetGetInfoWorkOrder *clone() const;

		virtual bool isExecutable(TargetBodyQsp targetBody);
		bool execute();

		protected:
		bool dependsOn(WorkOrder *other) const;
		void syncRedo();
		void syncUndo();

		private:
		TargetGetInfoWorkOrder &operator=(const TargetGetInfoWorkOrder &rhs);
		};
		}
		#endif