OSG::CondVar

OSG::CondVar Class Reference

#include <OSGCondVar.h>

List of all members.


Public Types

typedef MPCondVarType Type

Public Member Functions

CondVar


void acquire (void)
void release (void)
bool request (void)
bool wait (const Int32 timeToWait=-1)
void signal ()
void broadcast ()

Static Public Member Functions

Get


static CondVar * get (const Char8 *szName)
static CondVar * find (const Char8 *szName)
static CondVar * create (void)
static const MPCondVarType & getClassType (void)

Protected Types

typedef CondVarBase Inherited

Protected Member Functions

Constructors


 CondVar (void)
 CondVar (const Char8 *szName, UInt32 uiId)
Destructor


virtual ~CondVar (void)

Static Protected Member Functions

Construction


static CondVar * create (const Char8 *szName, UInt32 uiId)

Static Protected Attributes

static MPCondVarType _type

Private Member Functions

 CondVar (const CondVar &source)
 prohibit default function (move to 'public' if needed)
void operator= (const CondVar &source)
 prohibit default function (move to 'public' if needed)

Friends

class MPFieldStore< CondVar >

Detailed Description

Definition at line 427 of file OSGCondVar.h.

Member Typedef Documentation

typedef MPCondVarType OSG::CondVar::Type

Definition at line 433 of file OSGCondVar.h.

typedef CondVarBase OSG::CondVar::Inherited [protected]

Definition at line 463 of file OSGCondVar.h.

Constructor & Destructor Documentation

CondVar::CondVar ( void   )  [protected]

Definition at line 654 of file OSGCondVar.cpp.

Referenced by create().

00654                      :
00655     Inherited()
00656 {
00657 }

CondVar::CondVar ( const Char8 *  szName,
UInt32  uiId 
) [protected]

Definition at line 659 of file OSGCondVar.cpp.

00659                                                  :
00660     Inherited(szName, uiId)
00661 {
00662 }

CondVar::~CondVar ( void   )  [protected, virtual]

Definition at line 666 of file OSGCondVar.cpp.

References OSG::ThreadManager::removeCondVar(), and OSG::ThreadManager::the().

00667 {
00668     ThreadManager::the()->removeCondVar(this);
00669 
00670     shutdown();
00671 }

OSG::CondVar::CondVar ( const CondVar &  source  )  [private]

Member Function Documentation

CondVar * CondVar::get ( const Char8 *  szName  )  [static]

Definition at line 624 of file OSGCondVar.cpp.

References OSG::ThreadManager::getCondVar(), and OSG::ThreadManager::the().

Referenced by create().

00625 {
00626     return ThreadManager::the()->getCondVar(szName, "OSGCondVar");
00627 }

CondVar * CondVar::find ( const Char8 *  szName  )  [static]

Definition at line 629 of file OSGCondVar.cpp.

References OSG::ThreadManager::findCondVar(), and OSG::ThreadManager::the().

00630 {
00631     return ThreadManager::the()->findCondVar(szName);
00632 }

CondVar * OSG::CondVar::create ( void   )  [inline, static]

Definition at line 192 of file OSGCondVar.inl.

References get().

00193 {
00194     return CondVar::get(NULL);
00195 }

const MPCondVarType & OSG::CondVar::getClassType ( void   )  [inline, static]

Definition at line 198 of file OSGCondVar.inl.

References _type.

00199 {
00200     return _type;
00201 }

void OSG::CondVar::acquire ( void   )  [inline]

Definition at line 206 of file OSGCondVar.inl.

Referenced by OSG::BackgroundLoaderBase::addRequest(), OSG::BackgroundLoaderBase::getNumPendingRequests(), OSG::BackgroundLoaderBase::getPendingDescriptionList(), OSG::BackgroundLoaderBase::loadProc(), OSG::BackgroundLoaderBase::processOne(), and OSG::BackgroundLoaderBase::removeRequest().

00207 {
00208     Inherited::acquire();
00209 }

void OSG::CondVar::release ( void   )  [inline]

Definition at line 212 of file OSGCondVar.inl.

Referenced by OSG::BackgroundLoaderBase::addRequest(), OSG::BackgroundLoaderBase::getNumPendingRequests(), OSG::BackgroundLoaderBase::getPendingDescriptionList(), OSG::BackgroundLoaderBase::loadProc(), OSG::BackgroundLoaderBase::processOne(), and OSG::BackgroundLoaderBase::removeRequest().

00213 {
00214     Inherited::release();
00215 }

bool OSG::CondVar::request ( void   )  [inline]

Definition at line 218 of file OSGCondVar.inl.

00219 {
00220     return Inherited::request();
00221 }

bool OSG::CondVar::wait ( const Int32  timeToWait = -1  )  [inline]

Definition at line 224 of file OSGCondVar.inl.

Referenced by OSG::BackgroundLoaderBase::loadProc().

00225 {
00226     return Inherited::wait(timeToWait);
00227 }

void OSG::CondVar::signal (  )  [inline]

Definition at line 230 of file OSGCondVar.inl.

Referenced by OSG::BackgroundLoaderBase::addRequest(), and OSG::BackgroundLoaderBase::removeRequest().

00231 {
00232     return Inherited::signal();
00233 }

void OSG::CondVar::broadcast (  )  [inline]

Definition at line 236 of file OSGCondVar.inl.

Referenced by OSG::BackgroundLoaderBase::stop().

00237 {
00238     return Inherited::broadcast();
00239 }

CondVar * CondVar::create ( const Char8 *  szName,
UInt32  uiId 
) [static, protected]

Definition at line 637 of file OSGCondVar.cpp.

References CondVar().

00638 {
00639     CondVar *returnValue = NULL;
00640 
00641     returnValue = new CondVar(szName, uiId);
00642 
00643     if(returnValue->init() == false)
00644     {
00645         delete returnValue;
00646         returnValue = NULL;
00647     }
00648 
00649     return returnValue;
00650 }

void OSG::CondVar::operator= ( const CondVar &  source  )  [private]

Friends And Related Function Documentation

friend class MPFieldStore< CondVar > [friend]

Definition at line 493 of file OSGCondVar.h.

Member Data Documentation

MPCondVarType CondVar::_type [static, protected]

Definition at line 465 of file OSGCondVar.h.

Referenced by getClassType().

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