Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

id< bitsIndex, bitsMagic > Class Template Reference

storage class for ids More...

#include <id.h>

List of all members.

Public Types

enum  { BITS_INDEX = bitsIndex, BITS_MAGIC = bitsMagic, MAX_INDEX = 1<<(bitsIndex - 1), MAX_MAGIC = 1<<(bitsMagic - 1) }
 contains info about the id type More...


Public Member Functions

 id ()
 id (const uInt &v)
 ~id ()
id< bitsIndex, bitsMagic > & operator= (const id< bitsIndex, bitsMagic > &id_)
 assignment from an id of the same type

id< bitsIndex, bitsMagic > & operator= (const uInt &v)
 assignment from a uInt

 operator uInt () const
 uInt conversion operator

bool operator== (const id< bitsIndex, bitsMagic > &id_) const
 equality comparison operator for an id of the same type

bool operator!= (const id< bitsIndex, bitsMagic > &id_) const
 inequality comparison operator for an id of the same type

bool isNull () const
 returns true if id is null

template<uInt bitsIndex_, uInt bitsMagic_> id< bitsIndex, bitsMagic > & operator= (const id< bitsIndex_, bitsMagic_ > &id_)
 assignment from an id of a different type


Detailed Description

template<uInt bitsIndex, uInt bitsMagic>
class id< bitsIndex, bitsMagic >

storage class for ids

ids consist of a number formed of two parts an index and a magic number

Definition at line 56 of file id.h.


Member Enumeration Documentation

template<uInt bitsIndex, uInt bitsMagic>
anonymous enum
 

contains info about the id type

Enumeration values:
BITS_INDEX 
BITS_MAGIC 
MAX_INDEX 
MAX_MAGIC 

Definition at line 86 of file id.h.


Constructor & Destructor Documentation

template<uInt bitsIndex, uInt bitsMagic>
id< bitsIndex, bitsMagic >::id  )  [inline]
 

template<uInt bitsIndex, uInt bitsMagic>
id< bitsIndex, bitsMagic >::id const uInt v  )  [inline]
 

template<uInt bitsIndex, uInt bitsMagic>
id< bitsIndex, bitsMagic >::~id  )  [inline]
 


Member Function Documentation

template<uInt bitsIndex, uInt bitsMagic>
bool id< bitsIndex, bitsMagic >::isNull  )  const [inline]
 

returns true if id is null

Definition at line 74 of file id.h.

References id< bitsIndex, bitsMagic >::m_id.

template<uInt bitsIndex, uInt bitsMagic>
id< bitsIndex, bitsMagic >::operator uInt  )  const [inline]
 

uInt conversion operator

Definition at line 68 of file id.h.

References id< bitsIndex, bitsMagic >::m_id.

template<uInt bitsIndex, uInt bitsMagic>
bool id< bitsIndex, bitsMagic >::operator!= const id< bitsIndex, bitsMagic > &  id_  )  const [inline]
 

inequality comparison operator for an id of the same type

Definition at line 72 of file id.h.

References id< bitsIndex, bitsMagic >::m_id, and id< bitsIndex, bitsMagic >::operator!=().

Referenced by id< bitsIndex, bitsMagic >::operator!=().

template<uInt bitsIndex, uInt bitsMagic>
template<uInt bitsIndex_, uInt bitsMagic_>
id<bitsIndex,bitsMagic>& id< bitsIndex, bitsMagic >::operator= const id< bitsIndex_, bitsMagic_ > &  id_  )  [inline]
 

assignment from an id of a different type

Definition at line 77 of file id.h.

References Assert, id< bitsIndex, bitsMagic >::m_index, id< bitsIndex, bitsMagic >::m_magic, id< bitsIndex, bitsMagic >::MAX_INDEX, id< bitsIndex, bitsMagic >::MAX_MAGIC, and id< bitsIndex, bitsMagic >::operator=().

template<uInt bitsIndex, uInt bitsMagic>
id<bitsIndex,bitsMagic>& id< bitsIndex, bitsMagic >::operator= const uInt v  )  [inline]
 

assignment from a uInt

Definition at line 66 of file id.h.

References id< bitsIndex, bitsMagic >::m_id, and id< bitsIndex, bitsMagic >::operator=().

template<uInt bitsIndex, uInt bitsMagic>
id<bitsIndex,bitsMagic>& id< bitsIndex, bitsMagic >::operator= const id< bitsIndex, bitsMagic > &  id_  )  [inline]
 

assignment from an id of the same type

Definition at line 64 of file id.h.

References id< bitsIndex, bitsMagic >::m_id, and id< bitsIndex, bitsMagic >::operator=().

Referenced by id< bitsIndex, bitsMagic >::operator=().

template<uInt bitsIndex, uInt bitsMagic>
bool id< bitsIndex, bitsMagic >::operator== const id< bitsIndex, bitsMagic > &  id_  )  const [inline]
 

equality comparison operator for an id of the same type

Definition at line 70 of file id.h.

References id< bitsIndex, bitsMagic >::m_id, and id< bitsIndex, bitsMagic >::operator==().

Referenced by id< bitsIndex, bitsMagic >::operator==().


Member Data Documentation

template<uInt bitsIndex, uInt bitsMagic>
uInt id< bitsIndex, bitsMagic >::m_id
 

Definition at line 103 of file id.h.

Referenced by id< bitsIndex, bitsMagic >::isNull(), id< bitsIndex, bitsMagic >::operator uInt(), id< bitsIndex, bitsMagic >::operator!=(), id< bitsIndex, bitsMagic >::operator=(), and id< bitsIndex, bitsMagic >::operator==().

template<uInt bitsIndex, uInt bitsMagic>
uInt id< bitsIndex, bitsMagic >::m_index
 

Definition at line 99 of file id.h.

Referenced by id< bitsIndex, bitsMagic >::operator=().

template<uInt bitsIndex, uInt bitsMagic>
uInt id< bitsIndex, bitsMagic >::m_magic
 

Definition at line 100 of file id.h.

Referenced by id< bitsIndex, bitsMagic >::operator=().


The documentation for this class was generated from the following file:
Generated on Sun Mar 6 22:12:34 2005 for virtualMachine03 by doxygen 1.3.7