engauge-digitizer-devel-doc/html/ExportFileFunctions_8h_source.html

/******************************************************************************************************

 * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released      *

 * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *

 * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission.     *

 ******************************************************************************************************/


#ifndef EXPORT_FILE_FUNCTIONS_H

#define EXPORT_FILE_FUNCTIONS_H


#include "CurveLimits.h"

#include "ExportFileAbstractBase.h"

#include "ExportValuesXOrY.h"

#include "Points.h"

#include <QStringList>

#include <QVector>

#include "ValuesVectorXOrY.h"


class Document;

class DocumentModelCoords;

class DocumentModelExportFormat;

class DocumentModelGeneral;

class MainWindowModel;

class QTextStream;

class Transformation;


class ExportFileFunctions : public ExportFileAbstractBase

{

  // For unit testing

  friend class TestExport;


public:

  ExportFileFunctions();


  void exportToFile (const DocumentModelExportFormat &modelExportOverride,

                     const Document &document,

                     const MainWindowModel &modelMainWindow,

                     const Transformation &transformation,

                     QTextStream &str,

                     unsigned int &numWritesSoFar) const;


private:


  void exportAllPerLineXThetaValuesMerged (const DocumentModelExportFormat &modelExportOverride,

                                           const Document &document,

                                           const MainWindowModel &modelMainWindow,

                                           const QStringList &curvesIncluded,

                                           const ExportValuesXOrY &xThetaValues,

                                           const QString &delimiter,

                                           const Transformation &transformation,

                                           bool isLogXTheta,

                                           bool isLogYRadius,

                                           const CurveLimits curveLimitsMin,

                                           const CurveLimits curveLimitsMax,

                                           QTextStream &str,

                                           unsigned int &numWritesSoFar) const;

  void exportOnePerLineXThetaValuesMerged (const DocumentModelExportFormat &modelExportOverride,

                                           const Document &document,

                                           const MainWindowModel &modelMainWindow,

                                           const QStringList &curvesIncluded,

                                           const ExportValuesXOrY &xThetaValues,

                                           const QString &delimiter,

                                           const Transformation &transformation,

                                           bool isLogXTheta,

                                           bool isLogYRadius,

                                           const CurveLimits curveLimitsMin,

                                           const CurveLimits curveLimitsMax,

                                           QTextStream &str,

                                           unsigned int &numWritesSoFar) const;


  void initializeYRadiusValues (const QStringList &curvesIncluded,

                                const ExportValuesXOrY &xThetaValuesMerged,

                                QVector<QVector<QString*> > &yRadiusValues) const;


  double linearlyInterpolate (const Points &points,

                              double xThetaValue,

                              const Transformation &transformation) const;

  void loadYRadiusValues (const DocumentModelExportFormat &modelExportOverride,

                          const Document &document,

                          const MainWindowModel &modelMainWindow,

                          const QStringList &curvesIncluded,

                          const Transformation &transformation,

                          bool isLogXTheta,

                          bool isLogYRadius,

                          const ExportValuesXOrY &xThetaValues,

                          const CurveLimits &curveLimitsMin,

                          const CurveLimits &curveLimitsMax,

                          QVector<QVector<QString*> > &yRadiusValues) const;

  void loadYRadiusValuesForCurveInterpolatedSmooth (const DocumentModelCoords &modelCoords,

                                                    const DocumentModelGeneral &modelGeneral,

                                                    const MainWindowModel &modelMainWindow,

                                                    const Points &points,

                                                    const ExportValuesXOrY &xThetaValues,

                                                    const Transformation &transformation,

                                                    bool isLogXTheta,

                                                    bool isLogYRadius,

                                                    const QString &curveName,

                                                    const CurveLimits &curveLimitsMin,

                                                    const CurveLimits &curveLimitsMax,

                                                    QVector<QString*> &yRadiusValues) const;

  void loadYRadiusValuesForCurveInterpolatedStraight (const DocumentModelCoords &modelCoords,

                                                      const DocumentModelGeneral &modelGeneral,

                                                      const MainWindowModel &modelMainWindow,

                                                      const Points &points,

                                                      const ExportValuesXOrY &xThetaValues,

                                                      const Transformation &transformation,

                                                      const QString &curveName,

                                                      const CurveLimits &curveLimitsMin,

                                                      const CurveLimits &curveLimitsMax,

                                                      QVector<QString*> &yRadiusValues) const;

  void loadYRadiusValuesForCurveRaw (const DocumentModelCoords &modelCoords,

                                     const DocumentModelGeneral &modelGeneral,

                                     const MainWindowModel &modelMainWindow,

                                     const Points &points,

                                     const ExportValuesXOrY &xThetaValues,

                                     const Transformation &transformation,

                                     const QString &curveName,

                                     const CurveLimits &curveLimitsMin,

                                     const CurveLimits &curveLimitsMax,

                                     QVector<QString*> &yRadiusValues) const;


  void outputXThetaYRadiusValues (const DocumentModelExportFormat &modelExportOverride,

                                  const DocumentModelCoords &modelCoords,

                                  const DocumentModelGeneral &modelGeneral,

                                  const MainWindowModel &modelMainWindow,

                                  const QStringList &curvesIncluded,

                                  const ExportValuesXOrY &xThetaValuesMerged,

                                  const Transformation &transformation,

                                  QVector<QVector<QString*> > &yRadiusValues,

                                  const QString &delimiter,

                                  QTextStream &str,

                                  unsigned int &numWritesSoFar) const;

  // Only include rows that have at least one y/radius entry. This check is required when outputing one curve per row

  // since the union of all x/theta values is applied to each curve

  bool rowHasAtLeastOneYRadiusEntry (const QVector<QVector<QString*> > &yRadiusValues,

                                     int row) const;


  // If there are bounds for the curve, make sure xTheta is within those bounds

  bool xThetaIsNotOutOfBounds (double xTheta,

                               const QString &curveName,

                               const CurveLimits &curveLimitsMin,

                               const CurveLimits &curveLimitsMax) const;

};


#endif // EXPORT_FILE_FUNCTIONS_H