regioncl.h

Go to the documentation of this file.

/**
 * \file rvc/regioncl.h 
 * \brief interface for the RVC::REGION class.
 *
 * \if NODOC
 * $Id: regioncl.h_v 1.12 2004/06/25 16:12:26 scowan Exp $
 *
 * $Log: regioncl.h_v $
 * Revision 1.12  2004/06/25 16:12:26  scowan
 * Uses correct region class.
 *
 * Revision 1.11  2003/10/07 17:30:43  scowan
 * Object virtual method changes.
 *
 * Revision 1.10  2003/09/30 16:52:06  dwilliss
 * Doxygen
 *
 * Revision 1.9  2003/09/25 21:20:04  dwilliss
 * Fixed doxygen comment
 *
 * Revision 1.8  2003/09/15 13:49:45  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.7  2003/05/30 22:06:31  scowan
 * Added a get extentsd method.
 *
 * Revision 1.6  2002/12/10 18:14:59  scowan
 * Added region 2d code.
 *
 * Revision 1.5  2001/06/14 15:26:24  scowan
 * Added to RVC namespace.
 *
 * Revision 1.4  2000/12/01 16:08:28  scowan
 * Fixed MAC and i18n errors.
 *
 * Revision 1.3  2000/11/29 20:52:50  scowan
 * Fixed inclusion guards.
 *
 * Revision 1.2  2000/10/19 21:14:40  scowan
 * Checked in for vacation.
 *
 * Revision 1.1  2000/09/29 20:15:44  scowan
 * Initial revision
 *
 * \endif
**/

//!   \class RVC::REGION rvc/regioncl.h
//!   \brief Manages RVC::OBJTYPE_Region RVC objects.  
//!   
//!   The interface currently wraps the MfRegion functions.
//!
//!   RVC Object Types that this class supports: RVC::OBJTYPE_Region.
//!
//!   Default RVC Object Type for this class: RVC::OBJTYPE_Region.
//!
//!   Valid parents for this class:
//!      - RVC::OBJTYPE_File
//!      - RVC::OBJTYPE_Folder
//!      - RVC::OBJTYPE_Vector
//!      - RVC::OBJTYPE_TIN
//!      - RVC::OBJTYPE_CAD
//!      - RVC::OBJTYPE_Raster
//!      - RVC::OBJTYPE_RasterSet
//!      - RVC::OBJTYPE_Hyperspectral
//!
//!   Read(), Make() and Write() methods inherited from RVCSIMPLE class.  View RVCSIMPLE docs for inherited methods

#ifndef INC_RVC_REGIONCL_H
#define INC_RVC_REGIONCL_H

#ifndef INC_RVC_SIMPLE_H
   #include <rvc/simple.h>
#endif

#ifndef INC_MI32_REGION2D_H
   #include <mi32/region2d.h>
#endif

// Forward Declarations
namespace SPATREF {
   class COORDREFSYS;
   }

namespace RVC {

class REGION : public RVC::SIMPLE {
   public:

      //! Default constructor
      REGION (
         );

      //! Copy constructor
      REGION (
         const RVC::REGION& rhs
         );

      //! Destructor
      virtual ~REGION (
         );

      //! Assignment
      RVC::REGION& operator= (
         const RVC::REGION& rhs
         );

      //! Get region extents.
      //! @return Region's extents
      const DRECT2D& GetExtents (
         ) const;

      //! Get region COORDREFSYS
      //! @return Region's COORDREFSYS
      const SPATREF::COORDREFSYS& GetCoordRefSys ( 
         ) const;

      //! Obtain region, must be read first
      //! @return Region reference
      const REGION2D& GetRegion (
         ) const;

      //! Set the current region to a new region
      ERRVALUE SetRegion (
         const REGION2D& region
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      //! Implementation of RVC::OBJECT virtual methods
      virtual OBJTYPE v_GetDftObjectType () const;
      
      //! Implementation of RVC::SIMPLE virtual methods
      virtual ERRVALUE v_GetDftNameDesc (const OBJECT& parent, OBJECTNAME& name, OBJECTDESC& desc);
      virtual ERRVALUE v_ReadData ();
      virtual ERRVALUE v_WriteData (const RVCGENINFO& ginfo);

      REGION2D m_Region;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}     //! End of RVC namespace

#endif      //!< INC_RVC_REGIONCL_H

---