ERC CISST - cisst software

---

osaThreadId Class Reference

#include <osaThread.h>

Collaboration diagram for osaThreadId:

[legend]List of all members.

---

Detailed Description

ThreadId type.

Abstract the thread Id based on the OS. Some OSs use a native C type (e.g., unsigned long) to identify threads but others use more complex

structs hence the need for a class to define the == and << operators.

See also:

osaGetCurrentThreadId

Definition at line 74 of file osaThread.h.

Public Member Functions

• osaThreadId (void)
• ~osaThreadId ()
• bool Equal (const osaThreadId &other) const
• bool operator== (const osaThreadId &other) const
• bool operator!= (const osaThreadId &other) const
• void ToStream (std::ostream &outputStream) const

Friends

• class osaThread
• class osaThreadTest
• CISST_EXPORT osaThreadId osaGetCurrentThreadId (void)

---

Constructor & Destructor Documentation

osaThreadId::osaThreadId

(

void

)

Default constructor. Does nothing but checking that the internal structure use to store the OS specific information for osaThreadId is large enough using CMN_ASSERT.

osaThreadId::~osaThreadId

(

)

Default destructor. Does nothing.

---

Member Function Documentation

bool osaThreadId::Equal

(

const osaThreadId &

other

)

const

Method to compare two thread Ids

bool osaThreadId::operator==

(

const osaThreadId &

other

)

const [inline]

Operator to compare two thread Ids

Definition at line 102 of file osaThread.h.

bool osaThreadId::operator!=

(

const osaThreadId &

other

)

const [inline]

Operator to compare two thread Ids

Definition at line 107 of file osaThread.h.

void osaThreadId::ToStream

(

std::ostream &

outputStream

)

const

Print to stream

Referenced by operator<<().

---

Friends And Related Function Documentation

CISST_EXPORT osaThreadId osaGetCurrentThreadId

(

void

)

[friend]

Get the ID of the currently executing thread.

See also:

osaThreadId

---

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

• osaThread.h

---