soa/wmscapabilities.h

Go to the documentation of this file.

#ifndef  INC_SOA_WMSCAPABILITIES_H
#define  INC_SOA_WMSCAPABILITIES_H

#ifndef  INC_MI32_MISTRINGLIST_H
   #include <mi32/mistringlist.h>
#endif

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

#ifndef  INC_MI32_RECT_H
   #include <mi32/rect.h>
#endif

class XMLDOC;
class XMLNODE;
class HTTPMESSAGE;
class SUBREGION2D;

namespace SOA {
namespace WMS {

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

class ONLINERESOURCE {
   public:
      ONLINERESOURCE ();

      ~ONLINERESOURCE ();

      const MISTRING& GetHref (
         ) const { return (m_href); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      MISTRING m_href;
      #endif
   };

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

class BASEURL {
   public:

      const MISTRING& GetFormat (
         ) const { return (m_Format); }

      const ONLINERESOURCE& GetOnlineResource (
         ) const { return (m_OnlineResource); }

   protected:

      BASEURL ();

      ~BASEURL ();

      ERRVALUE ParseItem (
         const XMLNODE *itemnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      ONLINERESOURCE m_OnlineResource;
      MISTRING m_Format;
      #endif
   };

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

class DATAURL : public BASEURL {
   public:

      DATAURL ();

      ~DATAURL ();

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );
   };
typedef MILIST<DATAURL> DATAURLLIST;

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

class SIZEDATAURL : public BASEURL {
   public:

      SIZEDATAURL ();

      ~SIZEDATAURL ();

      UINT32 GetHeight (
         ) const { return (m_Height); }

      UINT32 GetWidth (
         ) const { return (m_Width); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Attributes
      UINT32 m_Width;
      UINT32 m_Height;
      #endif
   };
typedef MILIST<SIZEDATAURL> SIZEDATAURLLIST;

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

class CONTACTPERSON {
   public:

      CONTACTPERSON ();

      ~CONTACTPERSON ();

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

      const MISTRING& GetOrganization (
         ) const { return (m_Organization); }

      const MISTRING& GetPerson (
         ) const { return (m_Person); }

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      MISTRING m_Person;
      MISTRING m_Organization;
      #endif
   };

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

class CONTACTADDRESS {
   public:
      CONTACTADDRESS ();

      ~CONTACTADDRESS ();

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

      const MISTRING& GetAddress (
         ) const { return (m_Address); }

      const MISTRING& GetAddressType (
         ) const { return (m_AddressType); }

      const MISTRING& GetCity (
         ) const { return (m_City); }

      const MISTRING& GetCountry (
         ) const { return (m_Country); }

      const MISTRING& GetPostCode (
         ) const { return (m_PostCode); }

      const MISTRING& GetStateOrProvince (
         ) const { return (m_StateOrProvince); }

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      MISTRING m_AddressType;
      MISTRING m_Address;
      MISTRING m_City;
      MISTRING m_StateOrProvince;
      MISTRING m_PostCode;
      MISTRING m_Country;
      #endif
   };

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

class CONTACTINFORMATION {
   public:
      CONTACTINFORMATION ();

      ~CONTACTINFORMATION ();

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

      const WMS::CONTACTADDRESS& GetAddress (
         ) const { return (m_ContactAddress); }

      const MISTRING& GetPosition (
         ) const { return (m_ContactPosition); }

      const MISTRING& GetEmail (
         ) const { return (m_ContactEmail); }

      const MISTRING& GetFaxPhone (
         ) const { return (m_ContactFaxPhone); }

      const WMS::CONTACTPERSON& GetPersonPrimary (
         ) const { return (m_ContactPersonPrimary); }

      const MISTRING& GetVoicePhone (
         ) const { return (m_ContactVoicePhone); }

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      WMS::CONTACTPERSON m_ContactPersonPrimary;
      MISTRING m_ContactPosition;
      WMS::CONTACTADDRESS m_ContactAddress;
      MISTRING m_ContactVoicePhone;
      MISTRING m_ContactFaxPhone;
      MISTRING m_ContactEmail;
      #endif
   };

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

class SERVICE {
   public:
      SERVICE ();

      ~SERVICE ();

      const MISTRING& GetAbstract (
         ) const { return (m_Abstract); }

      const MISTRING& GetAccessConstraints (
         ) const { return (m_AccessConstraints); }

