ProcessParms.hpp

Go to the documentation of this file.

//
// This file is part of MorphoGraphX - http://www.MorphoGraphX.org
// Copyright (C) 2012-2019 Richard S. Smith and collaborators.
//
// If you use MorphoGraphX in your work, please cite:
//   http://dx.doi.org/10.7554/eLife.05864
//
// MorphoGraphX is free software, and is licensed under under the terms of the 
// GNU General (GPL) Public License version 2.0, http://www.gnu.org/licenses.
// 
#ifndef PROCESS_PARMS_HPP
#define PROCESS_PARMS_HPP
 
#include <Config.hpp>
#include <Hash.hpp>
#include <Misc.hpp>
 
#include <QStringList>
#include <QHash>
#include <QIcon>
#include <unordered_map>
 
namespace mgx 
{
  typedef QList<QStringList> ParmChoiceList;
 
  class mgx_EXPORT ProcessParms
  {
  public:
    ProcessParms() 
    { 
      setIcon(QIcon(":images/Process.png"));
    }
    virtual ~ProcessParms() {}
 
    QString name() const;
 
    QString description() const;
 
    QStringList parmNames() const;
 
    QStringList parmDescs() const;
 
    QStringList parmDefaults() const;
 
    ParmChoiceList parmChoice() const;
    static QStringList booleanChoice() { return QStringList() << "Yes" << "No"; }
    static QStringList storeChoice() { return QStringList() << "Main" << "Work"; } 
    static QStringList stackChoice() { return QStringList() << "Stack 1" << "Stack 2" << "Current" << "Other"; } 
    static QStringList meshChoice() { return QStringList() << "Mesh 1" << "Mesh 2" << "Current" << "Other"; } 
    static QStringList dimensionChoice() { return QStringList() << "Vertices" << "Edges" << "Faces" << "Volumes"; } 
    static QStringList dimChoice() { return QStringList() << "Vertices" << "Faces" << "Volumes" << "All"; } 
 
    QIcon icon() const;
 
    QString parm(const QString &name) const;
 
    const QStringList &getParms();
 
    bool setName(const QString &name);
 
    bool setDesc(const QString &description);
 
    bool addParm(const QString &parmName, const QString &desc, const QString &def, const QStringList &choices = QStringList());
 
    bool insertParm(const QString &parmName, const QString &desc, const QString &def, int pos, const QStringList &choices = QStringList());
 
    bool setParm(const QString &parmName, const QString &parm);
 
    bool setParms(const QStringList &parms);
 
    bool setParmDesc(const QString &parmName, const QString &desc);
 
    bool setParmDefault(const QString &parmName, const QString &def);
 
    bool setParmChoices(const QString &parmName, const QStringList &choices);
 
    bool setIcon(const QIcon &icon);
 
    QStringList parmList(const QString &key = QString()) const;
 
  private:
    QString _name;
    QString _description;
    QStringList _parms;
    std::unordered_map<QString, int> _parmIdx;
    QStringList _parmNames;
    QStringList _parmDescs;
    QStringList _parmDefaults;
    ParmChoiceList _parmChoices;
    QIcon _icon;
  };
}
#endif