namedrgn.h

Go to the documentation of this file.

/**
 * \file namedrgn.h <mi32/namedrgn.h>
 * \brief NAMEDREGION class definition.
 *
 * \if NODOC
 * $Id: namedrgn.h_v 1.6 2005/03/31 16:57:19 fileserver!dwilliss Exp $
 *
 * $Log: namedrgn.h_v $
 * Revision 1.6  2005/03/31 16:57:19  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.5  2005/03/07 18:25:01  scowan
 * Changed part of class to use descriptor.
 *
 * Revision 1.4  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2001/06/14 21:42:15  scowan
 * region class is now in RVC namespace.
 *
 * Revision 1.2  2001/01/26 23:03:53  mju
 * Add Load() method.
 *
 * Revision 1.1  2001/01/23 23:00:20  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_NAMEDRGN_H
#define  INC_MI32_NAMEDRGN_H

#ifndef  INC_RVC_REGIONCL_H
   #include <rvc/regioncl.h>
#endif

#ifndef  INC_MI32_OBSLIST_H
   #include <mi32/obslist.h>
#endif


//! Named region class.
class NAMEDREGION : public RVC::REGION {
   public:
      //! Default constructor.
      NAMEDREGION (
         );

      //! Copy constructor.
      NAMEDREGION (
         const NAMEDREGION& rhs
         );

      //! Assignment from NAMEDREGION.
      NAMEDREGION& operator= (
         const NAMEDREGION& rhs
         );

      //! Get region description.
      const MIUNICODE* GetDescription (
         ) const;

      //! Get region name.
      const MIUNICODE* GetName (
         ) const;

      //! Attach region to RVC object and load into memory.
      ERRVALUE Load (
         const RVC::OBJITEM& objitem
         );

      //! Set region description.
      //! If region is bound to an object the object will be changed.
      ERRVALUE SetDescription (
         const RVC::OBJECTDESC& desc
         );

      //! Set region name.
      //! If region is bound to an object the object will be changed.
      ERRVALUE SetName (
         const RVC::OBJECTNAME& name
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      RVC::OBJECTNAME m_name;
      RVC::OBJECTDESC m_desc;

      virtual ERRVALUE GetDftNameDesc (
         const RVC::OBJECT& parent,
         RVC::DESCRIPTOR& Descriptor
         );
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//! List (observable) of named regions.
typedef OBSERVABLE_LIST<NAMEDREGION> NAMEDREGION_LIST;


#endif   //!< INC_MI32_NAMEDRGN_H

---