      const WMS::CONTACTINFORMATION& GetContactInformation (
         ) const { return (m_ContactInformation); }

      const MISTRING& GetFees (
         ) const { return (m_Fees); }

      const MISTRINGLIST& GetKeywordList (
         ) const { return (m_KeywordList); }

      UINT32 GetLayerLimit (
         ) const { return (m_LayerLimit); }

      UINT32 GetMaxHeight (
         ) const { return (m_MaxHeight); }

      UINT32 GetMaxWidth (
         ) const { return (m_MaxWidth); }

      const WMS::ONLINERESOURCE& GetOnlineResource (
         ) const { return (m_OnlineResource); }

      const MISTRING& GetTitle (
         ) const { return (m_Title); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      MISTRING m_Title;
      MISTRING m_Abstract;
      MISTRINGLIST m_KeywordList;
      WMS::ONLINERESOURCE m_OnlineResource;
      WMS::CONTACTINFORMATION m_ContactInformation;
      MISTRING m_Fees;
      MISTRING m_AccessConstraints;
      UINT32 m_LayerLimit;
      UINT32 m_MaxWidth;
      UINT32 m_MaxHeight;
      #endif
   };

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

class OPERATION {
   public:
      OPERATION ();

      ~OPERATION ();

      const MISTRINGLIST& GetFormatList (
         ) const { return (m_FormatList); }

      const ONLINERESOURCE& GetOnlineResource (
         ) const { return (m_OnlineResource); }

      bool IsAvailable (
         ) const { return (m_IsAvailable); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      MISTRINGLIST m_FormatList;
      WMS::ONLINERESOURCE m_OnlineResource;
      // Internal
      bool m_IsAvailable;
      #endif
   };

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

class REQUEST {
   public:
      REQUEST ();

      ~REQUEST ();

      const WMS::OPERATION& GetOperationGetCapabilities (
         ) const { return (m_OpGetCapabilities); }

      const WMS::OPERATION& GetOperationGetFeatureInfo (
         ) const { return (m_OpGetFeatureInfo); }

      const WMS::OPERATION& GetOperationGetMap (
         ) const { return (m_OpGetMap); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      WMS::OPERATION m_OpGetCapabilities;
      WMS::OPERATION m_OpGetMap;
      WMS::OPERATION m_OpGetFeatureInfo;
      #endif
   };

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

class EXTENDEDCAPABILITIES {
   public:
   private:
   };

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

class BOUNDINGBOX {
   public:
      BOUNDINGBOX ();

      ~BOUNDINGBOX ();

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

      const DRECT2D& GetExtent (
         ) const { return (m_Extent); }

      const DPOINT2D& GetResolution (
         ) const { return (m_Resolution); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Attributes
      SPATREF::COORDREFSYS m_CRS;
      DRECT2D m_Extent;
      DPOINT2D m_Resolution;
      #endif
   };
typedef MILIST<BOUNDINGBOX> BOUNDINGBOXLIST;

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

class DIMENSION {
   public:
      DIMENSION ();

      ~DIMENSION ();

      const MISTRING& GetDefault (
         ) const { return (m_Default); }

      const MISTRING& GetName (
         ) const { return (m_Name); }

      const MISTRING& GetUnits (
         ) const { return (m_Units); }

      const MISTRING& GetUnitSymbol (
         ) const { return (m_UnitSymbol); }

      const MISTRING& GetValue (
         ) const { return (m_Value); }

      bool HasMultipleValues (
         ) const { return (m_MultipleValues); }

      bool IsCurrent (
         ) const { return (m_Current); }

      bool IsNearestValue (
         ) const { return (m_NearestValue); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Attributes
      MISTRING m_Name;
      MISTRING m_Units;
      MISTRING m_UnitSymbol;
      MISTRING m_Default;
      MISTRING m_Value;
      bool m_MultipleValues;
      bool m_NearestValue;
      bool m_Current;
      #endif
   };
typedef MILIST<DIMENSION> DIMENSIONLIST;

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

class ATTRIBUTION {
   public:
      ATTRIBUTION ();

      ~ATTRIBUTION ();

      const WMS::SIZEDATAURL& GetLogoURL (
         ) const { return (m_LogoURL); }

      const ONLINERESOURCE& GetOnlineResource (
         ) const { return (m_OnlineResource); }

