src/globalsearch/queueinterface.h

/**********************************************************************
  QueueInterface - Job submission interface

  Copyright (C) 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 QUEUEINTERFACE_H
#define QUEUEINTERFACE_H

#include <globalsearch/optbase.h>

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

class QDialog;

namespace GlobalSearch {
  class Structure;

  class QueueInterface : public QObject
  {
    Q_OBJECT;

  public:
    explicit QueueInterface(OptBase *parent,
                            const QString &settingFile = "")
      : QObject(parent), m_opt(parent), m_hasDialog(false), m_dialog(0) {};

    virtual ~QueueInterface() {};

    enum QueueStatus {
      Unknown = -1,
      Success,
      Error,
      Queued,
      Running,
      CommunicationError,
      Started,
      Pending
    };

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

  public slots:

    virtual void readSettings(const QString &filename = "") {}

    virtual void writeSettings(const QString &filename = "") {}

    virtual bool writeInputFiles(Structure *s) const;

    virtual bool writeFiles(Structure *s,
                            const QHash<QString, QString> &files) const =0;

    virtual bool startJob(Structure *s) =0;

    virtual bool stopJob(Structure *s) =0;

    virtual QueueInterface::QueueStatus getStatus(Structure *s) const =0;

    virtual bool prepareForStructureUpdate(Structure *s) const =0;

    virtual bool checkIfFileExists(Structure *s,
                                   const QString &filename,
                                   bool *exists) =0;

    virtual bool fetchFile(Structure *s,
                           const QString &filename,
                           QString *contents) const =0;

    virtual bool grepFile(Structure *s,
                          const QString &matchText,
                          const QString &filename,
                          QStringList *matches = 0,
                          int *exitcode = 0,
                          const bool caseSensitive = true) const =0;

    QString getIDString() const {return m_idString;};

    QStringList getTemplateFileNames() const {return m_templates;};


    bool hasDialog() {return m_hasDialog;};

    virtual QDialog* dialog() {return m_dialog;};

  protected:
    OptBase *m_opt;

    QString m_idString;

    QStringList m_templates;

    bool m_hasDialog;

    QDialog *m_dialog;

  };
}

#endif

---