ogdf::fast_multipole_embedder::FMEThread Class Reference

The fast multipole embedder work thread class. More...

#include <ogdf/energybased/fast_multipole_embedder/FMEThread.h>

Public Member Functions
	FMEThread (FMEThreadPool *pThreadPool, uint32_t threadNr)
	construtor
bool	isMainThread () const
	returns true if this is the main thread ( the main thread is always the first thread )
uint32_t	numThreads () const
	returns the total number of threads in the pool
void	operator() ()
	the main work function
void	setTask (FMETask *pTask)
	sets the actual task
void	sync ()
	thread sync call
uint32_t	threadNr () const
	returns the index of the thread ( 0.. numThreads()-1 )
FMEThreadPool *	threadPool () const
	returns the ThreadPool this thread belongs to
void	unixSetAffinity ()

Private Member Functions
	FMEThread (const FMEThread &)
FMEThread &	operator= (const FMEThread &)

Private Attributes
uint32_t	m_numThreads
FMETask *	m_pTask
FMEThreadPool *	m_pThreadPool
uint32_t	m_threadNr

Detailed Description

The fast multipole embedder work thread class.

Definition at line 76 of file FMEThread.h.

Constructor & Destructor Documentation

FMEThread() [1/2]

ogdf::fast_multipole_embedder::FMEThread::FMEThread	(	FMEThreadPool *	pThreadPool,
		uint32_t	threadNr
	)

construtor

FMEThread() [2/2]

ogdf::fast_multipole_embedder::FMEThread::FMEThread ( const FMEThread &  )

private

Member Function Documentation

isMainThread()

bool ogdf::fast_multipole_embedder::FMEThread::isMainThread ( ) const

inline

returns true if this is the main thread ( the main thread is always the first thread )

Definition at line 89 of file FMEThread.h.

numThreads()

uint32_t ogdf::fast_multipole_embedder::FMEThread::numThreads ( ) const

inline

returns the total number of threads in the pool

Definition at line 86 of file FMEThread.h.

operator()()

void ogdf::fast_multipole_embedder::FMEThread::operator() ( )

inline

the main work function

Definition at line 104 of file FMEThread.h.

operator=()

FMEThread & ogdf::fast_multipole_embedder::FMEThread::operator= ( const FMEThread &  )

private

setTask()

void ogdf::fast_multipole_embedder::FMEThread::setTask ( FMETask *  pTask )

inline

sets the actual task

Definition at line 112 of file FMEThread.h.

sync()

void ogdf::fast_multipole_embedder::FMEThread::sync

(

)

thread sync call

threadNr()

uint32_t ogdf::fast_multipole_embedder::FMEThread::threadNr ( ) const

inline

returns the index of the thread ( 0.. numThreads()-1 )

Definition at line 83 of file FMEThread.h.

threadPool()

FMEThreadPool * ogdf::fast_multipole_embedder::FMEThread::threadPool ( ) const

inline

returns the ThreadPool this thread belongs to

Definition at line 92 of file FMEThread.h.

unixSetAffinity()

void ogdf::fast_multipole_embedder::FMEThread::unixSetAffinity ( )

inline

Definition at line 100 of file FMEThread.h.

Member Data Documentation

m_numThreads

uint32_t ogdf::fast_multipole_embedder::FMEThread::m_numThreads

private

Definition at line 117 of file FMEThread.h.

m_pTask

FMETask* ogdf::fast_multipole_embedder::FMEThread::m_pTask

private

Definition at line 121 of file FMEThread.h.

m_pThreadPool

FMEThreadPool* ogdf::fast_multipole_embedder::FMEThread::m_pThreadPool

private

Definition at line 119 of file FMEThread.h.

m_threadNr

uint32_t ogdf::fast_multipole_embedder::FMEThread::m_threadNr

private

Definition at line 115 of file FMEThread.h.

---

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

• include/ogdf/energybased/fast_multipole_embedder/FMEThread.h