otypeset.h

Go to the documentation of this file.

/**
 * \file rvc/otypeset.h 
 * \brief Define RVC::OBJTYPESET class.
 *
 * \if NODOC
 * $Id: otypeset.h_v 1.11 2003/10/22 16:16:49 scowan Exp $
 *
 * $Log: otypeset.h_v $
 * Revision 1.11  2003/10/22 16:16:49  scowan
 * Added operator append for another obj type set.
 *
 * Revision 1.10  2003/10/08 22:20:58  scowan
 * Doxygen adjustments.
 *
 * Revision 1.9  2003/09/30 16:52:06  dwilliss
 * Doxygen
 *
 * Revision 1.8  2003/09/25 21:56:58  dwilliss
 * doxygen
 *
 * Revision 1.7  2003/09/15 13:49:45  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.6  2001/07/11 14:38:40  scowan
 * MAC does not like ';' after namespace endings.
 *
 * Revision 1.5  2001/06/18 14:16:16  mju
 * Array was 1 entry too small.
 *
 * Revision 1.4  2001/06/14 21:52:25  mju
 * Add GetFirst/GetNext methods.
 *
 * Revision 1.2  2001/06/13 17:51:49  mju
 * Add namespace specifiers to parameters.
 *
 * Revision 1.1  2001/06/13 16:19:21  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_RVC_OTYPESET_H
#define  INC_RVC_OTYPESET_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifndef  INC_RVC_OBJTYPE_H
#include <rvc/objtype.h>
#endif

#ifndef  INC_STRING_H
#include <string.h>     // Includes defn for memset()
#define  INC_STRING_H
#endif

namespace RVC {

//! \class OBJTYPESET rvc/otypeset.h
//! \brief Class to represent "set" of RVC object types.
class OBJTYPESET {
   public:

      //! Default constructor, creates empty set.
      OBJTYPESET (
         ) { Clear(); }

      //! Implicit constructor from OBJTYPE.
      //! Allows a single OBJTYPE value to be passed wherever OBJTYPESET is specified.
      OBJTYPESET (
         RVC::OBJTYPE objtype
         ) { Clear(); operator+=(objtype); }

      //! Convenience constructor for specifying two object types.
      OBJTYPESET (
         RVC::OBJTYPE objtype1,
         RVC::OBJTYPE objtype2
         ) { Clear(); operator+=(objtype1); operator+=(objtype2); }

      //! Convenience constructor for specifying three object types.
      OBJTYPESET (
         RVC::OBJTYPE objtype1,
         RVC::OBJTYPE objtype2,
         RVC::OBJTYPE objtype3
         ) { Clear(); operator+=(objtype1); operator+=(objtype2); operator+=(objtype3); }

      //! Add type to set.
      OBJTYPESET& operator+= (
         RVC::OBJTYPE rhs
         ) { if (rhs == OBJTYPE_All) SetAll(); else m_objtypebits[rhs/32] |= 1 << (rhs % 32); return (*this); }

      //! Add type set to set.
      OBJTYPESET& operator+= (
         const RVC::OBJTYPESET& rhs
         ) { for (INT32 i = 0;(i < (OBJTYPE_LAST+31)/32);++i) m_objtypebits[i] |= rhs.m_objtypebits[i]; return (*this); }

      //! Remove type from set.
      OBJTYPESET& operator-= (
         RVC::OBJTYPE rhs
         ) { if (rhs == OBJTYPE_All) Clear(); else m_objtypebits[rhs/32] &= ~(1 << (rhs % 32)); return (*this); }

      //! Clear set.
      void Clear (
         ) { memset(m_objtypebits,0,sizeof(m_objtypebits)); return; }

      //! Determine if set contains specified object type.
      bool Contains (
         RVC::OBJTYPE objtype
         ) const { return ((m_objtypebits[objtype/32] & (1 << (objtype % 32))) != 0); }

      //! Get first object type in set.
      //! @return First object type or OBJTYPE_LAST if no more in set.
      RVC::OBJTYPE GetFirst (
         ) const { return (GetNext(OBJTYPE_All)); }

      //! Get next object type in set.
      RVC::OBJTYPE GetNext (
         OBJTYPE objtype
         ) const {
         do {
            ++objtype;
            if (Contains(objtype)) break;
            } while (objtype < OBJTYPE_LAST);
         return (objtype);
         }

      void SetAll (
         ) { memset(m_objtypebits,255,sizeof(m_objtypebits)); return; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      UINT32 m_objtypebits[(OBJTYPE_LAST+31)/32];
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}  //! End of RVC namespace


#endif   //!< INC_RVC_OTYPESET_H

---