zeus::TProcessControl Class Reference

#include <ProcessControl.h>

Inheritance diagram for zeus::TProcessControl:

zeus::TZObject zeus::IZUnknown

List of all members.

Public Types

enum  EProcessState { etInit, etStarted, etTerminated, etErrorState }

Public Member Functions

 TProcessControl (const IString &rApplicationName)
 TProcessControl (Uint uiProcessID)
void addParameter (const IString &rParameter)
void addParameter (const TString &rParameter)
void clearParameter ()
Int getParameterCount () const
const IStringgetParameter (Int iIndex) const
TString getParameters () const
bool exists () const
Int getExitCode () const
Uint getProcessID () const
bool isStarted () const
bool isTerminated () const
Retval kill ()
Retval start ()
Retval terminate (Int iExitCode=0)
bool waitForTermination (Float fTimeOut)
bool waitForIdle (Float fTimeOut)

Protected Member Functions

virtual ~TProcessControl ()


Detailed Description

This class controls a process. Starting and termination can be controlled

Member Enumeration Documentation

the process state

Enumerator:
etInit 
etStarted 
etTerminated 
etErrorState 


Constructor & Destructor Documentation

TProcessControl::TProcessControl ( const IString rApplicationName  ) 

Creates a process control object

Parameters:
rApplicationName : Path and name of the application to run/control

TProcessControl::TProcessControl ( Uint  uiProcessID  ) 

Creates a process control object

Parameters:
uiProcessID : ID of the process to wrapp

TProcessControl::~TProcessControl (  )  [protected, virtual]

Destroys the process control object


Member Function Documentation

void zeus::TProcessControl::addParameter ( const IString rParameter  )  [inline]

adds an application parameter

void zeus::TProcessControl::addParameter ( const TString rParameter  )  [inline]

adds an application parameter

void zeus::TProcessControl::clearParameter (  )  [inline]

Removes all application parameter

Int zeus::TProcessControl::getParameterCount (  )  const [inline]

returns the count of application parameter list

const IString & zeus::TProcessControl::getParameter ( Int  iIndex  )  const [inline]

returns an indexed application parameter

TString TProcessControl::getParameters (  )  const

Returns all parameter as a string

bool TProcessControl::exists (  )  const

Checks if the process still exists

Int TProcessControl::getExitCode (  )  const

Returns the exit code of the process

Uint TProcessControl::getProcessID (  )  const

Returns the ID of the process

bool zeus::TProcessControl::isStarted (  )  const [inline]

Checks if the process is started

bool zeus::TProcessControl::isTerminated (  )  const [inline]

Checks if the process is terminated

Retval TProcessControl::kill (  ) 

Kills the process immediately

Retval TProcessControl::start (  ) 

Starts the application

Retval TProcessControl::terminate ( Int  iExitCode = 0  ) 

Terminates the process

bool TProcessControl::waitForTermination ( Float  fTimeOut  ) 

Waits for termination of the process

bool TProcessControl::waitForIdle ( Float  fTimeOut  ) 

Waits for idle input of the process


The documentation for this class was generated from the following files:


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:35 2009