Fennel: OpaqueInteger< T, Dummy > Class Template Reference (original) (raw)

• Main Page

• Namespaces

• Classes

• Files

• Directories

• Related Pages

• Alphabetical List

• Class List

• Class Hierarchy

• Class Members

OpaqueInteger is a wrapper for a primitive integer type. More...

#include <[OpaqueInteger.h](OpaqueInteger%5F8h-source.html)>

List of all members.

Detailed Description

template<class T, class Dummy>

class OpaqueInteger< T, Dummy >

OpaqueInteger is a wrapper for a primitive integer type.

It is not meant to be used directly; instead, use the macros at the end of this file. If an operation you need isn't here all ready, please add it. However, do NOT add an automatic cast operator or implicit constructor. The point of this class is to help prevent implicit conversions between values with different semantics. For example:

    DEFINE_OPAQUE_INTEGER(Apple,uint);
    DEFINE_OPAQUE_INTEGER(Orange,uint);

    Apple apple_jack,apple_seed(20);
    Orange oj;

    apple_jack = apple_seed+2; // legal
    oj = apple_jack;            // won't compile, can't compare apples&oranges

Note that in a non-debug build, the macro expands to a simple typedef, so there is no performance penalty for using it. However, this also means that you have to be careful with overloading to avoid release-build breakage.

// TODO: extend the mechanism to be able to handle inheritance (e.g. BTreeId isa PageOwnerId).

Definition at line 63 of file OpaqueInteger.h.

Constructor & Destructor Documentation

Member Function Documentation

template<class T, class Dummy>

| T OpaqueInteger< T, Dummy >::getWrapped | ( | | ) | const [inline] | | ------------------------------------------------------------------ | - | | - | ---------------- |

Member Data Documentation

template<class T, class Dummy>

Definition at line 66 of file OpaqueInteger.h.

Referenced by OpaqueInteger< T, Dummy >::getWrapped(), OpaqueInteger< T, Dummy >::OpaqueInteger(), OpaqueInteger< T, Dummy >::operator *(), OpaqueInteger< T, Dummy >::operator *=(), OpaqueInteger< T, Dummy >::operator!=(), OpaqueInteger< T, Dummy >::operator%(), OpaqueInteger< T, Dummy >::operator%=(), OpaqueInteger< T, Dummy >::operator+(), OpaqueInteger< T, Dummy >::operator++(), OpaqueInteger< T, Dummy >::operator+=(), OpaqueInteger< T, Dummy >::operator-(), OpaqueInteger< T, Dummy >::operator--(), OpaqueInteger< T, Dummy >::operator-=(), OpaqueInteger< T, Dummy >::operator/(), OpaqueInteger< T, Dummy >::operator/=(), OpaqueInteger< T, Dummy >::operator<(), OpaqueInteger< T, Dummy >::operator<<(), OpaqueInteger< T, Dummy >::operator<<=(), OpaqueInteger< T, Dummy >::operator<=(), OpaqueInteger< T, Dummy >::operator==(), OpaqueInteger< T, Dummy >::operator>(), OpaqueInteger< T, Dummy >::operator>=(), OpaqueInteger< T, Dummy >::operator>>(), and OpaqueInteger< T, Dummy >::operator>>=().

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

• /home/pub/open/dev/fennel/common/OpaqueInteger.h

Generated on Mon Jun 22 04:00:40 2009 for Fennel by 1.5.1