system.h

Go to the documentation of this file.

/**
 * \file system.h <gre/system.h>
 * \brief GRE::SYSTEM class definition
 *
 * \if NODOC
 * $Id: system.h_v 1.5 2005/05/13 14:38:05 scowan Exp $
 *
 * $Log: system.h_v $
 * Revision 1.5  2005/05/13 14:38:05  scowan
 * Moved global lists to here.
 *
 * Revision 1.4  2004/12/16 14:58:33  mju
 * Add GetAutoOpenList.
 *
 * Revision 1.3  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2003/07/30 15:35:04  mju
 * Ignore private sections.
 *
 * Revision 1.1  2003/06/16 19:40:12  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_GRE_SYSTEM_H
#define  INC_GRE_SYSTEM_H

#ifndef  INC_GRE_OBJECTBASE_H
   #include <gre/objectbase.h>
#endif

#ifndef  INC_MI32_CRITSEC_H
   #include <mi32/critsec.h>
#endif

#if !defined(INC_MI32_NAMEDRGN_H) && defined(WIN32_NATIVE)
   #include <mi32/namedrgn.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
class GRE_GROUP;
class GRE_LAYOUT;
class GRE_VIEW;
#endif

//===================================================================================================================

//! GRE "system" container object.
//!
//! A single instance of this object is automatically created by the GRE system.  This
//! object is used as an implied container for all other top-level GRE (usually GRE_VIEWABLE)
//! objects.  This provides a convenient place to attach callbacks where notification is desired
//! for all layouts and top-level groups.
class GRE_SYSTEM : public GRE_OBJECT {
   public:

      enum AUTOOPEN {
         AUTOOPEN_None,
         AUTOOPEN_Layout,
         AUTOOPEN_Group,
         AUTOOPEN_Layer
         };

      //! Get list of objects to auto-open via command line.
      //! @return Type of auto-open to be performed.
      static AUTOOPEN GetAutoOpenList (
         MDLGPARENT dlgparent,                        //!< Parent for dialog if need to prompt user for anything
         const SIMPLE_ARRAY<const char*>& cmdparms,   //!< Command-line parameters
         RVC::OBJITEMLIST& ObjItemList                //!< Object item list returned
         );
         
      //! Get reference to the first 'standalone' group
      //! To access this data you should get a lock on the group critical section
      static GRE_GROUP* GetFirstGroup (
         ) { return (GetRef().m_FirstGroup); }

      //! Get first layout in GRE system.
      //! To access this data you should get a lock on the layout critical section
      static GRE_LAYOUT* GetFirstLayout (
         ) { return (GetRef().m_FirstLayout); }

      //! Get first view in GRE system.
      //! To access this data you should get a lock on the layout critical section
      static GRE_VIEW* GetFirstView (
         ) { return (GetRef().m_FirstView); }

      //! Get reference to the last 'standalone' group
      //! To access this data you should get a lock on the group critical section
      static GRE_GROUP* GetLastGroup (
         ) { return (GetRef().m_LastGroup); }

      //! Get last layout in GRE system.
      //! To access this data you should get a lock on the layout critical section
      static GRE_LAYOUT* GetLastLayout (
         ) { return (GetRef().m_LastLayout); }

      //! Get reference to the 'standalone' group list critical section
      static CRITICALSECTION& GetGroupCriticalSection (
         ) { return (GetRef().m_GroupListSec); }

      //! Get reference to the layout list critical section
      static CRITICALSECTION& GetLayoutCriticalSection (
         ) { return (GetRef().m_LayoutListSec); }

      //! Get reference to the view list critical section
      static CRITICALSECTION& GetViewCriticalSection (
         ) { return (GetRef().m_ViewListSec); }

      //! Get reference to the single GRE_SYSTEM instance.
      static GRE_SYSTEM& GetRef (
         );

      //! Determine whether to return or continue on serial read error.
      static bool GetReturnSerialReadErr (
         ) { return (GetRef().m_ReturnSerialReadErr); }

   #ifdef WIN32_NATIVE
      //! Get shared region list.
      //! @return Reference to shared region list.
      //! This method is only available when compiling for WIN32_NATIVE.
      static NAMEDREGION_LIST& GetRegionList (
         ) { return (GetRef().m_RegionList); }
   #endif

   #ifdef X_NATIVE
      //! Get "handle" for shared "region manager".
      //! This method is only available when compiling for X.
      static void* GetRgnMgrHandle (
         ) { return (GetRef().PrivGetRgnMgrHandle()); }
   #endif

      //! Check if have displayed warning about mixing georef/ungeoref layers.
      static bool HasDoneWarningGeoMixed (
         ) { return (GetRef().m_DoneWarningGeoMixed); }

      //! Initialize GRE system for non-interactive use.
      //! This will automatically register the standard geospatial layer types.
      //! At program exit, GRE_SYSTEM::Stop() should be called for proper cleanup.
      static void Init (
         );

   #ifdef WIN32_MFC
      //! Initialize GRE system for interactive use in Microsoft Windows with MFC.
      //! This will automatically register the standard geospatial layer types.
      //! At program exit, GRE_SYSTEM::StopMFC() should be called for proper cleanup.
      //! This is only available when compiling for WIN32_NATIVE and WIN32_MFC.
      static void InitMFC (
         );
   #endif

   #ifdef X_NATIVE
      //! Initialize GRE system for interactive use in X Windows.
      //! This will automatically register the standard geospatial layer types.
      //! At program exit, GRE_SYSTEM::StopX() should be called for proper cleanup.
      //! This method is only available when compiling for X.
      static void InitX (
         int numworkpixels = 0
         );
   #endif

      //! Register layout-specific layer types (text, scalebar, legend).
      //! By default only the standard geospatial layer are registered.
      static void RegisterLayoutLayerTypes (
         );

      //! Set whether have displayed warning about mixing georef/ungeoref layers.
      //!
      //! Normally a warning dialog is displayed the first time a user attempts to place
      //! both georeferenced and non-georeferenced spatial objects in the same GRE_GROUP.
      //! In some processes, such as georeference editing, this is necessary, so this
      //! method is provided to avoid the unwanted warning dialog.
      static void SetDoneWarningGeoMixed (
         bool set = true
         ) { GetRef().m_DoneWarningGeoMixed = set; }

      //! Set reference to the first 'standalone' group
      //! To access this data you should get a lock on the group critical section
      static void SetFirstGroup (
         GRE_GROUP* group
         ) { GetRef().m_FirstGroup = group; }

      //! Set reference to the first layout
      //! To access this data you should get a lock on the layout critical section
      static void SetFirstLayout (
         GRE_LAYOUT* layout
         ) { GetRef().m_FirstLayout = layout; }

      //! Set first view in GRE system.
      //! To access this data you should get a lock on the layout critical section
      static void SetFirstView (
         GRE_VIEW* view
         ) { GetRef().m_FirstView = view; }

      //! Set reference to the last 'standalone' group
      //! To access this data you should get a lock on the group critical section
      static void SetLastGroup (
         GRE_GROUP* group
         ) { GetRef().m_LastGroup = group; }

      //! Set reference to the last layout
      //! To access this data you should get a lock on the layout critical section
      static void SetLastLayout (
         GRE_LAYOUT* layout
         ) { GetRef().m_LastLayout = layout; }

      //! Set whether to return serial read error or continue.
      static void SetReturnSerialReadErr (
         bool set = true
         ) { GetRef().m_ReturnSerialReadErr = set; };

      //! Terminate GRE system at program exit.
      //! This method should only be called if GRE_SYSTEM::Init() was used.
      static void Stop (
         );

   #ifdef WIN32_MFC
      //! Terminate GRE system at program exit.
      //! This method should only be called if GRE_SYSTEM::InitMFC() was used.
      static void StopMFC (
         );
   #endif

   #ifdef X_NATIVE
      //! Terminate GRE system at program exit.
      //! This method should only be called if GRE_SYSTEM::InitX() was used.
      static void StopX (
         );
   #endif

      #ifndef GENERATING_DOXYGEN_OUTPUT
      ~GRE_SYSTEM ();
      #endif

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      static bool s_InitDone;

   #ifdef WIN32_NATIVE
      NAMEDREGION_LIST m_RegionList;            //!< Shared region list
   #else
      void *m_RgnMgrHandle;                     //!< Region manager handle
   #endif
      bool m_DoneWarningGeoMixed;
      bool m_ReturnSerialReadErr;               //!< Return error when loading group/layout instead of continuing
      CRITICALSECTION m_GroupListSec;
      CRITICALSECTION m_LayoutListSec;
      CRITICALSECTION m_ViewListSec;
      GRE_GROUP* m_FirstGroup;
      GRE_GROUP* m_LastGroup;
      GRE_LAYOUT* m_FirstLayout;
      GRE_LAYOUT* m_LastLayout;
      GRE_VIEW* m_FirstView;

      GRE_SYSTEM ();
   #ifdef X_NATIVE
      void* PrivGetRgnMgrHandle ();
   #endif

      //! GRE_OBJECT overrides.
      virtual bool v_Destroy (bool NotifyParent);
      virtual MICON v_GetIcon () const;
      virtual const char* v_GetTypeName () const;

      GRE_SYSTEM (const GRE_SYSTEM&);
      GRE_SYSTEM& operator= (const GRE_SYSTEM&);

      #endif //!< GENERATING_DOXYGEN_OUTPUT
   };

//===================================================================================================================


#endif   //!< INC_GRE_SYSTEM_H

---