Batch.h

Go to the documentation of this file.

// -*- c-basic-offset: 4 -*-

#ifndef BATCH_H
#define BATCH_H

#include <string>
#include "ProjectArray.h"
#include "RunStitchFrame.h"
#if wxCHECK_VERSION(3,1,0)
#include <wx/power.h>
#endif

#ifndef FRAMEARRAY
#define FRAMEARRAY
WX_DEFINE_ARRAY_PTR(RunStitchFrame*,FrameArray);
#endif

struct FailedProject
{
    wxString project;
    wxString logfile;
};

class Batch : public wxFrame
{
public:
    enum EndTask
    {
        DO_NOTHING = 0,
        CLOSE_PTBATCHERGUI = 1,
        SHUTDOWN = 2,  // only implemented for GTK and Window in wxWidgets
        SUSPEND = 3,   // only implemented for Windows
        HIBERNATE = 4  // only implemented for Windows
    };
    bool deleteFiles;
    EndTask atEnd;
    bool overwrite;
    bool verbose;
    bool autostitch;
    bool autoremove;
    bool saveLog;

    explicit Batch(wxFrame* parent);
    ~Batch();

    void  AddAppToBatch(wxString app);
    void  AddProjectToBatch(wxString projectFile, wxString outputFile = wxEmptyString, wxString userDefinedSequence = wxEmptyString, Project::Target target = Project::STITCHING);
    bool  AllDone();
    void  AppendBatchFile(wxString file);
    void  CancelBatch();
    void  CancelProject(int index);
    void  ChangePrefix(int index, wxString newPrefix);
    void ChangeUserDefined(int index, wxString newUserDefined);
    int   ClearBatch();
    bool  CompareProjectsInLists(int stitchListIndex, int batchListIndex);
    int   GetFirstAvailable();
    int   GetIndex(int id);
    Project* GetProject(int index);
    int   GetProjectCount();
    int   GetProjectCountByPath(wxString path);
    int   GetRunningCount();
    Project::Status GetStatus(int index);
    bool IsRunning();
    bool  IsPaused();
    int  LoadBatchFile(wxString file);
    int   LoadTemp();
    bool  NoErrors();
    void  OnProcessTerminate(wxProcessEvent& event);
    bool  OnStitch(wxString scriptFile, wxString outname, wxString userDefinedOutput, int id);
    bool OnDetect(wxString scriptFile, wxString userDefinedAssistant, int id);
    void  PauseBatch();
    void  RemoveProject(int id);
    void  RemoveProjectAtIndex(int selIndex);
    void  RunBatch();
    void  RunNextInBatch();
    void  SaveBatchFile(wxString file);
    wxString GetBatchFilename();
    void  SaveTemp();
    void  SetStatus(int index,Project::Status status);
    void  SwapProject(int index);
    void ShowOutput(bool isVisible=true);
    size_t GetFailedProjectsCount()
    {
        return m_failedProjects.size();
    };
    wxString GetFailedProjectName(unsigned int i);
    wxString GetFailedProjectLog(unsigned int i);

private:
    // environment config objects
    wxConfigBase* m_config;
    //internal list of projects in batch
    ProjectArray  m_projList;
    //list of projects in progress
    FrameArray    m_stitchFrames;

    //batch state flags
    bool m_cancelled;
    bool m_paused;
    bool m_running;
    bool m_clearedInProgress;

    //vector, which stores the failed projects and filename of saved logfile
    std::vector<FailedProject> m_failedProjects;
#if wxCHECK_VERSION(3,1,0)
    wxPowerResourceBlocker* m_resBlocker;
#endif

    DECLARE_EVENT_TABLE()
};

#if defined _WIN32 && defined Hugin_shared
DECLARE_LOCAL_EVENT_TYPE(EVT_BATCH_FAILED,-1)
DECLARE_LOCAL_EVENT_TYPE(EVT_INFORMATION,-1)
DECLARE_LOCAL_EVENT_TYPE(EVT_UPDATE_PARENT, -1)
#else
DECLARE_EVENT_TYPE(EVT_BATCH_FAILED,-1)
DECLARE_EVENT_TYPE(EVT_INFORMATION,-1)
DECLARE_EVENT_TYPE(EVT_UPDATE_PARENT, -1)
#endif

#endif //BATCH_H