mgui/dlggetobjectitem.h

Go to the documentation of this file.

#ifndef  INC_MGUI_DLGGETOBJECTITEM_H
#define  INC_MGUI_DLGGETOBJECTITEM_H

#ifndef  INC_MGUI_DLGGETOBJECTDLG_H
#include <mgui/dlggetobjectdlg.h>
#endif

#ifndef  INC_MI32_SPATREF_H
#include <mi32/spatref.h>
#endif

#ifndef  INC_MI32_DATETIME_H
#include <mi32/datetime.h>
#endif

#ifndef  INC_MI32_ELEMTYPE_H
#include <mi32/elemtype.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
class XMLNODE;
namespace RVC {
   class GEOMETRIC;
   }
#endif

namespace MGUI {
//=====================================================================================================================
//    DLG_GETOBJECT::ITEM definition - Begin

class DLG_GETOBJECT::ITEM {
   public:
      typedef fastdelegate::FastDelegate<ERRVALUE(ITEM&)> DELEGATE_ONLOADWEBLAYERS;

      enum TYPE {
         TYPE_Invalid,
         TYPE_Computer,
         TYPE_NetRoot,        // Root of network
         TYPE_NetServer,      // Network server
         TYPE_NetShare,       // Network shared directory
         TYPE_Volume,         // Drive / Volume
         TYPE_Folder,         // Local directory
         TYPE_File,           // File
         TYPE_RVC_File,       // RVC file
         TYPE_RVC_Folder,     // RVC folder
         TYPE_RVC_Object,     // RVC object
         TYPE_WebLayerGroup,     // Web Layer Group
         TYPE_RemoteTileset,     // Remote TSD
         TYPE_RemoteKML,         // Remote KML
         TYPE_MyMaps,         // MyMaps
         TYPE_WMS,            // WMS
         TYPE_ArcIMS,         // ArcIMS
         TYPE_Geomashup,         // Geomashup file
         TYPE_TerrainTileset, // Terrain tileset
         TYPE_COUNT
         };

      enum OBJECTSTATE {
         OBJECTSTATE_Unknown = 0,
         OBJECTSTATE_Valid = 1,
         OBJECTSTATE_IsInvalidChild,               //< Is not a valid child for its parent
         OBJECTSTATE_HasInvalidChild,              //< Has invalid children, object itself may be valid
         OBJECTSTATE_IsInvalidSingleton,           //< Is not a singleton for parent as required
         OBJECTSTATE_HasInvalidSingleton,          //< Has multiple children of same type where singleton required
         OBJECTSTATE_ObjectHasUnlocatableLink,     //< Object linked to unlocatable resource
         OBJECTSTATE_ChildHasUnlocatableLink,      //< Has descendent linked to unlocatable resource
         OBJECTSTATE_IsOutdatedChild,              //< Is outdated child relative to its parent
         OBJECTSTATE_HasOutdatedChild,             //< Has outdated child
         };

      // Default constructor.
      ITEM ();

      // Copy constructor.
      ITEM (const ITEM& rhs);

      // Construct with specified name and TYPE.
      ITEM (const MISTRING& name, TYPE type);

      // Construct with specified name and RVC::OBJTYPE.
      ITEM (const MISTRING& name, RVC::OBJTYPE rvctype);

      // Construct from FILEPATH and TYPE.
      ITEM (const FILEPATH& filepath, TYPE type, bool IsSelectable);

      // Construct named FILEPATH.
      ITEM (const MISTRING& name, const FILEPATH& filepath, TYPE type);

      // Construct from RVC::OBJITEM.
      ITEM (const RVC::OBJITEM& objitem, bool IsBrowsable = false, bool IsSelectable = false);

      // Construct from RVC::OBJITEM.
      ITEM (const MISTRING& name, const RVC::OBJITEM& objitem, bool IsBrowsable = false, bool IsSelectable = false);

      // Construct from MINETRES.
      ITEM (const MINETRES& netres);

      // Construct named location.
      ITEM (const MISTRING& name, const MISTRING& location, TYPE type);

      // Construct from XMLNODE
      ITEM (XMLNODE* node);

      // Destructor.
      ~ITEM ();

      // Assignment operator.
      ITEM& operator= (
         const ITEM& rhs
         );

      // Comparison for equality.
      bool operator== (
         const DLG_GETOBJECT::ITEM& rhs
         ) const { return (IsEqual(rhs)); }

      // Comparison for inequality.
      bool operator!= (
         const DLG_GETOBJECT::ITEM& rhs
         ) { return (!IsEqual(rhs)); }

      // Build network item list.
      ERRVALUE BuildNetItemList (
         ITEMLIST& ItemList
         ) const;

      const SPATREF::COORDREFSYS& GetCoordRefSys (
         ) const {return m_CRS;}

