pgType< D, T > Class Template Reference
[pgGen -- General purpose module]

An enum type with specified size. More...

#include <pg_type.h>

List of all members.

Public Member Functions

 pgType ()
 Constructs and initializes a pgType to zero.
 pgType (T type)
 Constructs and initializes a pgType from the specified type.
pgType< D, T > & operator= (T type)
 Assigns the right hand side type to this pgType.
bool operator== (pgType< D, T > type) const
 Returns whether this pgType is equal to the right hand side pgType.
bool operator== (T type) const
 Returns whether this pgType is equal to the right hand side type.
bool operator!= (pgType< D, T > type) const
 Returns whether this pgType is unequal to the right hand side pgType.
bool operator!= (T type) const
 Returns whether this pgType is unequal to the right hand side type.
T getType () const
 Returns the value of this pgType as the enum type.
D getValue () const
 Returns the value of this pgType as the data type.

Friends

bool operator== (T type1, pgType< D, T > type2)
 Returns whether the left hand side type is equal to the right hand side pgType.
bool operator!= (T type1, pgType< D, T > type2)
 Returns whether the left hand side type is unequal to the right hand side pgType.


Detailed Description

template<class D, class T>
class pgType< D, T >

An enum type with specified size.

Template Parameters:
D The data type to store a value of the enum type.
T The enum type stored in the data type.

Constructor & Destructor Documentation

template<class D, class T>
pgType< D, T >::pgType ( T  type  )  [inline]

Constructs and initializes a pgType from the specified type.

Parameters:
[in] type A type.


Member Function Documentation

template<class D, class T>
T pgType< D, T >::getType (  )  const [inline]

Returns the value of this pgType as the enum type.

Returns:
The value of this pgType as the enum type.

template<class D, class T>
D pgType< D, T >::getValue (  )  const [inline]

Returns the value of this pgType as the data type.

Returns:
The value of this pgType as the data type.

template<class D, class T>
bool pgType< D, T >::operator!= ( T  type  )  const [inline]

Returns whether this pgType is unequal to the right hand side type.

Parameters:
[in] type The right hand side type.
Returns:
Whether this pgType is unequal to the right hand side type.

template<class D, class T>
bool pgType< D, T >::operator!= ( pgType< D, T >  type  )  const [inline]

Returns whether this pgType is unequal to the right hand side pgType.

Parameters:
[in] type The right hand side pgType.
Returns:
Whether this pgType is unequal to the right hand side pgType.

template<class D, class T>
pgType<D, T>& pgType< D, T >::operator= ( T  type  )  [inline]

Assigns the right hand side type to this pgType.

Parameters:
[in] type The right hand side type.
Returns:
A reference to this pgType.

template<class D, class T>
bool pgType< D, T >::operator== ( T  type  )  const [inline]

Returns whether this pgType is equal to the right hand side type.

Parameters:
[in] type The right hand side type.
Returns:
Whether this pgType is equal to the right hand side type.

template<class D, class T>
bool pgType< D, T >::operator== ( pgType< D, T >  type  )  const [inline]

Returns whether this pgType is equal to the right hand side pgType.

Parameters:
[in] type The right hand side pgType.
Returns:
Whether this pgType is equal to the right hand side pgType.


Friends And Related Function Documentation

template<class D, class T>
bool operator!= ( T  type1,
pgType< D, T >  type2 
) [friend]

Returns whether the left hand side type is unequal to the right hand side pgType.

Parameters:
[in] type1 The left hand side type.
[in] type2 The right hand side pgType.
Returns:
Whether the left hand side type is unequal to the right hand side pgType.

template<class D, class T>
bool operator== ( T  type1,
pgType< D, T >  type2 
) [friend]

Returns whether the left hand side type is equal to the right hand side pgType.

Parameters:
[in] type1 The left hand side type.
[in] type2 The right hand side pgType.
Returns:
Whether the left hand side type is equal to the right hand side pgType.


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

Generated on Sat Aug 15 11:24:38 2009 for Pogolyn by  doxygen 1.5.8