Improved ControlPointV0001 documentation (ae7aeea5) · Commits · aflab / astrogeology / ISIS3

isis/src/control/objs/ControlNetVersioner/ControlPointV0001.cpp

+7 −7

Original line number	Diff line number	Diff line
		@@ -33,7 +33,7 @@ namespace Isis {
		* Create a ControlPointV0001 object from a version 1 control point Pvl object
		*
		* @param pointObject The control point and its measures in a Pvl object
		* @param targetName The name of the taret used to get the body radii when converting from
		* @param targetName The name of the target used to get the body radii when converting from
		* lat/lon to x/y/z.
		*/
		ControlPointV0001::ControlPointV0001(PvlObject &pointObject, const QString targetName)
		@@ -457,7 +457,7 @@ namespace Isis {

		/**
		* This convenience method takes a boolean value from a PvlKeyword and copies it into a version 1
		* protobuf field.
		* protobuf field. Once copied, the PvlKeyword is deleted.
		*
		* If the keyword doesn't exist, this does nothing.
		*
		@@ -488,7 +488,7 @@ namespace Isis {

		/**
		* This convenience method takes a double value from a PvlKeyword and copies it into a version 1
		* protobuf field.
		* protobuf field. Once copied, the PvlKeyword is deleted.
		*
		* If the keyword doesn't exist, this does nothing.
		*
		@@ -516,7 +516,7 @@ namespace Isis {

		/**
		* This convenience method takes a string value from a PvlKeyword and copies it into a version 1
		* protobuf field.
		* protobuf field. Once copied, the PvlKeyword is deleted.
		*
		* If the keyword doesn't exist, this does nothing.
		*
		@@ -544,7 +544,7 @@ namespace Isis {

		/**
		* This convenience method takes a boolean value from a PvlKeyword and copies it into a version 1
		* protobuf field.
		* protobuf field. Once copied, the PvlKeyword is deleted.
		*
		* If the keyword doesn't exist, this does nothing.
		*
		@@ -575,7 +575,7 @@ namespace Isis {

		/**
		* This convenience method takes a double value from a PvlKeyword and copies it into a version 1
		* protobuf field.
		* protobuf field. Once copied, the PvlKeyword is deleted.
		*
		* If the keyword doesn't exist, this does nothing.
		*
		@@ -603,7 +603,7 @@ namespace Isis {

		/**
		* This convenience method takes a string value from a PvlKeyword and copies it into a version 1
		* protobuf field.
		* protobuf field. Once copied, the PvlKeyword is deleted.
		*
		* If the keyword doesn't exist, this does nothing.
		*

isis/src/control/objs/ControlNetVersioner/ControlPointV0001.h

+17 −1

Original line number	Diff line number	Diff line
		@@ -30,7 +30,23 @@
		namespace Isis {
		class PvlObject;
		class PvlContainer;

		/**
		* @breif A container for the information stored in a version 1 ControlPoint.
		*
		* A wrapper around the version 1 protobuf serialization of a ControlPoint. It allows for reading
		* ControlPoints serialized as both PvlObjects and protobuf messages. In order to simplify the
		* upgrade process from version 1 to version 2, the data is always stored in a protobuf message
		* after being read.
		*
		* @ingroup ControlNetwork
		*
		* @author 2017-12-18 Jesse Mapel
		*
		* @internal
		* @history 2017-12-18 Jesse Mapel - Original version.
		* @history 2017-12-21 Adam Goins - Changed Pvl constructor to take PvlObject.
		* @history 2017-12-21 Jesse Mapel - Improved documentation.
		*/
		class ControlPointV0001 {
		public:
		ControlPointV0001(PvlObject &pointObject, const QString targetName);