OpendTect  7.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
OS::CommandExecPars Class Reference

Specifies how to execute a command. More...

Public Member Functions

 CommandExecPars (bool isbatchprog)
 
 CommandExecPars (LaunchType lt=Wait4Finish)
 
CommandExecParscreatestreams (bool val)
 
void fillPar (IOPar &) const
 
CommandExecParsisconsoleuiprog (bool val)
 
CommandExecParslaunchtype (LaunchType val)
 
CommandExecParsmonitorfnm (BufferString val)
 
CommandExecParsneedmonitor (bool val)
 
CommandExecParsprioritylevel (float val)
 
void removeFromPar (IOPar &) const
 
CommandExecParsrunasadmin (bool val)
 
CommandExecParsstderrfnm (BufferString val)
 
CommandExecParsstdoutfnm (BufferString val)
 
void usePar (const IOPar &)
 
CommandExecParsworkingdir (BufferString val)
 

Static Public Member Functions

static const StepInterval< int > cMachineUserPriorityRange (bool iswin)
 
static int getMachinePriority (float priolevel, bool iswin)
 
static const char * sKeyPriority ()
 

Public Attributes

bool createstreams_
 
bool isconsoleuiprog_
 -1=lowest, 0=normal, 1=highest (administrator) More...
 
LaunchType launchtype_
 
BufferString monitorfnm_
 
bool needmonitor_
 
float prioritylevel_
 
bool runasadmin_
 
BufferString stderrfnm_
 
BufferString stdoutfnm_
 when empty, will be generated (if needed) More...
 
BufferString workingdir_
 

Detailed Description

Specifies how to execute a command.

<>

Constructor & Destructor Documentation

◆ CommandExecPars() [1/2]

OS::CommandExecPars::CommandExecPars ( LaunchType  lt = Wait4Finish)
inline

◆ CommandExecPars() [2/2]

OS::CommandExecPars::CommandExecPars ( bool  isbatchprog)
explicit

Member Function Documentation

◆ cMachineUserPriorityRange()

static const StepInterval<int> OS::CommandExecPars::cMachineUserPriorityRange ( bool  iswin)
static

Restricted to OS-specific user available range Unix: 0-19 (0=normal) Windows: 6-8 (8=normal)

◆ createstreams()

CommandExecPars& OS::CommandExecPars::createstreams ( bool  val)
inline

◆ fillPar()

void OS::CommandExecPars::fillPar ( IOPar ) const

◆ getMachinePriority()

static int OS::CommandExecPars::getMachinePriority ( float  priolevel,
bool  iswin 
)
static

◆ isconsoleuiprog()

CommandExecPars& OS::CommandExecPars::isconsoleuiprog ( bool  val)
inline

◆ launchtype()

CommandExecPars& OS::CommandExecPars::launchtype ( LaunchType  val)
inline

◆ monitorfnm()

CommandExecPars& OS::CommandExecPars::monitorfnm ( BufferString  val)
inline

◆ needmonitor()

CommandExecPars& OS::CommandExecPars::needmonitor ( bool  val)
inline

◆ prioritylevel()

CommandExecPars& OS::CommandExecPars::prioritylevel ( float  val)
inline

◆ removeFromPar()

void OS::CommandExecPars::removeFromPar ( IOPar ) const

◆ runasadmin()

CommandExecPars& OS::CommandExecPars::runasadmin ( bool  val)
inline

◆ sKeyPriority()

static const char* OS::CommandExecPars::sKeyPriority ( )
inlinestatic

◆ stderrfnm()

CommandExecPars& OS::CommandExecPars::stderrfnm ( BufferString  val)
inline

◆ stdoutfnm()

CommandExecPars& OS::CommandExecPars::stdoutfnm ( BufferString  val)
inline

◆ usePar()

void OS::CommandExecPars::usePar ( const IOPar )

◆ workingdir()

CommandExecPars& OS::CommandExecPars::workingdir ( BufferString  val)
inline

Member Data Documentation

◆ createstreams_

bool OS::CommandExecPars::createstreams_

◆ isconsoleuiprog_

bool OS::CommandExecPars::isconsoleuiprog_

-1=lowest, 0=normal, 1=highest (administrator)

◆ launchtype_

LaunchType OS::CommandExecPars::launchtype_

◆ monitorfnm_

BufferString OS::CommandExecPars::monitorfnm_

◆ needmonitor_

bool OS::CommandExecPars::needmonitor_

◆ prioritylevel_

float OS::CommandExecPars::prioritylevel_

◆ runasadmin_

bool OS::CommandExecPars::runasadmin_

program uses text-based stdin console input if true, will ignore monitor settings

◆ stderrfnm_

BufferString OS::CommandExecPars::stderrfnm_

◆ stdoutfnm_

BufferString OS::CommandExecPars::stdoutfnm_

when empty, will be generated (if needed)

◆ workingdir_

BufferString OS::CommandExecPars::workingdir_

launch in a new session as admin Windows only.


Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2024