PIntCondMutex Class Reference

#include <syncthrd.h>

Inheritance diagram for PIntCondMutex:

List of all members.

Construction
enum	Operation {   LT, LE, EQ, GE,   GT }
	defines possible operators on current value and target value More...
	PIntCondMutex (int value=0, int target=0, Operation operation=LE)
Public Member Functions
Overrides from class PObject
void	PrintOn (ostream &strm) const
Condition access functions
virtual PBoolean	Condition ()
	operator int () const
PIntCondMutex &	operator= (int newval)
PIntCondMutex &	operator++ ()
PIntCondMutex &	operator+= (int inc)
PIntCondMutex &	operator-- ()
PIntCondMutex &	operator-= (int dec)
Protected Attributes
int	value
int	target
Operation	operation

---

Detailed Description

This is a PCondMutex for which the conditional is the value of an integer.

---

Member Enumeration Documentation

enum PIntCondMutex::Operation

defines possible operators on current value and target value

Enumerator:

LT	Less than.
LE	Less than or equal to.
EQ	Equal to.
GE	Greater than or equal to.
GT	Greater than.

---

Constructor & Destructor Documentation

PIntCondMutex::PIntCondMutex	(	int	value = 0,
		int	target = 0,
		Operation	operation = LE
	)

Create a cond mutex using an integer

Parameters:

value	initial value if the integer
target	target vaue which causes the mutex to unlock
operation	comparison operator

---

Member Function Documentation

void PIntCondMutex::PrintOn

(

ostream &

strm

)

const [virtual]

Print the object on the stream. This will be of the form #"(value < target)"#.

Reimplemented from PObject.

virtual PBoolean PIntCondMutex::Condition

(

)

[virtual]

This is the condition that must be met for the WaitCondition() function to acquire the mutex.

Returns:

PTrue if condition is met.

Implements PCondMutex.

PIntCondMutex::operator int

(

)

const [inline]

Get the current value of the condition variable.

Returns:

Current condition variable value.

PIntCondMutex& PIntCondMutex::operator=

(

int

newval

)

Assign new condition value. Use the Wait() function to acquire the mutex, modify the value, then release the mutex, possibly releasing the thread in the WaitCondition() function if the condition was met by the operation.

Returns:

The object reference for consecutive operations in the same statement.

PIntCondMutex& PIntCondMutex::operator++

(

)

Increment condition value. Use the Wait() function to acquire the mutex, modify the value, then release the mutex, possibly releasing the thread in the WaitCondition() function if the condition was met by the operation.

Returns:

The object reference for consecutive operations in the same statement.

PIntCondMutex& PIntCondMutex::operator+=

(

int

inc

)

Add to condition value. Use the Wait() function to acquire the mutex, modify the value, then release the mutex, possibly releasing the thread in the WaitCondition() function if the condition was met by the operation.

Returns:

The object reference for consecutive operations in the same statement.

PIntCondMutex& PIntCondMutex::operator--

(

)

Decrement condition value. Use the Wait() function to acquire the mutex, modify the value, then release the mutex, possibly releasing the thread in the WaitCondition() function if the condition was met by the operation.

Returns:

The object reference for consecutive operations in the same statement.

PIntCondMutex& PIntCondMutex::operator-=

(

int

dec

)

Subtract from condition value. Use the Wait() function to acquire the mutex, modify the value, then release the mutex, possibly releasing the thread in the WaitCondition() function if the condition was met by the operation.

Returns:

The object reference for consecutive operations in the same statement.

---

Member Data Documentation

int PIntCondMutex::value [protected]

int PIntCondMutex::target [protected]

Operation PIntCondMutex::operation [protected]

---

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

• syncthrd.h

---