Updated documentation of Footprint2DWorkOrder. Fixes #3954. (4d0f9129) · Commits · aflab / astrogeology / ISIS3

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

+39 −8

Original line number	Diff line number	Diff line
		@@ -36,28 +36,46 @@

		namespace Isis {

		/**
		* Constrictor. This method sets the text of the project to View Footprints.
		*
		* @param project Current project
		*/
		Footprint2DViewWorkOrder::Footprint2DViewWorkOrder(Project *project) :
		WorkOrder(project) {
		QAction::setText(tr("View &Footprints..."));
		}


		/**
		* This method has not been implemented.
		*/
		Footprint2DViewWorkOrder::Footprint2DViewWorkOrder(const Footprint2DViewWorkOrder &other) :
		WorkOrder(other) {
		}


		/**
		* Destructor
		*/
		Footprint2DViewWorkOrder::~Footprint2DViewWorkOrder() {
		}


		/**
		* This method clones the current Footprint2DViewWorkOrder and returns it.
		*
		* @return @b Footprint2DViewWorkOrder that was cloned
		*/
		Footprint2DViewWorkOrder *Footprint2DViewWorkOrder::clone() const {

		return new Footprint2DViewWorkOrder(*this);

		}


		/**
		* This method returns true if one of an image in ImageList images isFootprintable.
		*
		* @param images ImageList of images
		*
		* @return @b bool True if one of the images in ImagesList images isFootprintable
		*/
		bool Footprint2DViewWorkOrder::isExecutable(ImageList *images) {
		bool result = false;

		@@ -68,19 +86,32 @@ namespace Isis {
		return result;
		}


		/**
		* This method calls WorkOrder's execute.
		*
		* @return @b bool True if WorkOrder::execute() returns true.
		*/
		bool Footprint2DViewWorkOrder::execute() {
		bool success = WorkOrder::execute();
		return success;
		}


		/**
		* This method returns whether or not other depends on a Footprint2DViewWorkOrder.
		*
		* @param other WorkOrder that we are checking for dependencies
		*
		* @return @b bool True if other depends on a Footprint2DViewWorkOrder
		*/
		bool Footprint2DViewWorkOrder::dependsOn(WorkOrder *other) const {
		// depend on types of ourselves.
		return dynamic_cast<Footprint2DViewWorkOrder *>(other);
		}


		/**
		* This methods adds the current item to Footprint2DView.
		*
		*/
		void Footprint2DViewWorkOrder::syncRedo() {
		ProjectItem *currentItem = project()->directory()->model()->currentItem();
		Footprint2DView *view = project()->directory()->addFootprint2DView();

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

+3 −1

Original line number	Diff line number	Diff line
		@@ -32,7 +32,9 @@ namespace Isis {
		* @author 2012-??-?? ???
		*
		* @internal
		* @history 2016-01-08 Jeffrey Covington - Updated for new Footprint2DView
		* @history 2016-01-08 Jeffrey Covington - Updated for new Footprint2DView, syncUndo()
		* was removed, and execute now uses WorkOrder's execute() method
		* @history 2016-06-06 Makayla Shepherd - Updated documentation. Fixes #3954.
		*/
		class Footprint2DViewWorkOrder : public WorkOrder {
		Q_OBJECT