Commit 0872bb24 authored by Tyler Wilson's avatar Tyler Wilson
Browse files

Updated documentation for...

Updated documentation for TargetBody,TargetBodyDisplayProperties,GuiCamera,GuiCameraDisplayProperties.  Fixes #3997.

git-svn-id: http://subversion.wr.usgs.gov/repos/prog/isis3/branches/ipce@6799 41f8697f-d340-4b68-9986-7bafba869bb8
parent ab556603
Loading
Loading
Loading
Loading
+6 −18
Original line number Diff line number Diff line
@@ -26,7 +26,6 @@ namespace Isis {
  }



  /**
   * This constructor will create a CorrelationMatrix object given a pvl.
   *
@@ -109,7 +108,6 @@ namespace Isis {
  }



  /**
   * @brief Copy Constructor
   *
@@ -124,7 +122,6 @@ namespace Isis {
  }



  /**
   * Destructor
   */
@@ -146,7 +143,6 @@ namespace Isis {
  }



  /**
   * @brief Equal Operator
   *
@@ -276,7 +272,7 @@ namespace Isis {
   * @description This method will open the correlation matrix file and read in the blocks that
   * apply to the requested area. It will populate m_visibleElements.
   *
   * @param x fisrt coordinate of the location in the matrix that the user wants to see.
   * @param x first coordinate of the location in the matrix that the user wants to see.
   * @param y second coordinate of the location in the matrix that the user wants to see.
   */
  void CorrelationMatrix::retrieveVisibleElements(int x, int y) {
@@ -309,15 +305,14 @@ namespace Isis {
   * @brief See if the correlation matrix has already been calculated by checking to see if
   *   the correlation matrix file has been created.
   *
   * @return @b bool Returnns True if the correlation matrix has already been set.
   * @return @b bool Returns True if the correlation matrix has already been set.
   */
  bool CorrelationMatrix::isValid() {

      return !(m_correlationFileName->name() == "" || m_covarianceFileName->name() == "");


  }


  /**
   * @description This is used to make sure the covariance matrix exists.
   * If it doesn't this class is not valid. If this file exists, we can compute the
@@ -330,7 +325,6 @@ namespace Isis {
  }



  // Set Methods
  /**
   * @brief Set the qmap of images and parameters.
@@ -346,7 +340,6 @@ namespace Isis {
  }



  /**
   * @brief Set the qmap of images and parameters.
   * @param  covarianceFileName  The FileName of the stored covariance matrix data.
@@ -367,7 +360,6 @@ namespace Isis {
  }



  /**
   * @brief Set the qmap of images and parameters.
   *
@@ -384,7 +376,6 @@ namespace Isis {
  }



  /**
   * @brief Public access for the correlation matrix file name.
   *
@@ -395,7 +386,6 @@ namespace Isis {
  }



  /**
   * @brief Public access for the covariance matrix file name.
   *
@@ -406,7 +396,6 @@ namespace Isis {
  }



  /**
   * @brief Public access for the qmap of images and parameters.
   *
@@ -418,7 +407,6 @@ namespace Isis {
  }



  /**
   * @description This method will read the matrix in from the file and hold on to the whole thing.
   * This will only be used when the matrix is small enough that this will be useful.
@@ -437,7 +425,6 @@ namespace Isis {
  }



  /**
   * @description This method will be used when the matrix is too big to display the whole thing.
   * It will read in the block we want to see and the two blocks for the diagonals that belong to
@@ -447,7 +434,6 @@ namespace Isis {
  }



  /**
   * @brief Get the visible part of the matrix.
   * @return @b QList Returns a list of the non-empty diagonal blocks of the correlation matrix.
@@ -457,7 +443,6 @@ namespace Isis {
  }



  /**
   * @description This method creates a Pvl group with the information necessary to recreate
   * this correlation matrix.
@@ -492,6 +477,7 @@ namespace Isis {
    return corrMatInfo;
  }


  /**
   * @brief Writes CorrelationMatrix data to the output stream and returns this stream
   * to the user.
@@ -553,6 +539,7 @@ namespace Isis {
    return stream;
  }


  /**
   * @brief The operator <<  writes matrix data to a QDataStream.
   * @param stream The output stream upon which the matrix data is written.
@@ -563,6 +550,7 @@ namespace Isis {
    return matrix.write(stream);
  }


  /**
   * @brief The operator >> reads matrix data from a QDataStream.
   * @param stream  The input stream containing the CorrelationMatrix data.
+1 −1
Original line number Diff line number Diff line
@@ -165,7 +165,7 @@ int main() {
   }
   catch(IException &e) {
     QString msg = "Failed to create object using CorrelationMatrix(PvlObject).";
     throw(e, IException::Programmer, msg, _FILEINFO_);
     throw IException(e, IException::Programmer, msg, _FILEINFO_);
   }


+0 −1
Original line number Diff line number Diff line
@@ -26,7 +26,6 @@ namespace Isis {
   * @param camera  A traditional Isis::Camera object which we are wrapping in this class.
   * @param parent  A pointer to the object instantiating this object.
   */

  GuiCamera::GuiCamera(Camera *camera, QObject *parent) : QObject(parent) {
    m_id = NULL;

+12 −14
Original line number Diff line number Diff line
@@ -24,26 +24,16 @@
 *   http://www.usgs.gov/privacy.html.
 */


#include <vector>


#include <QList>
#include <QObject>
#include <QSharedPointer>
#include <QString>

#include <SpiceUsr.h>
#include <SpiceZfc.h>
#include <SpiceZmc.h>


#include "XmlStackedHandler.h"





class QDataStream;
class QUuid;
class QXmlStreamWriter;
@@ -174,10 +164,18 @@ namespace Isis {
       */
      GuiCameraDisplayProperties *m_displayProperties;
      
      QString m_spacecraftNameShort;
      QString m_spacecraftNameLong;
      QString m_instrumentNameShort;
      QString m_instrumentNameLong;
      

      QString m_spacecraftNameShort; //!< An abbreviated name for the spacecraft.


      QString m_spacecraftNameLong; //!< The full spacecraft name


      QString m_instrumentNameShort; //!< The abbreviated instrument name


      QString m_instrumentNameLong; //!< The full instrument name
  };

  /**
+2 −2
Original line number Diff line number Diff line
@@ -263,7 +263,7 @@ namespace Isis {
   * is called when the XML processor has parsed a chunk of character data.
   * @see XmlStackedHandler, QXmlDefaultHandler,QXmlContentHandler
   * @param ch The character data.
   * @return @b boo Returns True if there were no problems with the character processing.
   * @return @b bool Returns True if there were no problems with the character processing.
   * It returns False if there was a problem, and the XML reader stops.
   */
  bool GuiCameraDisplayProperties::XmlHandler::characters(const QString &ch) {
@@ -274,7 +274,7 @@ namespace Isis {


  /**
   * @brief The XML reader invokes this method at the start of every element in the
   * @brief The XML reader invokes this method at the end of every element in the
   *        XML document.
   * @param namespaceURI  The Uniform Resource Identifier of the namespace (eg. "xmlns")
   * @param localName The local name string (eg. "xhtml")
Loading