PROG: Re-adding class SensorGetInfoWorkOrder (b4b005d7) · Commits · aflab / astrogeology / ISIS3

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

0 → 100644

+152 −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 "SensorGetInfoWorkOrder.h"

		#include <QtDebug>

		#include <QFileDialog>
		#include <QInputDialog>

		#include "Directory.h"
		#include "IException.h"
		#include "Project.h"
		#include "GuiCamera.h"
		#include "SensorInfoWidget.h"

		namespace Isis {

		/**
		* @brief Constructor that creates a WorkOrder that will retrieve target body info.
		* @param project The Project that this WorkOrder should be interacting with.
		*
		*/
		SensorGetInfoWorkOrder::SensorGetInfoWorkOrder(Project *project) :
		WorkOrder(project) {
		QAction::setText(tr("Get Info...") );
		}


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


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


		/**
		* @brief Returns a copy of the current instance of this WorkOrder.
		* @return @b (SensorGetInfoWorkOrder *) A copy of this object.
		*/
		SensorGetInfoWorkOrder *SensorGetInfoWorkOrder::clone() const {
		return new SensorGetInfoWorkOrder(*this);
		}


		/**
		* @brief Determines if this WorkOrder can be executed. It does this by determining
		* if we already have a view for this camera. If we do, then do not
		* redisplay the view, and return false.
		*
		* @param guiCamera A Camera object contained within a Project.
		* @return @b bool Return True if we we already have a view for the guiCamera object.
		* Return False otherwise.
		*/
		bool SensorGetInfoWorkOrder::isExecutable(GuiCameraQsp guiCamera) {
		if (!guiCamera)
		return false;

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

		return true;
		}


		/**
		* @brief Attempts to retrieve target body info from the camera and display it
		* in a view.
		* @return @b bool True if successful, False if not.
		*/
		bool SensorGetInfoWorkOrder::execute() {
		bool success = WorkOrder::execute();

		if (success) {
		QString sensorDisplayName = guiCamera()->displayProperties()->displayName();
		QUndoCommand::setText(tr("Get %1 sensor info").arg(sensorDisplayName) );

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

		return success;
		}


		/**
		* @brief Determines whether a WorkOrder depends upon SensorGetInfoWorkerOrder
		* @param other The work order being checked for dependency.
		* @return @b bool True if dependent, False if not
		*/
		bool SensorGetInfoWorkOrder::dependsOn(WorkOrder *other) const {
		// depend on types of ourselves.
		return dynamic_cast<SensorGetInfoWorkOrder *>(other);
		}


		/**
		* @brief Redisplays the sensor view.
		*/
		void SensorGetInfoWorkOrder::syncRedo() {
		SensorInfoWidget *sensorInfoWidget =
		project()->directory()->addSensorInfoView(guiCamera() );


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


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

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

0 → 100644

+64 −0

Original line number	Diff line number	Diff line
		#ifndef SensorGetInfoWorkOrder_H
		#define SensorGetInfoWorkOrder_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 GuiCamera;

		/**
		* @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-07-10 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 SensorGetInfoWorkOrder : public WorkOrder {
		Q_OBJECT
		public:
		SensorGetInfoWorkOrder(Project *project);
		SensorGetInfoWorkOrder(const SensorGetInfoWorkOrder &other);
		~SensorGetInfoWorkOrder();

		virtual SensorGetInfoWorkOrder *clone() const;

		virtual bool isExecutable(GuiCameraQsp camera);
		bool execute();

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

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