Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

nvutil::Incarnation Class Reference

This class abstracts an incarnation count. More...

#include <Incarnation.h>

List of all members.

Public Member Functions

 Incarnation ()
 Default constructor.
 Incarnation (int incarnation)
 Alternative constructor.
Incarnationoperator= (const Incarnation &rhs)
 Asignment operator.
Incarnationoperator= (int incarnation)
 Asignment operator.
bool operator== (const Incarnation &rhs)
 Comparison operator.
bool operator!= (const Incarnation &rhs)
 Comparison operator.
Incarnationoperator++ ()
 Preincrement operator.
const Incarnation operator++ (int)
 Postincrement operator.


Detailed Description

This class abstracts an incarnation count.

The main feature is that the embedded counter will always be initialized to a defined value. This class also provides convenient assignment, comparison and incrementation of the embedded counter.


Constructor & Destructor Documentation

nvutil::Incarnation::Incarnation  )  [inline]
 

Default constructor.

The embedded counter will be initialized to -1.

nvutil::Incarnation::Incarnation int  incarnation  )  [inline, explicit]
 

Alternative constructor.

The embedded counter will be initialized to incarnation.


Member Function Documentation

Incarnation & nvutil::Incarnation::operator= const Incarnation rhs  )  [inline]
 

Asignment operator.

Overrides this object's data with that of the Incarnation object referenced by rhs.

Incarnation & nvutil::Incarnation::operator= int  incarnation  )  [inline]
 

Asignment operator.

Overrides the value of the embedded counter with incarnation.

bool nvutil::Incarnation::operator== const Incarnation rhs  )  [inline]
 

Comparison operator.

Returns:
true if the embedded counter of the Incarnation object referenced by rhs is equal to this object's embedded counter, false otherwise.

bool nvutil::Incarnation::operator!= const Incarnation rhs  )  [inline]
 

Comparison operator.

Returns:
true if the embedded counter of the Incarnation object referenced by rhs is not equal to this object's embedded counter, false otherwise.

Incarnation & nvutil::Incarnation::operator++  )  [inline]
 

Preincrement operator.

Increments the embedded counter by one.

Returns:
This object as a l-value object.

const Incarnation nvutil::Incarnation::operator++ int   )  [inline]
 

Postincrement operator.

Increments the embedded counter by one.

Returns:
A const Incarnation object of which the embedded counter's value is equal to the value, the embedded counter of this object had immediately prior to the call to this operator.


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:21:13 2005 for NVSGSDK by NVIDIA