BundleSolutionInfo.h

#ifndef BundleSolutionInfo_h
#define BundleSolutionInfo_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <QList>
#include <QObject>
#include <QString>
 
#include "BundleObservation.h"
#include "BundleSettings.h"
#include "SurfacePoint.h"
 
#include "XmlStackedHandler.h"
 
class QDataStream;
class QUuid;
class QXmlStreamWriter;
 
namespace Isis {
  class BundleResults;
  class Control;
  class FileName;
  class ImageList;
  class Project;  //TODO does xml stuff need project???
  class PvlObject;
  class XmlStackedHandlerReader;
 
  class BundleSolutionInfo : public QObject {
    Q_OBJECT
    public:
      BundleSolutionInfo(BundleSettingsQsp inputSettings,
                    FileName controlNetworkFileName,
                    BundleResults outputStatistics,
                    QList<ImageList *> imgList,
                    QObject *parent = 0);
      BundleSolutionInfo(Project *project,
                    XmlStackedHandlerReader *xmlReader,
                    QObject *parent = 0);  //TODO does xml stuff need project???
      BundleSolutionInfo() = default;
 
      ~BundleSolutionInfo();
 
      QString savedBundleOutputFilename();
      QString savedImagesFilename();
      QString savedPointsFilename();
      QString savedResidualsFilename();
 
      void addAdjustedImages(ImageList *images);
      void setOutputStatistics(BundleResults statisticsResults);
      void setOutputControl(Control *outputControl);
      void setOutputControlName(QString name);
      void setRunTime(QString runTime);
      void setName(QString name);
 
      QList<ImageList *> adjustedImages() const;
      QString id() const;
      QString inputControlNetFileName() const;
      QString outputControlNetFileName() const;
      Control *control() const;
      QString outputControlName() const;
      BundleSettingsQsp bundleSettings();
      BundleResults bundleResults();
      QList<ImageList *> imageList();
      QString runTime() const;
      QString name() const;
 
 
      bool outputImagesCSVHeader(std::ofstream &fpOut, BundleObservationQsp observations);
      bool outputHeader(std::ofstream &fpOut);
      bool outputText();
      bool outputImagesCSV();
      bool outputPointsCSV();
      bool outputResiduals();
 
      void save(QXmlStreamWriter &stream, const Project *project, FileName newProjectRoot) const;
 
      QString surfacePointCoordName(SurfacePoint::CoordinateType type,
                                    SurfacePoint::CoordIndex coordInx) const;
 
    public slots:
      void updateFileName(Project *);
 
    private:
      class XmlHandler : public XmlStackedHandler {
        public:
          //TODO does xml stuff need project???
          XmlHandler(BundleSolutionInfo *bundleSolutionInfo, Project *project);
          ~XmlHandler();
 
          virtual bool startElement(const QString &namespaceURI, const QString &localName,
                                    const QString &qName, const QXmlAttributes &atts);
          virtual bool characters(const QString &ch);
          virtual bool endElement(const QString &namespaceURI, const QString &localName,
                                    const QString &qName);
          QString surfacePointCoordName(SurfacePoint::CoordinateType type,
                                        SurfacePoint::CoordIndex coordIdx) const;
 
        private:
          Q_DISABLE_COPY(XmlHandler);
 
          BundleSolutionInfo *m_xmlHandlerBundleSolutionInfo; 
          Project *m_xmlHandlerProject;  //TODO does xml stuff need project???
          QString m_xmlHandlerCharacters; 
      };
 
    private:
 
      QUuid              *m_id;
      QString             m_name;                        
      QString             m_runTime;                     
      FileName           *m_inputControlNetFileName;     
      Control            *m_outputControl;               
      QString             m_outputControlName;
      BundleSettingsQsp   m_settings;                    
      BundleResults      *m_statisticsResults;           
      QList<ImageList *> *m_images;                      
      QList<ImageList *> *m_adjustedImages;              
 
      // In theory the path in the BundleSettings can change while running. So we save the
      // filenames actually used when the most recent save of the file was done.
      QString m_txtBundleOutputFilename;
      QString m_csvSavedImagesFilename;
      QString m_csvSavedPointsFilename;
      QString m_csvSavedResidualsFilename;
 
  }; // end BundleSolutionInfo class
 
  void setStringAttribute(int locationId, QString locationName,
                          QString attributeName, QString attributeValue);
  QString getStringAttribute(int locationId, QString locationName, QString attributeName);
}; // end namespace Isis
 
Q_DECLARE_METATYPE(Isis::BundleSolutionInfo *);
 
#endif // BundleSolutionInfo_h