This class describes an Open MP process. More...

#include <OMP_Thread.h>

Inheritance diagram for OMP_Thread:

Collaboration diagram for OMP_Thread:

Public Member Functions
virtual tMemSize	getMemorySize () const
	return the memory size of the class and the memory size of all its attributes/associations More...

Public Member Functions inherited from CORE_Object
template<class T >
std::shared_ptr< T >	getSharedPointer ()
	return the shared pointer for this More...

template<class T >
std::shared_ptr< const T >	getConstSharedPointer () const
	return a const shared pointer for this More...

virtual tMemSize	getContentsMemorySize () const
	return nthe memory size of the included associations More...

template<class T >
tBoolean	isInstanceOf () const
	test if the clas T is an instance of this class More...

tString	getClassName () const
	return the name of the class More...

tString	getPointerString () const
	retrun the pointer of the class as a string More...

tString	getIdentityString () const
	retrun the string identification of the class More...

virtual tString	toString () const
	return the string representation of the object node More...

Static Public Member Functions
static CORE_UniquePointer< OMP_Thread >	New ()
	create an instance of thread More...

static void	SetThreadsNumber (const tIndex &nThreads)
	set the number of threads More...

static tBoolean	IsOpenMPMultiThreaded ()
	return true if the program is multithreaded by OpenMP More...

static tInteger	GetThreadId ()
	get the thread id More...

static tInteger	GetThreadsNumber ()
	get the threads number More...

static const tInteger &	GetMaxThreadsNumber ()
	get the max threads number More...

static tULLInt	GetTime ()
	get time More...

static tULLInt	GetDuration (const tULLInt &startTime)
	get duration More...

static tInteger	SetThreadsOptions (const CORE_OptionsList &options)
	set the threads data from the options More...

Static Public Member Functions inherited from CORE_Object
static tBoolean	EnableMemoryStack (const tBoolean &isMemoryChecked)
	enable the memory stack More...

static void	EnableMemoryStack ()
	enable the memory stack

static void	DisableMemoryStack ()
	disable the memory stack

static tBoolean	IsMemoryStackEnabled ()
	return trur if the memory stack is enabled

static tString	MemoryStackToString ()
	get the memory stack in string More...

static tIndex	GetRegisteredClassesNumber ()
	get the memory stack in string More...

Protected Member Functions
	OMP_Thread (void)
	create an object

virtual	~OMP_Thread (void)
	destroy an object.

Protected Member Functions inherited from CORE_Object
	CORE_Object ()
	build an instance of the object

virtual	~CORE_Object ()
	destroy the instance of object std

Detailed Description

This class describes an Open MP process.

It manages :

the number or used threads.
the cumulative times spent in methods to profile a code.

Author
Stephane Despreaux

Version
1.0

Member Function Documentation

◆ GetDuration()

static tULLInt OMP_Thread::GetDuration ( const tULLInt & startTime )

inlinestatic

get duration

Returns: the time in clocks number

◆ GetMaxThreadsNumber()

static const tInteger& OMP_Thread::GetMaxThreadsNumber ( )

inlinestatic

get the max threads number

Returns: the max number of threads

◆ getMemorySize()

virtual tMemSize OMP_Thread::getMemorySize ( ) const

inlinevirtual

return the memory size of the class and the memory size of all its attributes/associations

Returns

the memory size of the class and the memory size of its attributes/associations in bytes The mamory size is :

the added size of the base classes which contains:
- the primary attributes size depends on the order: (first delare the smallest attributes size
- all virtual functions costs 4 bytes by virtual function
- virtual inherihtance will increase of 4 bytes
we add the size of the contains values of the attributes : for example the size of a string is the length of the string 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Reimplemented from CORE_Object.

◆ GetThreadId()

static tInteger OMP_Thread::GetThreadId ( )

inlinestatic

get the thread id

Returns: the id of the thread

◆ GetThreadsNumber()

static tInteger OMP_Thread::GetThreadsNumber ( )

inlinestatic

get the threads number

Returns: the number of threads

◆ GetTime()

static tULLInt OMP_Thread::GetTime ( )

inlinestatic

get time

Returns: the CPU time in the thread

◆ IsOpenMPMultiThreaded()

static tBoolean OMP_Thread::IsOpenMPMultiThreaded ( )

inlinestatic

return true if the program is multithreaded by OpenMP

Returns: true if the program is multithreaded by OpenMP

◆ New()

static CORE_UniquePointer<OMP_Thread> OMP_Thread::New ( )

inlinestatic

create an instance of thread

Returns: an unique instance of the class

◆ SetThreadsNumber()

static void OMP_Thread::SetThreadsNumber ( const tIndex & nThreads )

inlinestatic

set the number of threads

Parameters

[in] nThreads the number of threads

◆ SetThreadsOptions()

static tInteger OMP_Thread::SetThreadsOptions ( const CORE_OptionsList & options )

inlinestatic

set the threads data from the options

Parameters

[in] options default values of the options

Returns: the number of threads used by default 1

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

/home/despreau/Developpement/CPP/devcpp20/include/openmp/monothread/OMP_Thread.h
/home/despreau/Developpement/CPP/devcpp20/src/openmp/monothread/OMP_Thread.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ GetDuration()

◆ GetMaxThreadsNumber()

◆ getMemorySize()

◆ GetThreadId()

◆ GetThreadsNumber()

◆ GetTime()

◆ IsOpenMPMultiThreaded()

◆ New()

◆ SetThreadsNumber()

◆ SetThreadsOptions()