      const MISTRING& GetDescription (
         ) const { return (m_description); }

      const MISTRING& GetDimensionString (
         ) const { return (m_DimensionString); }

      INT64 GetDimensionValue (
         ) const { return (m_DimensionValue); }

      const DRECT3D& GetExtentInCRS (
         ) const {return m_ExtentInCRS;}

      ICONID GetIconID (
         ) const;

      const FILEPATH& GetFilePath (
         ) const { return (m_pObjItem->GetFilePath()); }

      // Get item name.
      const MISTRING& GetName (
         ) const;

      // Get item location for display
      void GetDisplayLocation (
         MISTRING& location,
         bool bStripToFolder = true
         ) const;

      // Get item location.
      const MISTRING& GetLocation (
         ) const {return (m_location); }

      MINETRES* GetNetRes (
         ) const { return (m_pNetRes); }

      XMLNODE* GetNode (
         bool bLoadIfNeeded = true
         );

      // Get object state.
      OBJECTSTATE GetObjectState (
         ) const;

      // Get RVC object item information.
      // @return Pointer to RVC::OBJITEM or NULL if does not refer to RVC object.
      const RVC::OBJITEM* GetObjItem (
         ) const { return (m_pObjItem); }

      // Get RVC object item information to change.
      RVC::OBJITEM& GetObjItemToChange (
         ) { return (*m_pObjItem); }

      INT32 GetOrder (
         ) const { return (m_order); }

      const DPOINT3D& GetResolutionInCRS (
         ) const { return (m_ResolutionInCRS); }

      RVC::OBJTYPE GetRVCType (
         ) const { return (m_rvctype); }

      // Get item short name.
      const RVC::OBJECTNAME& GetShortName (
         ) const;

      INT64 GetSizeInBytes (
         ) const { return (m_SizeInBytes); }

      INT32 GetSubType (
         ) const { return (m_subtype); }

      // Get date/time created.
      const DATETIME& GetTimeCreated (
         ) const { return (m_TimeCreated); }

      // Get date/time modified.
      const DATETIME& GetTimeModified (
         ) const { return (m_TimeModified); }

      // Get item type.
      TYPE GetType (
         ) const { return (m_type); }

      bool IsBrowsable (
         ) const { return (m_IsBrowsable); }

      bool IsEqual (
         const ITEM& rhs
         ) const;

      bool IsSelectable (
         ) const { return (m_IsSelectable); }

      void ResetExtValues (
         ) { m_ExtValuesValid = EXTVALUE_None; }

      void SetDelegateOnLoadWebLayers (
         DELEGATE_ONLOADWEBLAYERS delegate
         ) { m_DelegateOnLoadWebLayers = delegate; }

      void SetCRS (const SPATREF::COORDREFSYS& crs) {m_CRS = crs;}

      void SetExtentInCRS (const DRECT2D& extents) { m_ExtentInCRS = extents;}

      // Set name.
      void SetName (const MISTRING& name);

      void SetNode (XMLNODE* node) { m_node = node; }

      void SetSelectable (bool IsSelectable) { m_IsSelectable = IsSelectable; }

      void SetupExtValues (EXTVALUES ExtValues);

      bool GetINIString (MISTRING& inistring) const;

      bool SetFromINIString (const MISTRING& inistring);

   protected:

      void SetFilePath (
         const FILEPATH& filepath
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MISTRING m_name;
      MISTRING m_location;
      MISTRING m_description;
      TYPE m_type;
      RVC::OBJTYPE m_rvctype;
      INT32 m_subtype;
      bool m_IsBrowsable;
      bool m_IsSelectable;
      UINT32 m_ExtValuesValid;
      RVC::OBJITEM *m_pObjItem;
      mutable MINETRES *m_pNetRes;
      mutable OBJECTSTATE m_ObjectState;
      XMLNODE* m_node;
      INT32 m_order;
      DATETIME m_TimeCreated;
      DATETIME m_TimeModified;
      INT64 m_SizeInBytes;
      INT64 m_DimensionValue;
      MISTRING m_DimensionString;
      SPATREF::COORDREFSYS m_CRS;
      DRECT3D m_ExtentInCRS;
      DPOINT3D m_ResolutionInCRS;
      DELEGATE_ONLOADWEBLAYERS m_DelegateOnLoadWebLayers;

      ELEMTYPE AddDimensionElemCount (RVC::GEOMETRIC& ObjGeometric, ELEMTYPE ElemType, ELEMTYPE PrevType);
      // Set description.
      void SetDescription (const MISTRING& description);
      #endif
   };

//    DLG_GETOBJECT::ITEM definition - End
//=====================================================================================================================
}  // End namespace MGUI

#endif   // INC_MGUI_DLGGETOBJECTITEM_H

---