Package PyFoam :: Package Execution :: Module FoamThread :: Class FoamThread
[show private | hide private]
[frames | no frames]

Type FoamThread

object --+        
         |        
  _Verbose --+    
             |    
        Thread --+
                 |
                FoamThread


Thread running an OpenFOAM command

The output of the command can be accessed in a thread-safe manner, line by line

Designed to be used by the BasicRunner-class
Method Summary
  __init__(self, cmdline)
cmdline - Command line of the OpenFOAM command
  check(self)
Return false if there is no more output of the command
  cpuSystemTime(self)
Return number of seconds CPU-Time used in system mode
  cpuTime(self)
Return number of seconds CPU-Time used
  cpuUserTime(self)
Return number of seconds CPU-Time used in user mode
  getLine(self)
gets the last line from the output
  interrupt(self)
A keyboard-interrupt is reported
  read(self)
read another line from the output
  run(self)
start the command
  setState(self, state)
sets the state of the thread (is there any more output)
  stopTimer(self)
  usedMemory(self)
Return maximum resident set size in MegaByte
  wallTime(self)
Return the wall-clock-time needed by the process
    Inherited from Thread
  __repr__(self)
  getName(self)
  isAlive(self)
  isDaemon(self)
  join(self, timeout)
  setDaemon(self, daemonic)
  setName(self, name)
  start(self)
  _set_daemon(self)
    Inherited from _Verbose
  _note(self, format, *args)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
    Inherited from Thread
bool _Thread__initialized = False

Method Details

__init__(self, cmdline)
(Constructor)

cmdline - Command line of the OpenFOAM command
Overrides:
threading.Thread.__init__

check(self)

Returns:
False if there is no more output of the command

cpuSystemTime(self)

Returns:
number of seconds CPU-Time used in system mode

cpuTime(self)

Returns:
number of seconds CPU-Time used

cpuUserTime(self)

Returns:
number of seconds CPU-Time used in user mode

getLine(self)

gets the last line from the output

interrupt(self)

A keyboard-interrupt is reported

read(self)

read another line from the output

run(self)

start the command
Overrides:
threading.Thread.run

setState(self, state)

sets the state of the thread (is there any more output)

usedMemory(self)

Returns:
maximum resident set size in MegaByte

wallTime(self)

Returns:
the wall-clock-time needed by the process

Generated by Epydoc 2.1 on Mon Jan 22 23:52:48 2007 http://epydoc.sf.net