ZThread::State Class Reference

#include <State.h>

List of all members.

Public Types

enum  STATE
 Various states.

Public Member Functions

 State (STATE initialState)
bool isIdle () const
bool isJoined () const
bool isRunning () const
bool isReference () const
bool setIdle ()
bool setRunning ()
bool setReference ()
bool setJoined ()


Detailed Description

Author:
Eric Crahen <http://www.code-foo.com>
Date:
<2003-07-16T20:04:01-0400>
Version:
2.2.1
Class to encapsulate the current state of the threads life-cycle.


Constructor & Destructor Documentation

ZThread::State::State ( STATE  initialState  )  [inline]

Create State with the given flag set.


Member Function Documentation

bool ZThread::State::isIdle (  )  const [inline]

Test for the IDLE state. No task has yet run.

bool ZThread::State::isJoined (  )  const [inline]

Test for the JOINED state. A task has completed and the thread is join()ed.

Returns:
bool

bool ZThread::State::isReference (  )  const [inline]

Test for the REFERENCE state. A task is in progress but not under control of this library.

Returns:
bool

bool ZThread::State::isRunning (  )  const [inline]

Test for the RUNNING state. A task is in progress.

Returns:
bool

bool ZThread::State::setIdle (  )  [inline]

Transition to the IDLE state.

Returns:
bool true if successful

bool ZThread::State::setJoined (  )  [inline]

Transition to the JOINED state.

Returns:
bool true if successful

bool ZThread::State::setReference (  )  [inline]

Transition to the REFERENCE state.

Returns:
bool true if successful

bool ZThread::State::setRunning (  )  [inline]

Transition to the RUNNING state.

Returns:
bool true if successful


The documentation for this class was generated from the following file:
Generated on Wed Aug 30 03:27:49 2006 for SWG EMU by  doxygen 1.4.7