ENUMSET< _ENUMTYPE, _LAST, _ALL > Class Template Reference

Container for "set" of enum values. More...

#include <mi32/enumset.h>

Inheritance diagram for ENUMSET< _ENUMTYPE, _LAST, _ALL >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ENUMSET (_ENUMTYPE enumval1, _ENUMTYPE enumval2, _ENUMTYPE enumval3)
 ENUMSET (_ENUMTYPE enumval1, _ENUMTYPE enumval2)
 ENUMSET (_ENUMTYPE enumval)
 ENUMSET ()
void Clear ()
bool Contains (_ENUMTYPE enumval) const
_ENUMTYPE GetFirst () const
_ENUMTYPE GetNext (_ENUMTYPE enumval) const
ENUMSEToperator+= (const ENUMSET< _ENUMTYPE, _LAST, _ALL > &rhs)
ENUMSEToperator+= (_ENUMTYPE rhs)
ENUMSEToperator-= (_ENUMTYPE rhs)
void SetAll ()

Detailed Description

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
class ENUMSET< _ENUMTYPE, _LAST, _ALL >

Container for "set" of enum values.


Constructor & Destructor Documentation

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
ENUMSET< _ENUMTYPE, _LAST, _ALL >::ENUMSET (  )  [inline]

Default constructor, creates empty set.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
ENUMSET< _ENUMTYPE, _LAST, _ALL >::ENUMSET ( _ENUMTYPE  enumval  )  [inline]

Implicit constructor from single _ENUMTYPE value.

Allows a single _ENUMTYPE value to be passed wherever ENUMSET is specified.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
ENUMSET< _ENUMTYPE, _LAST, _ALL >::ENUMSET ( _ENUMTYPE  enumval1,
_ENUMTYPE  enumval2 
) [inline]

Convenience constructor for specifying two _ENUMTYPE values.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
ENUMSET< _ENUMTYPE, _LAST, _ALL >::ENUMSET ( _ENUMTYPE  enumval1,
_ENUMTYPE  enumval2,
_ENUMTYPE  enumval3 
) [inline]

Convenience constructor for specifying three _ENUMTYPE values.


Member Function Documentation

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
void ENUMSET< _ENUMTYPE, _LAST, _ALL >::Clear (  )  [inline]

Clear set.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
bool ENUMSET< _ENUMTYPE, _LAST, _ALL >::Contains ( _ENUMTYPE  enumval  )  const [inline]

Determine if set contains specified enumect type.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
_ENUMTYPE ENUMSET< _ENUMTYPE, _LAST, _ALL >::GetFirst (  )  const [inline]

Get first enumect type in set.

Returns:
First enumect type or ENUM_LAST if no more in set.
template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
_ENUMTYPE ENUMSET< _ENUMTYPE, _LAST, _ALL >::GetNext ( _ENUMTYPE  enumval  )  const [inline]

Get next enumect type in set.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
ENUMSET& ENUMSET< _ENUMTYPE, _LAST, _ALL >::operator+= ( const ENUMSET< _ENUMTYPE, _LAST, _ALL > &  rhs  )  [inline]

Add type set to set.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
ENUMSET& ENUMSET< _ENUMTYPE, _LAST, _ALL >::operator+= ( _ENUMTYPE  rhs  )  [inline]

Add type to set.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
ENUMSET& ENUMSET< _ENUMTYPE, _LAST, _ALL >::operator-= ( _ENUMTYPE  rhs  )  [inline]

Remove type from set.

template<typename _ENUMTYPE, _ENUMTYPE _LAST, _ENUMTYPE _ALL = static_cast<_ENUMTYPE>(-1)>
void ENUMSET< _ENUMTYPE, _LAST, _ALL >::SetAll (  )  [inline]

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

Generated on Sun Oct 7 21:33:21 2012 for TNTsdk 2012 by  doxygen 1.6.1