UT_TaskScope Class Reference

#include <UT_TaskScope.h>

Inheritance diagram for UT_TaskScope:

Public Member Functions
	UT_TaskScope (const UT_TaskScope *parent, int thread)
	UT_TaskScope (const UT_TaskScope *parent)
	~UT_TaskScope ()
const UT_TaskScope *	getParent () const
	Return the parent of this task scope. More...
int	getThreadId () const
	Return the id of the assigned thread. More...
bool	isAncestor (const UT_TaskScope &parent) const
	Test if the given task scope is an ancestor of ours. More...

Static Public Member Functions
static const UT_TaskScope *	getCurrent (int thread)
static const UT_TaskScope *	getCurrent ()
static const UT_TaskScope &	getOrCreateCurrent (int thread)
static const UT_TaskScope &	getOrCreateCurrent ()
static const UT_TaskScope &	getOrCreateRoot (int thread)
static const UT_TaskScope &	getOrCreateRoot ()
Static Public Member Functions inherited from UT_SmallObject< UT_TaskScope >
static void *	operator new (size_t size)
	Regular new/delete operators. More...
static void	operator delete (void *p, size_t size)
	Regular new/delete operators. More...
static void *	operator new (size_t, void *p)
static void	operator delete (void *, void *)

Detailed Description

Scope object which defines a thread task, maintaining a parent-child hierarchy.

Definition at line 42 of file UT_TaskScope.h.

Constructor & Destructor Documentation

UT_TaskScope::UT_TaskScope ( const UT_TaskScope *  parent, int  thread  )

inlineexplicit

Definition at line 45 of file UT_TaskScope.h.

UT_TaskScope::UT_TaskScope ( const UT_TaskScope *  parent )

inlineexplicit

Definition at line 58 of file UT_TaskScope.h.

UT_TaskScope::~UT_TaskScope ( )

inline

Definition at line 71 of file UT_TaskScope.h.

Member Function Documentation

static const UT_TaskScope* UT_TaskScope::getCurrent ( int  thread )

inlinestatic

Obtain the current task scope from thread local storage.

Note

The return value is NULL if there is no current task scope.

Definition at line 92 of file UT_TaskScope.h.

static const UT_TaskScope* UT_TaskScope::getCurrent ( )

inlinestatic

Obtain the current task scope from thread local storage.

Note

The return value is NULL if there is no current task scope.

Definition at line 96 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateCurrent ( int  thread )

inlinestatic

Obtain the current task scope from thread local storage, creating one if there is none.

Definition at line 105 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateCurrent ( )

inlinestatic

Obtain the current task scope from thread local storage, creating one if there is none.

Definition at line 113 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateRoot ( int  thread )

inlinestatic

Obtain the root task scope from thread local storage, creating one if there is none.

Definition at line 122 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateRoot ( )

inlinestatic

Obtain the root task scope from thread local storage, creating one if there is none.

Definition at line 135 of file UT_TaskScope.h.

const UT_TaskScope* UT_TaskScope::getParent ( ) const

inline

Return the parent of this task scope.

Definition at line 84 of file UT_TaskScope.h.

int UT_TaskScope::getThreadId ( ) const

inline

Return the id of the assigned thread.

Definition at line 87 of file UT_TaskScope.h.

bool UT_TaskScope::isAncestor ( const UT_TaskScope &  parent ) const

inline

Test if the given task scope is an ancestor of ours.

Definition at line 142 of file UT_TaskScope.h.

---

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

• UT/UT_TaskScope.h