OpenSceneGraph  3.5.1
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::OperationThread Class Reference

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

Inheritance diagram for osg::OperationThread:
Inheritance graph
[legend]

Public Member Functions

 OperationThread ()
 
void setParent (Object *parent)
 
ObjectgetParent ()
 
const ObjectgetParent () const
 
void setOperationQueue (OperationQueue *opq)
 Set the OperationQueue. More...
 
OperationQueuegetOperationQueue ()
 Get the OperationQueue. More...
 
const OperationQueuegetOperationQueue () const
 Get the const OperationQueue. More...
 
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. 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...
 
osg::ref_ptr< OperationgetCurrentOperation ()
 Get the operation currently being run. More...
 
virtual void run ()
 Run does the opertion thread run loop. More...
 
void setDone (bool done)
 
bool getDone () const
 
virtual int cancel ()
 Cancel this graphics thread. More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () 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 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. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. 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...
 

Detailed Description

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

Constructor & Destructor Documentation

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

Member Function Documentation

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.

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

Cancel this graphics thread.

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

Get the operation currently being run.

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

Get the OperationQueue.

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

Get the const OperationQueue.

Object* osg::OperationThread::getParent ( )
inline
const Object* osg::OperationThread::getParent ( ) const
inline
void osg::OperationThread::remove ( Operation operation)

Remove operation from OperationQueue.

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

Remove named operation from OperationQueue.

void osg::OperationThread::removeAllOperations ( )

Remove all operations from OperationQueue.

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

Run does the opertion thread run loop.

Reimplemented in osg::GraphicsThread.

void osg::OperationThread::setDone ( bool  done)
void osg::OperationThread::setOperationQueue ( OperationQueue opq)

Set the OperationQueue.

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

Member Data Documentation

osg::ref_ptr<Operation> osg::OperationThread::_currentOperation
protected
OpenThreads::Atomic osg::OperationThread::_done
protected
osg::ref_ptr<OperationQueue> osg::OperationThread::_operationQueue
protected
observer_ptr<Object> osg::OperationThread::_parent
protected
OpenThreads::Mutex osg::OperationThread::_threadMutex
protected

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

osg logo
Generated at Wed Nov 11 2015 22:14:38 for the OpenSceneGraph by doxygen 1.8.10.