      const MISTRING& GetTitle (
         ) const { return (m_Title); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      MISTRING m_Title;
      WMS::ONLINERESOURCE m_OnlineResource;
      WMS::SIZEDATAURL m_LogoURL;
      #endif
   };

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

class METADATAURL : BASEURL {
   public:
      enum TYPE {
         TYPE_Unknown,
         TYPE_ISO_19115_2003,    // ISO 19115:2003, XML type="ISO19115:2003"
         TYPE_FGDC_1998,         // FGDC-STD-001-1998, XML type="FGDC:1998"
         TYPE_COUNT
         };

      METADATAURL ();

      ~METADATAURL ();

      TYPE GetType (
         ) const { return (m_Type); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Attributes
      TYPE m_Type;
      #endif
   };
typedef MILIST<METADATAURL> METADATAURLLIST;

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

class STYLE {
   public:
      STYLE ();

      ~STYLE ();

      const MISTRING& GetAbstract (
         ) const { return (m_Abstract); }

      const WMS::SIZEDATAURLLIST& GetLegendURLList (
         ) const { return (m_LegendURLList); }

      const MISTRING& GetName (
         ) const { return (m_Name); }

      const WMS::DATAURL& GetStyleSheetURL (
         ) const { return (m_StyleSheetURL); }

      const WMS::DATAURL& GetStyleURL (
         ) const { return (m_StyleURL); }

      const MISTRING& GetTitle (
         ) const { return (m_Title); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      MISTRING m_Name;
      MISTRING m_Title;
      MISTRING m_Abstract;
      WMS::SIZEDATAURLLIST m_LegendURLList;
      DATAURL m_StyleSheetURL;
      DATAURL m_StyleURL;
      #endif
   };
typedef MILIST<STYLE> STYLELIST;

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

class LAYER {
   public:
      LAYER ();

      ~LAYER ();

      ERRVALUE ComputeSubRegion (
         const SPATREF::COORDREFSYS& CoordRefSys,
         SUBREGION2D& SubRegion
         ) const;

      const WMS::BOUNDINGBOX* FindBoundingBox (
         const SPATREF::COORDREFSYS *pCRS
         ) const;

      const WMS::LAYER* FindLayer (
         const MISTRING& LayerName           
         ) const;

      const WMS::STYLE* FindStyle (
         const MISTRING& StyleName           
         ) const;

      const MISTRING& GetAbstract (
         ) const { return (m_Abstract); }

      const WMS::ATTRIBUTION& GetAttribution (
         ) const { return (m_Attribution); }

      const WMS::BOUNDINGBOXLIST& GetBoundingBoxList (
         ) const { return (m_BoundingBoxList); }

      int GetCascaded (
         ) const { return (m_Cascaded); }

      bool GetCoordRefSysId (
         const SPATREF::COORDREFSYS& CoordRefSys,
         MISTRING& IdStr                              
         ) const;

      void GetCoordRefSysList (
         SPATREF::COORDREFSYSLIST& CoordRefSysList,   
         bool IncludeTopLayer                         
         ) const;

      int GetFixedHeight (
         ) const { return (m_FixedHeight); }

      int GetFixedWidth (
         ) const { return (m_FixedWidth); }

      const DRECT2D& GetGeographicBoundingBox (
         ) const;

      const MISTRINGLIST& GetKeywordList (
         ) const { return (m_KeywordList); }

      const MILIST<LAYER>& GetLayerList (
         ) const { return (m_LayerList); }

      double GetMaxScaleDenominator (
         ) const { return (m_MaxScaleDenominator); }

      double GetMinScaleDenominator (
         ) const { return (m_MinScaleDenominator); }

      const MISTRING& GetName (
         ) const { return (m_Name); }

      const LAYER* GetParent (
         ) const { return (m_pParent); }

      const STYLELIST& GetStyleList (
         ) const { return (m_StyleList); }

      const MISTRING& GetTitle (
         ) const { return (m_Title); }

      bool IsNoSubsets (
         ) const { return (m_NoSubsets); }

      bool IsOpaque (
         ) const { return (m_Opaque); }

      bool IsQueryable (
         ) const { return (m_Queryable); }

