IsisAml.h

Go to the documentation of this file.

#ifndef IsisAml_h
#define IsisAml_h

 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <string>
#include <vector>
 
#include <QString>
 
#include <xercesc/sax2/SAX2XMLReader.hpp>
 
#include <nlohmann/json.hpp>
 
#include "IsisXMLApplication.h"
#include "IsisAmlData.h"
#include "Pvl.h"
 
class QString;

class IsisAml : protected IsisAmlData {
 
// Public section
  public:
 
    IsisAml(const QString &xmlfile);
 
    ~IsisAml();
 
 
    // Methods for searching and retrieving application info
    // via the parameter name
 
    void PutAsString(const QString &paramName, const QString &value);
    void PutAsString(const QString &paramName, const std::vector<QString> &value);
 
    void PutFileName(const QString &paramName, const QString &value);
    void PutFileName(const QString &paramName, const std::vector<QString> &value);
 
    void PutCubeName(const QString &paramName, const QString &value);
 
    void PutDouble(const QString &paramName, const double &value);
    void PutDouble(const QString &paramName, const std::vector<double> &value);
 
    void PutInteger(const QString &paramName, const int &value);
    void PutInteger(const QString &paramName, const std::vector<int> &value);
 
    void PutBoolean(const QString &paramName, const bool &value);
    void PutBoolean(const QString &paramName, const std::vector<bool> &value);
 
    void PutString(const QString &paramName, const QString &value);
    void PutString(const QString &paramName, const std::vector<QString> &value);
 
    QString GetAsString(const QString &paramName) const;
    void GetAsString(const QString &paramName, std::vector<QString> &values) const;
 
    QString GetFileName(const QString &paramName, QString extension = "") const;
    void GetFileName(const QString &paramName, std::vector<QString> &values) const;
 
    QString GetCubeName(const QString &paramName, QString extension = "") const;
 
    QString GetString(const QString &paramName) const;
    void GetString(const QString &paramName, std::vector<QString> &values) const;
 
    int GetInteger(const QString &paramName) const;
    void GetInteger(const QString &paramName, std::vector<int> &values) const;
 
    bool GetBoolean(const QString &paramName) const;
 
    void GetBoolean(const QString &paramName, std::vector<bool> &values) const;
 
    double GetDouble(const QString &paramName) const;
    void GetDouble(const QString &paramName, std::vector<double> &values) const;
 
    bool WasEntered(const QString &paramName) const;
    void Clear(const QString &paramName);
 
    Isis::CubeAttributeInput &GetInputAttribute(const QString &paramName);
    Isis::CubeAttributeOutput &GetOutputAttribute(const QString &paramName);
 
    // Methods for retrieving application info not inside a group
 
    QString ProgramName() const;
    QString Brief() const;
    QString Description() const;
 
    // Methods for searching and retrieving application info
    // via the index into groups and parameters
 
    int  NumGroups() const;
 
    QString GroupName(const int &group) const;

    int GroupIndex(const QString & grpName) const;
  
    nlohmann::json GetParams();
 
    int NumParams(const int &) const;
 
    QString ParamName(const int &group, const int &param) const;
 
    QString ParamType(const int &group, const int &param) const;
 
    QString ParamBrief(const int &group, const int &param) const;
 
    QString ParamDescription(const int &group, const int &param) const;
 
    QString ParamMinimum(const int &group, const int &param) const;
 
    QString ParamMinimumInclusive(const int &group, const int &param) const;
 
    QString ParamMaximum(const int &group, const int &param) const;
 
    QString ParamMaximumInclusive(const int &group, const int &param) const;
 
    QString ParamOdd(const int &group, const int &param) const;
 
    int ParamGreaterThanSize(const int &group, const int &param) const;
 
    int ParamGreaterThanOrEqualSize(const int &group, const int &param) const;
 
    int ParamLessThanSize(const int &group, const int &param) const;
 
    int ParamLessThanOrEqualSize(const int &group, const int &param) const;
 
    int ParamNotEqualSize(const int &group, const int &param) const;
 
    QString ParamGreaterThan(const int &group, const int &param,
                                 const int &great) const;
 
    QString ParamGreaterThanOrEqual(const int &group, const int &param,
                                        const int &great) const;
 
    QString ParamLessThan(const int &group, const int &param,
                              const int &great) const;
 
    QString ParamLessThanOrEqual(const int &group, const int &param,
                                     const int &les) const;
 
    QString ParamNotEqual(const int &group, const int &param,
                              const int &notEq) const;
 
    int ParamListSize(const int &group, const int &param) const;
 
    QString ParamListValue(const int &group, const int &param,
                               const int &option) const;
 
    QString ParamListBrief(const int &group, const int &param,
                               const int &option) const;
 
    QString ParamListDescription(const int &group, const int &param,
                                     const int &option) const;
 
    int ParamListExcludeSize(const int &group, const int &param,
                             const int &option) const;
 
    QString ParamListExclude(const int &group, const int &param,
                                 const int &option, const int &exclude) const;
 
    int ParamListIncludeSize(const int &group, const int &param,
                             const int &option) const;
 
    QString ParamListInclude(const int &group, const int &param,
                                 const int &option, const int &include) const;
 
    QString ParamDefault(const int &group, const int &param) const;
 
    QString ParamInternalDefault(const int &group, const int &param) const;
 
    QString ParamFilter(const int &group, const int &param) const;
 
    QString ParamPath(const int &group, const int &param) const;
 
    QString ParamFileMode(const int &group, const int &param) const;
 
    int ParamExcludeSize(const int &group, const int &param) const;
 
    QString ParamExclude(const int &group, const int &param,
                             const int &exclude) const;
    int ParamIncludeSize(const int &group, const int &param) const;
 
    QString ParamInclude(const int &group, const int &param,
                             const int &include) const;
 
    QString PixelType(const int &group, const int &param) const;
 
    int HelpersSize(const int &group, const int &param) const;
 
    QString HelperButtonName(const int &group, const int &param,
                                 const int &helper) const;
 
    QString HelperFunction(const int &group, const int &param,
                               const int &helper) const;
 
    QString HelperBrief(const int &group, const int &param,
                            const int &helper) const;
 
    QString HelperDescription(const int &group, const int &param,
                                  const int &helper) const;
 
    QString HelperIcon(const int &group, const int &param,
                           const int &helper) const;

    bool IsParamInPvlInclude(QString & paramName, std::vector<QString> & exclude);

    void CreatePVL(Isis::Pvl &pvlDef , QString guiGrpName, QString pvlObjName,
                   QString pvlGrpName, std::vector<QString> & exclude);
 
    // Test all parameters for valid values and conditions
    void VerifyAll();
 
    bool StringToBool(QString value) const;
 
    void CommandLine(Isis::Pvl &lab) const;
 
    QString Version() const;
 
 
  protected:
    const IsisParameterData *ReturnParam(const QString &paramName) const;
 
 
  private:
    XERCES::SAX2XMLReader *parser;
    IsisXMLApplication *appHandler;
 
    // Member functions
    void StartParser(const char *xmlfile);
 
 
    void Verify(const IsisParameterData *param);
 
    void CheckFileNamePreference(QString filename, QString paramname);
};
 
 
#endif