PROG: Fixed ProcessExportPds4 documentation. Fixes #5167. (aff785d9) · Commits · aflab / astrogeology / ISIS3

isis/src/base/objs/ProcessExportPds4/ProcessExportPds4.cpp

+20 −6

Original line number	Diff line number	Diff line
		@@ -62,6 +62,11 @@ namespace Isis {
		}


		/**
		* Create a standard PDS4 image label from the input cube.
		*
		* @return @b QDomDocument The output PDS4 label.
		*/
		QDomDocument &ProcessExportPds4::StandardPds4Label() {
		if (InputCubes.size() == 0) {
		QString msg("Must set an input cube before creating a PDS4 label.");
		@@ -84,7 +89,8 @@ namespace Isis {


		/**
		* Create a standard PDS label for type IMAGE
		* Create a standard PDS label for type IMAGE. The image label will be
		* stored internally in the class.
		*/
		void ProcessExportPds4::CreateImageLabel() {

		@@ -97,7 +103,9 @@ namespace Isis {


		/**
		* This method corrects the Image Root information in a PDS4 output label.
		*
		* @note This method is not implemented currently and does nothing.
		*/
		void ProcessExportPds4::FixedImageRoot() {
		//Don't know what needs to go in here yet....
		@@ -111,7 +119,7 @@ namespace Isis {


		/**
		*
		* Create and internalize a standard image output label from the input image.
		*/
		void ProcessExportPds4::StandardImageImage() {

		@@ -155,7 +163,7 @@ namespace Isis {
		/**
		* Write the XML label to the supplied stream.
		*
		* @param Output file stream to which the XML label will be written.
		* @param[out] os file stream to which the XML label will be written.
		*/
		void ProcessExportPds4::OutputLabel(std::ofstream &os) {
		os << m_domDoc->toString() << endl;
		@@ -166,7 +174,7 @@ namespace Isis {
		* This method fills the image data of the PDS4 file using the parent class
		* ProcessExport::StartProcess.
		*
		* @param fout Output file stream to be filled with the PDS4 data.
		* @param[out] fout Output file stream to be filled with the PDS4 data.
		*
		*/
		void ProcessExportPds4::StartProcess(std::ofstream &fout) {
		@@ -174,6 +182,12 @@ namespace Isis {
		}


		/**
		* Return the internalized PDS4 label. If no label is internalized yet, an
		* empty label will be returned.
		*
		* @return @b QDomDocument The PDS4 Xml label
		*/
		QDomDocument &ProcessExportPds4::GetLabel() {
		if (m_domDoc->documentElement().isNull()) {
		QDomElement root = m_domDoc->createElement("Product_Observational");

isis/src/base/objs/ProcessExportPds4/ProcessExportPds4.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -47,6 +47,7 @@ namespace Isis {
		* @history 2017-06-04 Adam Paquette - Added GetLabel function and updated StandardPds4Label.
		* @history 2017-06-08 Marjorie Hahn - Added WritePds4 method to write out the
		* .img and .xml Pds4 data.
		* @history 2017-09-26 Jesse Mapel - Improved test coverage and documentation. Fixes #5167.
		*/

		class ProcessExportPds4: public Isis::ProcessExport {