src/globalsearch/queuemanager.h

/**********************************************************************
  QueueManager - Generic queue manager to track running structures

  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 QUEUEMANAGER_H
#define QUEUEMANAGER_H

#include <globalsearch/tracker.h>

class QDateTime;

namespace GlobalSearch {
  class OptBase;
  class Structure;

  class QueueManager : public QObject
  {
    Q_OBJECT

  public:
    explicit QueueManager(QThread *thread, OptBase *parent);

    virtual ~QueueManager();

  signals:
    void movedToQMThread();

    void structureStarted(GlobalSearch::Structure *s);

    void structureSubmitted(GlobalSearch::Structure *s);

    void structureKilled(GlobalSearch::Structure *s);

    void structureUpdated(GlobalSearch::Structure *s);

    void structureFinished(GlobalSearch::Structure *s);

    void needNewStructure();

    void newStatusOverview(int optimized, int running, int failing);

    // Work around for Qt 4.6.3
#if QT_VERSION == 0x040603
    void newStructureQueued();
#endif // QT_VERSION == 4.6.3

   public slots:
    void reset();

    void killStructure(Structure *s);

    void appendToJobStartTracker(Structure *s);

    void addManualStructureRequest(int requests = 1);

    QList<Structure*> getAllPreoptimizingStructures();

    QList<Structure*> getAllRunningStructures();

    QList<Structure*> getAllOptimizedStructures();

    QList<Structure*> getAllDuplicateStructures();

    QList<Structure*> getAllStructures();

    QList<Structure*> lockForNaming();

    void unlockForNaming(Structure *s = 0);

   protected slots:
    void checkLoop();

    void senderHasFinishedPreoptimization();

    void addStructureToSubmissionQueue(GlobalSearch::Structure *s, int optStep);

    void addStructureToSubmissionQueue(GlobalSearch::Structure *s) {
      addStructureToSubmissionQueue(s, 0);}

    void moveToQMThread();

    void setupConnections();

  protected:
    OptBase *m_opt;

    QThread *m_thread;

    Tracker *m_tracker;

    void updateQueue();

    void updateStructure(Structure *s);

    void startPreoptimization();

    void startJob();

    void stopJob(Structure *s);

    void checkPopulation();

    void checkRunning();

    void handleOptimizedStructure(Structure *s);

    void handleStepOptimizedStructure(Structure *s);

    void handleWaitingForOptimizationStructure(Structure *s);

    void handleInProcessStructure(Structure *s);

    void handleEmptyStructure(Structure *s);

    void handlePreoptimizingStructure(Structure *s);

    void handleUpdatingStructure(Structure *s);

    void handleErrorStructure(Structure *s);

    void handleSubmittedStructure(Structure *s);

    void handleKilledStructure(Structure *s);

    void handleRemovedStructure(Structure *s);

    void handleDuplicateStructure(Structure *s);

    void handleRestartStructure(Structure *s);

    // These run in the background and are called by the above
    // functions via QtConcurrent::run.
    void handleOptimizedStructure_(Structure *s);
    void handleStepOptimizedStructure_(Structure *s);
    void handleInProcessStructure_(Structure *s);
    void handleErrorStructure_(Structure *s);
    void handleSubmittedStructure_(Structure *s);
    void handleKilledStructure_(Structure *s);
    void handleDuplicateStructure_(Structure *s);
    void handleRestartStructure_(Structure *s);

    // Other background handlers
    void addStructureToSubmissionQueue_(Structure *s, int optStep);
    void startJob_(Structure *s);

#if QT_VERSION == 0x040603
  protected slots:
#endif // QT_VERSION == 4.6.3
    void unlockForNaming_();
#if QT_VERSION == 0x040603
  protected:
#endif // QT_VERSION == 4.6.3


    // Trackers for above handlers
    Tracker m_newlyOptimizedTracker;
    Tracker m_stepOptimizedTracker;
    Tracker m_inProcessTracker;
    Tracker m_errorTracker;
    Tracker m_submittedTracker;
    Tracker m_newlyKilledTracker;
    Tracker m_newDuplicateTracker;
    Tracker m_restartTracker;
    Tracker m_newSubmissionTracker;

    Tracker m_needPreOptTracker;
    Tracker m_preOptTracker;
    Tracker m_runningTracker;
    Tracker m_jobStartTracker;
    Tracker m_newStructureTracker;

    int m_requestedStructures;

    bool m_isDestroying;

    QDateTime *m_lastSubmissionTimeStamp;
 };

} // end namespace GlobalSearch

#endif

---