batchjobdispatch.h

Go to the documentation of this file.

#pragma once
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          Dec 2013
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "enums.h"
#include "generalmod.h"
#include "factory.h"
#include "oscommand.h"
#include "iopar.h"
#include "uistring.h"
 
 
namespace Batch
{
 
typedef int             ID;
 
mExpClass(General) JobSpec
{ mODTextTranslationClass(JobSpec);
public:
 
    enum ProcType       { NonODBase, Attrib, AttribEM, Grid2D,
                          PreStack, SEGY, T2D, TwoDto3D, VelConv, Vol };
 
                        JobSpec(ProcType,OS::LaunchType lt=OS::Batch);
                        JobSpec(const char* pnm=nullptr,
                                OS::LaunchType lt=OS::Batch);
                        JobSpec(const IOPar&,OS::LaunchType lt=OS::Batch);
 
    static const char*  progNameFor(ProcType);
    static ProcType     procTypeFor(const char*);
 
    BufferString        prognm_;
    BufferStringSet     clargs_;
    IOPar               pars_;
    BufferString        servernm_;
    OS::CommandExecPars execpars_;      
 
    void                usePar(const IOPar&);
    void                fillPar(IOPar&) const;
 
};
 
 
mExpClass(General) JobDispatcher
{ mODTextTranslationClass(JobDispatcher);
public:
 
    static ID           getInvalid()    { return 0; }
 
                        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&,ID* =nullptr);
    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_;
 
    static void         addIDTo(ID,OS::MachineCommand&);
 
protected:
 
    virtual bool        init()                          { return true; }
    virtual bool        launch(ID*)                     = 0;
                        /*<! A provided ID will get a unique session number,
                             to identify the spawn command. Add it to the
                             command line using addIDTo function         */
 
    mutable uiString    errmsg_;
 
    bool                writeParFile() const;
 
};
 
 
} // namespace Batch