OpenSceneGraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
osg::OperationQueue Class Reference
Inheritance diagram for osg::OperationQueue:
Inheritance graph
[legend]

Public Types

typedef std::set< OperationThread * > OperationThreads
 

Public Member Functions

 OperationQueue ()
 
osg::ref_ptr< OperationgetNextOperation (bool blockIfEmpty=false)
 Get the next operation from the operation queue. More...
 
bool empty ()
 Return true if the operation queue is empty. More...
 
unsigned int getNumOperationsInQueue ()
 Return the num of pending operations that are sitting in the OperationQueue. More...
 
void add (Operation *operation)
 Add operation to end of OperationQueue, this will be executed by the operation thread once this operation gets to the head of the queue. More...
 
void remove (Operation *operation)
 Remove operation from OperationQueue. More...
 
void remove (const std::string &name)
 Remove named operation from OperationQueue. More...
 
void removeAllOperations ()
 Remove all operations from OperationQueue. More...
 
void runOperations (Object *callingObject=0)
 Run the operations. More...
 
void releaseAllOperations ()
 Call release on all operations. More...
 
void releaseOperationsBlock ()
 Release operations block that is used to block threads that are waiting on an empty operations queue. More...
 
const OperationThreadsgetOperationThreads () const
 Get the set of OperationThreads that are sharing this OperationQueue. More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Types

typedef std::list< osg::ref_ptr< Operation > > Operations
 

Protected Member Functions

virtual ~OperationQueue ()
 
void addOperationThread (OperationThread *thread)
 
void removeOperationThread (OperationThread *thread)
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

OpenThreads::Mutex _operationsMutex
 
osg::ref_ptr< osg::RefBlock_operationsBlock
 
Operations _operations
 
Operations::iterator _currentOperationIterator
 
OperationThreads _operationThreads
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Friends

class OperationThread
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Member Typedef Documentation

◆ Operations

typedef std::list< osg::ref_ptr<Operation> > osg::OperationQueue::Operations
protected

◆ OperationThreads

Constructor & Destructor Documentation

◆ OperationQueue()

osg::OperationQueue::OperationQueue ( )

◆ ~OperationQueue()

virtual osg::OperationQueue::~OperationQueue ( )
protectedvirtual

Member Function Documentation

◆ add()

void osg::OperationQueue::add ( Operation operation)

Add operation to end of OperationQueue, this will be executed by the operation thread once this operation gets to the head of the queue.

◆ addOperationThread()

void osg::OperationQueue::addOperationThread ( OperationThread thread)
protected

◆ empty()

bool osg::OperationQueue::empty ( )

Return true if the operation queue is empty.

◆ getNextOperation()

osg::ref_ptr<Operation> osg::OperationQueue::getNextOperation ( bool  blockIfEmpty = false)

Get the next operation from the operation queue.

Return null ref_ptr<> if no operations are left in queue.

◆ getNumOperationsInQueue()

unsigned int osg::OperationQueue::getNumOperationsInQueue ( )

Return the num of pending operations that are sitting in the OperationQueue.

◆ getOperationThreads()

const OperationThreads& osg::OperationQueue::getOperationThreads ( ) const
inline

Get the set of OperationThreads that are sharing this OperationQueue.

◆ releaseAllOperations()

void osg::OperationQueue::releaseAllOperations ( )

Call release on all operations.

◆ releaseOperationsBlock()

void osg::OperationQueue::releaseOperationsBlock ( )

Release operations block that is used to block threads that are waiting on an empty operations queue.

◆ remove() [1/2]

void osg::OperationQueue::remove ( Operation operation)

Remove operation from OperationQueue.

◆ remove() [2/2]

void osg::OperationQueue::remove ( const std::string &  name)

Remove named operation from OperationQueue.

◆ removeAllOperations()

void osg::OperationQueue::removeAllOperations ( )

Remove all operations from OperationQueue.

◆ removeOperationThread()

void osg::OperationQueue::removeOperationThread ( OperationThread thread)
protected

◆ runOperations()

void osg::OperationQueue::runOperations ( Object callingObject = 0)

Run the operations.

Friends And Related Function Documentation

◆ OperationThread

friend class OperationThread
friend

Member Data Documentation

◆ _currentOperationIterator

Operations::iterator osg::OperationQueue::_currentOperationIterator
protected

◆ _operations

Operations osg::OperationQueue::_operations
protected

◆ _operationsBlock

osg::ref_ptr<osg::RefBlock> osg::OperationQueue::_operationsBlock
protected

◆ _operationsMutex

OpenThreads::Mutex osg::OperationQueue::_operationsMutex
protected

◆ _operationThreads

OperationThreads osg::OperationQueue::_operationThreads
protected

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