      ERRVALUE ParseXML (
         const LAYER *pParent,
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      const WMS::LAYER *m_pParent;
      // Attributes
      bool m_Queryable;
      int m_Cascaded;
      bool m_Opaque;
      bool m_NoSubsets;
      int m_FixedWidth;
      int m_FixedHeight;
      // Elements
      MISTRING m_Name;
      MISTRING m_Title;
      MISTRING m_Abstract;
      MISTRINGLIST m_KeywordList;
      SPATREF::COORDREFSYSLIST m_CoordRefSysList;
      MISTRINGLIST m_CoordRefSysIdList;
      DRECT2D m_GeographicBoundingBox;
      WMS::BOUNDINGBOXLIST m_BoundingBoxList;
      WMS::DIMENSIONLIST m_DimensionList;
      WMS::ATTRIBUTION m_Attribution;
      MISTRINGLIST m_AuthorityURLList;
      MISTRINGLIST m_IdentifierList;
      WMS::METADATAURLLIST m_MetadataURLList;
      WMS::DATAURLLIST m_DataURLList;
      WMS::DATAURLLIST m_FeatureListURLList;
      STYLELIST m_StyleList;
      double m_MinScaleDenominator;
      double m_MaxScaleDenominator;
      MILIST<LAYER> m_LayerList;

      void GetCoordRefSysListLow (SPATREF::COORDREFSYSLIST& CoordRefSysList, bool IncludeTopLayer) const;
      ERRVALUE ParseGeographicBoundingBox (const XMLNODE *xmlnode);
      ERRVALUE ParseLatLonBoundingBox (const XMLNODE *xmlnode);

      #endif
   };
typedef MILIST<LAYER> LAYERLIST;

//=====================================================================================================================
class CAPABILITY {
   public:
      
      // Nested to avoid conflict with actual exception container.
      class EXCEPTION {
         public:
            EXCEPTION ();

            ~EXCEPTION ();

            const MISTRINGLIST& GetFormatList (
               ) const { return (m_FormatList); }

            ERRVALUE ParseXML (
               const XMLNODE *xmlnode
               );

         private:
            #ifndef  GENERATING_DOXYGEN_OUTPUT
            MISTRINGLIST m_FormatList;
            #endif
         };

      CAPABILITY ();

      ~CAPABILITY ();

      const WMS::LAYER* FindLayer (
         const MISTRING& LayerName           
         ) const;

      bool GetCoordRefSysId (
         const SPATREF::COORDREFSYS& CoordRefSys,
         MISTRING& IdStr                              
         ) const;

      void GetCommonCoordRefSysList (
         const MISTRINGLIST& LayerNameList,           
         SPATREF::COORDREFSYSLIST& CoordRefSysList    
         ) const;

      const WMS::CAPABILITY::EXCEPTION& GetException (
         ) const { return (m_Exception); }

      const WMS::LAYER& GetLayer (
         ) const { return (m_Layer); }

      const WMS::REQUEST& GetRequest (
         ) const { return (m_Request); }

      ERRVALUE ParseXML (
         const XMLNODE *xmlnode
         );

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      // Elements
      WMS::REQUEST m_Request;
      WMS::CAPABILITY::EXCEPTION m_Exception;
      WMS::LAYER m_Layer;
      #endif
   };

//=====================================================================================================================
class CAPABILITIES {
   public:

      CAPABILITIES ();

      ~CAPABILITIES ();

      void AddRef (
         ) { ++m_RefCount; }

      const WMS::CAPABILITY& GetCapability (
         ) const { return (m_Capability); }

      const WMS::SERVICE& GetService (
         ) const { return (m_Service); }

      const MISTRING& GetVersion (
         ) const { return (m_Version); }

      const MISTRING& GetUpdateSequence (
         ) const { return (m_UpdateSequence); }

      const XMLDOC& GetXML (
         ) const { return (*m_pDocReply); }

      ERRVALUE ParseMessage (
         const HTTPMESSAGE& message
         );

      void Release (
         ) {
         if ((--m_RefCount) == 0) delete this;
         }

   private:
      #ifndef  GENERATING_DOXYGEN_OUTPUT
      UINT32 m_RefCount;
      XMLDOC *m_pDocReply;
      // Elements
      WMS::SERVICE m_Service;
      WMS::CAPABILITY m_Capability;
      // Attributes
      MISTRING m_Version;
      MISTRING m_UpdateSequence;
      // Unimplemented
      CAPABILITIES (const CAPABILITIES& rhs);
      CAPABILITIES& operator= (const CAPABILITIES& rhs);
      #endif
   };

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

}  // End namespace WMS
}  // End namespace SOA

#endif   // INC_SOA_WMSCAPABILITIES_H

---