This class functions exactly like an int, except that the following operators are atomic: ++, –, +=, -=, *=, /=, %=, &=, |=, ^=, <<=, and >>=. More...

#include <AtomicInteger.h>

Public Member Functions
	AtomicInteger ()

	AtomicInteger (int value)

	~AtomicInteger ()

AtomicInteger &	operator= (int value)

	operator int () const

int	operator++ ()

int	operator++ (int)

int	operator-- ()

int	operator-- (int)

AtomicInteger &	operator+= (int value)

AtomicInteger &	operator-= (int value)

AtomicInteger &	operator*= (int value)

AtomicInteger &	operator/= (int value)

AtomicInteger &	operator%= (int value)

AtomicInteger &	operator&= (int value)

AtomicInteger &	operator\|= (int value)

AtomicInteger &	operator^= (int value)

AtomicInteger &	operator<<= (int value)

AtomicInteger &	operator>>= (int value)

bool	operator== (int value) const

bool	operator!= (int value) const

Detailed Description

This class functions exactly like an int, except that the following operators are atomic: ++, –, +=, -=, *=, /=, %=, &=, |=, ^=, <<=, and >>=.

For example, suppose myInt is an AtomicInteger that initially has the value 5. If two threads both evaluate the expression ++myInt, it is guaranteed that one thread will get the value 6 and the other will get the value 7, and myInt will equal 7 afterward. This would not be true for an ordinary int.

On most processors, this form of thread-safety can be implemented in a lightweight way which is much faster than acquiring a lock. When possible, this class uses these mechanisms to achieve maximum efficiency. On platforms that do not support atomic operations directly it uses locking, which is slower but still guaranteed to produce a correct result.

Constructor & Destructor Documentation

SimTK::AtomicInteger::AtomicInteger ( )

SimTK::AtomicInteger::AtomicInteger ( int value )

SimTK::AtomicInteger::~AtomicInteger ( )

Member Function Documentation

AtomicInteger& SimTK::AtomicInteger::operator= ( int value )

SimTK::AtomicInteger::operator int ( ) const

int SimTK::AtomicInteger::operator++ ( )

int SimTK::AtomicInteger::operator++ ( int )

int SimTK::AtomicInteger::operator-- ( )

int SimTK::AtomicInteger::operator-- ( int )

AtomicInteger& SimTK::AtomicInteger::operator+= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator-= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator*= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator/= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator%= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator&= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator|= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator^= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator<<= ( int value )

AtomicInteger& SimTK::AtomicInteger::operator>>= ( int value )

bool SimTK::AtomicInteger::operator== ( int value ) const

bool SimTK::AtomicInteger::operator!= ( int value ) const

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

AtomicInteger.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation