src/globalsearch/optimizer.h

/**********************************************************************
  Optimizer - Generic optimizer interface

  Copyright (C) 2010-2011 by David C. Lonie

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation version 2 of the License.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 ***********************************************************************/

#ifndef OPTIMIZER_H
#define OPTIMIZER_H

#include <globalsearch/optbase.h>
#include <globalsearch/queueinterface.h>

#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QVariant>
#include <QtCore/QStringList>

namespace GlobalSearch {
  class Structure;
  class OptimizerConfigDialog;

  class Optimizer : public QObject
  {
    Q_OBJECT

  public:
    friend class OptimizerConfigDialog;

    explicit Optimizer(OptBase *parent, const QString &filename = "");

    virtual ~Optimizer();

    virtual void readSettings(const QString &filename = "");

    virtual void writeSettings(const QString &filename = "");

    virtual QString getIDString() {return m_idString;};

    virtual int getNumberOfOptSteps();

    virtual bool isReadyToSearch(QString *err) {*err = ""; return true;}

    virtual bool checkIfOutputFileExists(Structure *s, bool *exists);

    virtual bool checkForSuccessfulOutput(Structure *s, bool *success);

    virtual bool update(Structure *structure);

    virtual bool load(Structure *structure);

    virtual bool read(Structure *structure, const QString & filename);

    virtual QString getTemplate(const QString &filename, int optStepIndex);

    virtual QStringList getTemplate(const QString &filename);

    virtual QVariant getData(const QString &identifier);

    virtual QStringList getTemplateNames() {return m_templates.keys();};

    virtual QStringList getDataIdentifiers() {return m_data.keys();};

    QString getUser1() {return m_user1;};

    QString getUser2() {return m_user2;};

    QString getUser3() {return m_user3;};

    QString getUser4() {return m_user4;};

  public slots:
    virtual bool setTemplate(const QString &filename,
                             const QString &templateData,
                             int optStepIndex);

    virtual bool setTemplate(const QString &filename,
                             const QStringList &templateData);

    virtual bool appendTemplate(const QString &filename,
                                const QString &templateData);

    virtual bool removeAllTemplatesForOptStep(int optStepIndex);

    virtual bool setData(const QString &identifier,
                         const QVariant &data);

    void setUser1(const QString &s) {m_user1 = s;};

    void setUser2(const QString &s) {m_user2 = s;};

    void setUser3(const QString &s) {m_user3 = s;};

    void setUser4(const QString &s) {m_user4 = s;};

    QString localRunCommand() const {return m_localRunCommand;};

    QStringList localRunArgs() const {return m_localRunArgs;};

    QString stdinFilename() const {return m_stdinFilename;};

    QString stdoutFilename() const {return m_stdoutFilename;};

    QString stderrFilename() const {return m_stderrFilename;};

    virtual QHash<QString, QString> getInterpretedTemplates(Structure *s);


    bool hasDialog() {return m_hasDialog;};

    virtual QDialog* dialog();

  protected slots:
    virtual void updateQueueInterface();

  protected:
    virtual void readTemplatesFromSettings(const QString &filename = "");

    virtual void writeTemplatesToSettings(const QString &filename = "");

    virtual void readUserValuesFromSettings(const QString &filename = "");

    virtual void writeUserValuesToSettings(const QString &filename = "");

    virtual void readDataFromSettings(const QString &filename = "");

    virtual void writeDataToSettings(const QString &filename = "");

    QHash<QString, QVariant> m_data;

    QHash<QString, QStringList>& resolveTemplateHash(const QString &filename);

    const QHash<QString, QStringList>& resolveTemplateHash(const QString &filename) const;

    virtual void fixTemplateLengths();

    QHash<QString, QStringList > m_templates;

    QHash<QString, QStringList > m_QITemplates;

    QString m_completionFilename;

    QStringList m_completionStrings;

    QStringList m_outputFilenames;

    QString m_localRunCommand;

    QStringList m_localRunArgs;

    QString m_stdinFilename;

    QString m_stdoutFilename;

    QString m_stderrFilename;

    QString m_user1;

    QString m_user2;

    QString m_user3;

    QString m_user4;

    OptBase *m_opt;

    QString m_idString;

    bool m_hasDialog;
    QDialog *m_dialog;
  };
} // end namespace GlobalSearch

#endif

---