Updated documentation for the BundleImage class in preparation for merging... (aa155fbd) · Commits · aflab / astrogeology / ISIS3

isis/src/control/objs/BundleUtilities/BundleImage.cpp

+53 −22

Original line number	Diff line number	Diff line
		@@ -7,7 +7,12 @@ namespace Isis {


		/**
		* constructor
		* Constructs a BundleImage with the given camera pointer, serial number, and filename.
		* Parent observation defaults to NULL.
		*
		* @param camera The camera model for the BundleImage
		* @param serialNumber The serial number for the BundleImage
		* @param fileName The file name for the BundleImage
		*/
		BundleImage::BundleImage(Camera *camera, QString serialNumber, QString fileName) {
		m_camera = camera;
		@@ -16,64 +21,90 @@ namespace Isis {
		}



		/**
		* copy constructor
		* Constructs a BundleImage from another BundleImage object.
		*
		* @param other The BundleImage to copy from.
		*/
		BundleImage::BundleImage(const BundleImage &src) {
		m_camera = src.m_camera;
		m_parentObservation = src.m_parentObservation;
		m_serialNumber = src.m_serialNumber;
		m_fileName = src.m_fileName;
		BundleImage::BundleImage(const BundleImage &other) {
		m_camera = other.m_camera;
		m_parentObservation = other.m_parentObservation;
		m_serialNumber = other.m_serialNumber;
		m_fileName = other.m_fileName;
		}



		/**
		* destructor
		* Destroys a BundleImage object.
		*/
		BundleImage::~BundleImage() {
		}



		BundleImage &BundleImage::operator=(const BundleImage &src) {
		if (&src != this) {
		m_camera = src.m_camera;
		m_parentObservation = src.m_parentObservation;
		m_serialNumber = src.m_serialNumber;
		m_fileName = src.m_fileName;
		/**
		* An assignment operator to set this BundleImage to another BundleImage object.
		*
		* @param other The BundleImage to copy from.
		*
		* @return @b BundleImage& A reference to this BundleImage after being assigned to.
		*/
		BundleImage &BundleImage::operator=(const BundleImage &other) {
		if (&other != this) {
		m_camera = other.m_camera;
		m_parentObservation = other.m_parentObservation;
		m_serialNumber = other.m_serialNumber;
		m_fileName = other.m_fileName;
		}
		return *this;
		}



		/**
		* Sets the parent BundleObservation object.
		*
		* @param parentObservation The parent BundleObservation.
		*/
		void BundleImage::setParentObservation(QSharedPointer<BundleObservation> parentObservation) {

		m_parentObservation = parentObservation;
		}



		/**
		* Returns the camera model used for the BundleImage.
		*
		* @return @b Camera* A pointer to the camera model.
		*/
		Camera *BundleImage::camera() {
		return m_camera;
		}



		/**
		* Returns the parent BundleObservation object.
		*
		* @return @b QSharedPointer<BundleObservation> A pointer to the parent BundleObservation.
		*/
		QSharedPointer<BundleObservation> BundleImage::parentObservation() {
		return m_parentObservation;
		}



		/**
		* Returns the serial number for the BundleImage.
		*
		* @return @b QString The image's serial number.
		*/
		QString BundleImage::serialNumber() {
		return m_serialNumber;
		}



		/**
		* Returns the file name for the BundleImage.
		*
		* @return @b QString The image's file name.
		*/
		QString BundleImage::fileName() {
		return m_fileName;
		}

isis/src/control/objs/BundleUtilities/BundleImage.h

+8 −7

Original line number	Diff line number	Diff line
		@@ -27,8 +27,6 @@
		#include <QObject>
		#include <QSharedPointer>

		#include "SerialNumber.h"

		namespace Isis {

		class BundleObservation;
		@@ -44,6 +42,8 @@ namespace Isis {
		* @history 2014-07-17 Kimberly Oyama - Updated to better meet coding standards.
		* @history 2014-02-20 Jeannie Backer - Added assignment operator. Updated
		* to better meet coding standards.
		* @history 2016-06-27 Jesse Mapel - Updated documentation in preparation
		* for merging from IPCE to ISIS. Fixes #4076.
		* @history 2016-08-03 Jesse Mapel - Changed parent observation to a QSharedPointer.
		* Fixes #4150.
		*
		@@ -57,12 +57,12 @@ namespace Isis {
		BundleImage(Camera *camera, QString serialNumber, QString fileName);

		// copy constructor
		BundleImage(const BundleImage &src);
		BundleImage(const BundleImage &other);

		// destructor
		~BundleImage();

		BundleImage &operator=(const BundleImage &src);
		BundleImage &operator=(const BundleImage &other);

		// mutators
		void setParentObservation(QSharedPointer<BundleObservation> parentObservation);
		@@ -74,12 +74,13 @@ namespace Isis {
		QString fileName();

		private:
		Camera *m_camera;
		Camera *m_camera; //!< The camera model for the image
		QSharedPointer<BundleObservation> m_parentObservation; //!< parent BundleObservation
		QString m_serialNumber;
		QString m_fileName;
		QString m_serialNumber; //!< The serial number for the image
		QString m_fileName; //!< The file name of the image
		};

		//!< Definition for a BundleImageQsp, a shared pointer to a BundleImage.
		typedef QSharedPointer<BundleImage> BundleImageQsp;
		}

isis/src/control/objs/BundleUtilities/BundleUtilities.truth

+4 −3

Original line number	Diff line number	Diff line
		@@ -829,6 +829,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

		XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
		Testing BundleMeasure...
		PROGRAMMER ERROR In BundleMeasure::observationSolveSettings: parent observation has not been set.
		parent control point id "FixedPoint"

		rejected? "No"
		@@ -837,7 +838,7 @@ measure line "2.0"
		measure serial number "NotIgnored"
		focal x "-1.79769313486231e+308"
		focal y "-1.79769313486231e+308"
		observation index "0"
		observation index "-1"

		rejected? "No"
		measure sample "1.0"
		@@ -845,7 +846,7 @@ measure line "2.0"
		measure serial number "NotIgnored"
		focal x "-1.79769313486231e+308"
		focal y "-1.79769313486231e+308"
		observation index "0"
		observation index "-1"

		rejected? "No"
		measure sample "1.0"
		@@ -853,7 +854,7 @@ measure line "2.0"
		measure serial number "NotIgnored"
		focal x "-1.79769313486231e+308"
		focal y "-1.79769313486231e+308"
		observation index "0"
		observation index "-1"

		XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX