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

Inheritance diagram for osg::OperationThread:

Public Member Functions
	OperationThread ()

void	setParent (Object *parent)

Object *	getParent ()

const Object *	getParent () const

void	setOperationQueue (OperationQueue *opq)
	Set the OperationQueue. More...

OperationQueue *	getOperationQueue ()
	Get the OperationQueue. More...

const OperationQueue *	getOperationQueue () 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< Operation >	getCurrentOperation ()
	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)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...

	Referenced (const Referenced &)

Referenced &	operator= (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::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...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () 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...

Public Member Functions inherited from OpenThreads::Thread
	Thread ()
	Constructor. More...

virtual	~Thread ()
	Destructor. More...

size_t	getThreadId ()
	Get a unique thread id. More...

size_t	getProcessId ()
	Get the thread's process id. More...

int	start ()
	Start the thread. More...

int	startThread ()

int	testCancel ()
	Test the cancel state of the thread. More...

int	setSchedulePriority (ThreadPriority priority)
	Set the thread's schedule priority. More...

int	getSchedulePriority ()
	Get the thread's schedule priority (if able) More...

int	setSchedulePolicy (ThreadPolicy policy)
	Set the thread's scheduling policy (if able) More...

int	getSchedulePolicy ()
	Get the thread's policy (if able) More...

int	setStackSize (size_t size)
	Set the thread's desired stack size (in bytes). More...

size_t	getStackSize ()
	Get the thread's desired stack size. More...

void	printSchedulingInfo ()
	Print the thread's scheduling information to stdout. More...

int	detach ()
	Detach the thread from the calling process. More...

int	join ()
	Join the calling process with the thread. More...

int	setCancelModeDisable ()
	Disable thread cancellation altogether. More...

int	setCancelModeAsynchronous ()
	Mark the thread to cancel asynchronously on Thread::cancel(). More...

int	setCancelModeDeferred ()
	Mark the thread to cancel at the earliest convenience on Thread::cancel() (This is the default) More...

bool	isRunning ()
	Query the thread's running status. More...

virtual void	cancelCleanup ()
	Thread's cancel cleanup routine, called upon cancel(), after the cancellation has taken place, but before the thread exits completely. More...

void *	getImplementation ()

int	setProcessorAffinity (const Affinity &affinity)
	Set the Thread's processor affinity to all, a single CPU or multiple CPU's This call must be made before start() or startThread() and has no effect after the thread has been running. 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
Public Types inherited from OpenThreads::Thread
enum	ThreadPriority { THREAD_PRIORITY_MAX, THREAD_PRIORITY_HIGH, THREAD_PRIORITY_NOMINAL, THREAD_PRIORITY_LOW, THREAD_PRIORITY_MIN, THREAD_PRIORITY_DEFAULT }
	Enumerated Type for thread priority. More...

enum	ThreadPolicy { THREAD_SCHEDULE_FIFO, THREAD_SCHEDULE_ROUND_ROBIN, THREAD_SCHEDULE_TIME_SHARE, THREAD_SCHEDULE_DEFAULT }
	Enumerated Type for thread scheduling policy. More...

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	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Static Public Member Functions inherited from OpenThreads::Thread
static int	SetConcurrency (int concurrencyLevel)
	Set the concurrency level for a running application. More...

static int	GetConcurrency ()
	Get the concurrency level for a running application. More...

static Thread *	CurrentThread ()
	Return a pointer to the current running thread, returns NULL for a non OpenThreads thread. More...

static size_t	CurrentThreadId ()
	Return the id of the current thread. More...

static void	Init ()
	Initialize Threading in a program. More...

static int	YieldCurrentThread ()
	Yield the processor. More...

static ThreadPriority	GetMasterPriority ()
	This method will return the ThreadPriority of the master process. More...

static int	microSleep (unsigned int microsec)
	microSleep method, equivalent to the posix usleep(microsec). More...

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.

Reimplemented from OpenThreads::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 ( Operation * operation )

Remove operation from OperationQueue.

◆ remove() [2/2]

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

Remove named 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.

Implements OpenThreads::Thread.

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/OperationThread

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OperationThread()

◆ ~OperationThread()

Member Function Documentation

◆ add()

◆ cancel()

◆ getCurrentOperation()

◆ getDone()

◆ getOperationQueue() [1/2]

◆ getOperationQueue() [2/2]

◆ getParent() [1/2]

◆ getParent() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeAllOperations()

◆ run()

◆ setDone()

◆ setOperationQueue()

◆ setParent()

Member Data Documentation

◆ _currentOperation

◆ _done

◆ _operationQueue

◆ _parent

◆ _threadMutex