OpenSceneGraph 3.6.5
osg::OperationThread Class Reference

OperationThread is a helper class for running Operation within a single thread. More...

#include <OperationThread>

Inheritance diagram for osg::OperationThread:

Public Member Functions

 OperationThread ()
 
void setParent (Object *parent)
 
ObjectgetParent ()
 
const ObjectgetParent () const
 
void setOperationQueue (OperationQueue *opq)
 Set the OperationQueue.
 
OperationQueuegetOperationQueue ()
 Get the OperationQueue.
 
const OperationQueuegetOperationQueue () const
 Get the const OperationQueue.
 
void add (Operation *operation)
 Add operation to end of OperationQueue, this will be executed by the graphics thread once this operation gets to the head of the queue.
 
void remove (Operation *operation)
 Remove operation from OperationQueue.
 
void remove (const std::string &name)
 Remove named operation from OperationQueue.
 
void removeAllOperations ()
 Remove all operations from OperationQueue.
 
osg::ref_ptr< OperationgetCurrentOperation ()
 Get the operation currently being run.
 
virtual void run ()
 Run does the opertion thread run loop.
 
void setDone (bool done)
 
bool getDone () const
 
virtual int cancel ()
 Cancel this graphics thread.
 
- 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.
 
 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.
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
 
int referenceCount () const
 Return the number of pointers currently referencing this object.
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.
 

Protected Member Functions

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

Protected Attributes

observer_ptr< Object_parent
 
OpenThreads::Atomic _done
 
OpenThreads::Mutex _threadMutex
 
osg::ref_ptr< OperationQueue_operationQueue
 
osg::ref_ptr< Operation_currentOperation
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

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

Detailed Description

OperationThread is a helper class for running Operation within a single thread.

Constructor & Destructor Documentation

◆ OperationThread()

osg::OperationThread::OperationThread ( )

◆ ~OperationThread()

virtual osg::OperationThread::~OperationThread ( )
protectedvirtual

Member Function Documentation

◆ add()

void osg::OperationThread::add ( Operation * operation)

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

◆ cancel()

virtual int osg::OperationThread::cancel ( )
virtual

Cancel this graphics thread.

◆ getCurrentOperation()

osg::ref_ptr< Operation > osg::OperationThread::getCurrentOperation ( )
inline

Get the operation currently being run.

◆ getDone()

bool osg::OperationThread::getDone ( ) const
inline

◆ getOperationQueue() [1/2]

OperationQueue * osg::OperationThread::getOperationQueue ( )
inline

Get the OperationQueue.

◆ getOperationQueue() [2/2]

const OperationQueue * osg::OperationThread::getOperationQueue ( ) const
inline

Get the const OperationQueue.

◆ getParent() [1/2]

Object * osg::OperationThread::getParent ( )
inline

◆ getParent() [2/2]

const Object * osg::OperationThread::getParent ( ) const
inline

◆ remove() [1/2]

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

Remove named operation from OperationQueue.

◆ remove() [2/2]

void osg::OperationThread::remove ( Operation * operation)

Remove operation from OperationQueue.

◆ removeAllOperations()

void osg::OperationThread::removeAllOperations ( )

Remove all operations from OperationQueue.

◆ run()

virtual void osg::OperationThread::run ( )
virtual

Run does the opertion thread run loop.

Reimplemented in osg::GraphicsThread.

◆ setDone()

void osg::OperationThread::setDone ( bool done)

◆ setOperationQueue()

void osg::OperationThread::setOperationQueue ( OperationQueue * opq)

Set the OperationQueue.

◆ setParent()

void osg::OperationThread::setParent ( Object * parent)
inline

Member Data Documentation

◆ _currentOperation

osg::ref_ptr<Operation> osg::OperationThread::_currentOperation
protected

◆ _done

OpenThreads::Atomic osg::OperationThread::_done
protected

◆ _operationQueue

osg::ref_ptr<OperationQueue> osg::OperationThread::_operationQueue
protected

◆ _parent

observer_ptr<Object> osg::OperationThread::_parent
protected

◆ _threadMutex

OpenThreads::Mutex osg::OperationThread::_threadMutex
protected

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

osg logo
Generated at Wed Jul 17 2024 00:00:00 for the OpenSceneGraph by doxygen 1.12.0.