Dataflow Runtime API  3.0.3.0
Public Member Functions | List of all members
imt::base::os::winec7::ThreadIdMapper Class Reference

A simple helper class which provides the means to identify threads. More...

#include <Imt.Base.OS.WinEC7/ThreadIdMapper.h>

Inheritance diagram for imt::base::os::winec7::ThreadIdMapper:
imt::base::os::winec7::SingleInstance< ThreadIdMapper >

Public Member Functions

 ThreadIdMapper (void)
 Constructor. More...
 
virtual ~ThreadIdMapper (void)
 Destructor. More...
 
uint32_t getNumberOfRegisteredThreads (void) const
 Returns the number of thread which are currently registered in the mapper. More...
 
void registerThread (const uint32_t threadId, const std::wstring &threadName)
 Registers a thread. More...
 
std::wstring getThreadName (const uint32_t threadId)
 Returns the name of a thread for a given id. More...
 
void removeThread (const std::wstring &threadName)
 Removes a thread from the map. More...
 
void removeThread (const uint32_t threadId)
 Removes a thread from the map. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from imt::base::os::winec7::SingleInstance< ThreadIdMapper >
static ThreadIdMappergetInstance (void)
 Returns singleton. More...
 
static bool isInstanceAvailable (void)
 Returns true, if instance is available. More...
 
- Protected Member Functions inherited from imt::base::os::winec7::SingleInstance< ThreadIdMapper >
 SingleInstance (void)
 Constructor. More...
 
virtual ~SingleInstance (void)
 Destructor. More...
 
- Static Protected Attributes inherited from imt::base::os::winec7::SingleInstance< ThreadIdMapper >
static ThreadIdMappers_pSingle
 Refers to created instance of that type Write your own getter for that member if requested. More...
 

Detailed Description

A simple helper class which provides the means to identify threads.

Constructor & Destructor Documentation

◆ ThreadIdMapper()

imt::base::os::winec7::ThreadIdMapper::ThreadIdMapper ( void  )
explicit

Constructor.

◆ ~ThreadIdMapper()

virtual imt::base::os::winec7::ThreadIdMapper::~ThreadIdMapper ( void  )
virtual

Destructor.

Member Function Documentation

◆ getNumberOfRegisteredThreads()

uint32_t imt::base::os::winec7::ThreadIdMapper::getNumberOfRegisteredThreads ( void  ) const

Returns the number of thread which are currently registered in the mapper.

Returns
Number of registered threads

◆ getThreadName()

std::wstring imt::base::os::winec7::ThreadIdMapper::getThreadName ( const uint32_t  threadId)

Returns the name of a thread for a given id.

Parameters
threadIdThe numeric id of the thread
Returns
The name of the thread

◆ registerThread()

void imt::base::os::winec7::ThreadIdMapper::registerThread ( const uint32_t  threadId,
const std::wstring &  threadName 
)

Registers a thread.

Parameters
threadIdThe numeric id of the thread
threadNameThe name of the thread

◆ removeThread() [1/2]

void imt::base::os::winec7::ThreadIdMapper::removeThread ( const std::wstring &  threadName)

Removes a thread from the map.

Parameters
threadNameThe name of the thread

◆ removeThread() [2/2]

void imt::base::os::winec7::ThreadIdMapper::removeThread ( const uint32_t  threadId)

Removes a thread from the map.

Parameters
threadIdThe numeric id of the thread

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