batchjobdispatch.h

Go to the documentation of this file.

#ifndef batchjobdispatch_h
#define batchjobdispatch_h
/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          Dec 2013
 RCS:           $Id$
________________________________________________________________________

-*/

#include "generalmod.h"
#include "factory.h"
#include "oscommand.h"
#include "iopar.h"
#include "uistring.h"


namespace Batch
{

mExpClass(General) JobSpec
{ mODTextTranslationClass(JobSpec);
public:

    enum ProcType       { NonODBase, Attrib, AttribEM, Grid2D,
                          PreStack, SEGY, T2D, TwoDto3D, VelConv, Vol };

                        JobSpec(ProcType);
                        JobSpec( const char* pnm=0 )
                            : prognm_(pnm), execpars_(true)             {}
                        JobSpec(const IOPar&);

    static const char*  progNameFor(ProcType);
    static ProcType     procTypeFor(const char*);

    BufferString        prognm_;
    BufferString        clargs_;
    IOPar               pars_;
    OS::CommandExecPars execpars_;      

    void                usePar(const IOPar&);
    void                fillPar(IOPar&) const;

};


mExpClass(General) JobDispatcher
{ mODTextTranslationClass(JobDispatcher);
public:

                        JobDispatcher()                 {}

    virtual             ~JobDispatcher()                {}

    virtual uiString    description() const             = 0;
    virtual bool        isSuitedFor(const char* prognm) const = 0;
    virtual bool        canHandle(const JobSpec&) const;
    virtual bool        canResume(const JobSpec&) const { return false; }

    bool                go(const JobSpec&);
    uiString            errMsg() const                  { return errmsg_; }

    mDefineFactoryInClass(JobDispatcher,factory);

    static void         getDefParFilename(const char* prognm,BufferString&);
    void                setToDefParFileName()
                                { getDefParFilename(jobspec_.prognm_,parfnm_); }

    static void         getJobNames(BufferStringSet&);
    static BufferString getJobName(const char*);
    void                setJobName(const char*);
    BufferString        jobName() const { return getJobName(parfnm_.buf()); }

    static void         setUserWantsResume(IOPar&,bool);
    static bool         userWantsResume(const IOPar&);

    JobSpec             jobspec_;
    BufferString        parfnm_;

protected:

    virtual bool        init()                          { return true; }
    virtual bool        launch()                        = 0;

    mutable uiString    errmsg_;

    bool                writeParFile() const;

};


mExpClass(General) SingleJobDispatcher : public JobDispatcher
{ mODTextTranslationClass(SingleJobDispatcher);
public:

                        SingleJobDispatcher();
    virtual             ~SingleJobDispatcher()          {}

    virtual uiString    description() const;
    virtual bool        isSuitedFor(const char*) const  { return true; }

    mDefaultFactoryInstantiation(JobDispatcher,SingleJobDispatcher,
                                 "Single Process",tr("Single Process"));

    BufferString        remotehost_;
    BufferString        remoteexec_;

protected:

    virtual bool        init();
    virtual bool        launch();

};


} // namespace Batch


#endif