Standard_Condition Class Reference

This is boolean flag intended for communication between threads. One thread sets this flag to TRUE to indicate some event happened and another thread either waits this event or checks periodically its state to perform job. More...

#include <Standard_Condition.hxx>

Public Member Functions
	Standard_Condition (bool theIsSet=false)
	Default constructor.
	~Standard_Condition ()=default
	Destructor.
void	Set ()
	Set event into signaling state.
void	Reset ()
	Reset event (unset signaling state).
void	Wait ()
	Wait for Event (infinity).
bool	Wait (int theTimeMilliseconds)
	Wait for signal requested time.
bool	Check ()
	Do not wait for signal - just test it state.
bool	CheckReset ()
	Method perform two steps at-once - reset the event object and returns true if it was in signaling state.

Detailed Description

This is boolean flag intended for communication between threads. One thread sets this flag to TRUE to indicate some event happened and another thread either waits this event or checks periodically its state to perform job.

This class provides interface similar to WinAPI Event objects.

Constructor & Destructor Documentation

Standard_Condition()

Standard_Condition::Standard_Condition ( bool theIsSet = false )

inline

Default constructor.

Parameters

theIsSet

Initial flag state

~Standard_Condition()

Standard_Condition::~Standard_Condition ( )

default

Destructor.

Member Function Documentation

Check()

bool Standard_Condition::Check ( )

inline

Do not wait for signal - just test it state.

Returns

true if get event

CheckReset()

bool Standard_Condition::CheckReset ( )

inline

Method perform two steps at-once - reset the event object and returns true if it was in signaling state.

Returns

true if event object was in signaling state.

Reset()

void Standard_Condition::Reset ( )

inline

Reset event (unset signaling state).

Set()

void Standard_Condition::Set ( )

inline

Set event into signaling state.

Wait() [1/2]

void Standard_Condition::Wait ( )

inline

Wait for Event (infinity).

Wait() [2/2]

bool Standard_Condition::Wait ( int theTimeMilliseconds )

inline

Wait for signal requested time.

Parameters

theTimeMilliseconds

wait limit in milliseconds

Returns

true if get event

---

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

• Standard_Condition.hxx