[mapguide-commits] r8201 - in sandbox/jng/tiling/Common: MapGuideCommon/MapLayer MapGuideCommon/Services PlatformBase/MapLayer
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Fri Jun 13 17:09:48 PDT 2014
Author: jng
Date: 2014-06-13 17:09:48 -0700 (Fri, 13 Jun 2014)
New Revision: 8201
Modified:
sandbox/jng/tiling/Common/MapGuideCommon/MapLayer/Map.h
sandbox/jng/tiling/Common/MapGuideCommon/Services/RenderingService.h
sandbox/jng/tiling/Common/MapGuideCommon/Services/TileService.h
sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroup.h
sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroupType.h
sandbox/jng/tiling/Common/PlatformBase/MapLayer/MapBase.h
Log:
Clean up documentation of the new APIs.
Modified: sandbox/jng/tiling/Common/MapGuideCommon/MapLayer/Map.h
===================================================================
--- sandbox/jng/tiling/Common/MapGuideCommon/MapLayer/Map.h 2014-06-11 13:19:17 UTC (rev 8200)
+++ sandbox/jng/tiling/Common/MapGuideCommon/MapLayer/Map.h 2014-06-14 00:09:48 UTC (rev 8201)
@@ -316,9 +316,14 @@
//////////////////////////////////////////////////////////////////
/// \brief
/// Initializes a new MgMap object given a resource service, map
- /// definition, and a name for the map. This method is used for
- /// MapGuide Viewers or for offline map production.
+ /// definition or tile set definiton, and a name for the map. This
+ /// method is used for MapGuide Viewers or for offline map production.
///
+ /// \remarks
+ /// If creating a MgMap object from a tile set definition, only "Default" is the
+ /// acceptable tile provider. Any other provider will cause this method to
+ /// throw a MgUnsupportedTileProviderException
+ ///
/// \deprecated
/// This method has been deprecated. Use the following method:
/// \link MgMap::Create(MgResourceIdentifier*,CREFSTRING) Create(MgResourceIdentifier mapDefinition, string mapName) \endlink.
@@ -337,9 +342,9 @@
/// \param resourceService
/// An MgResourceService that can be used to
/// retrieve the map definition.
- /// \param mapDefinition
+ /// \param resource
/// An MgResourceIdentifier that specifies the
- /// location of the map definition in a resource
+ /// location of the map definition or tile set definition in a resource
/// repository.
/// \param mapName
/// A string that specifies the name of the map.
@@ -354,14 +359,19 @@
/// \endcode
/// \htmlinclude ExampleBottom.html
///
- virtual void Create(MgResourceService* resourceService, MgResourceIdentifier* mapDefinition, CREFSTRING mapName);
+ virtual void Create(MgResourceService* resourceService, MgResourceIdentifier* resource, CREFSTRING mapName);
//////////////////////////////////////////////////////////////////
/// \brief
- /// Initializes a new MgMap object given a map definition
- /// and a name for the map. This method is used for
+ /// Initializes a new MgMap object given a map definition or tile set
+ /// definition and a name for the map. This method is used for
/// MapGuide Viewers or for offline map production.
///
+ /// \remarks
+ /// If creating a MgMap object from a tile set definition, only "Default" is the
+ /// acceptable tile provider. Any other provider will cause this method to
+ /// throw a MgUnsupportedTileProviderException
+ ///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
/// void Create(MgResourceIdentifier mapDefinition, string mapName);
@@ -373,7 +383,7 @@
/// void Create(MgResourceIdentifier mapDefinition, string mapName);
/// \htmlinclude SyntaxBottom.html
///
- /// \param mapDefinition
+ /// \param resource
/// An MgResourceIdentifier that specifies the
/// location of the map definition in a resource
/// repository.
@@ -393,7 +403,7 @@
/// \endcode
/// \htmlinclude ExampleBottom.html
///
- virtual void Create(MgResourceIdentifier* mapDefinition, CREFSTRING mapName);
+ virtual void Create(MgResourceIdentifier* resource, CREFSTRING mapName);
//////////////////////////////////////////////////////////////////
/// \brief
Modified: sandbox/jng/tiling/Common/MapGuideCommon/Services/RenderingService.h
===================================================================
--- sandbox/jng/tiling/Common/MapGuideCommon/Services/RenderingService.h 2014-06-11 13:19:17 UTC (rev 8200)
+++ sandbox/jng/tiling/Common/MapGuideCommon/Services/RenderingService.h 2014-06-14 00:09:48 UTC (rev 8201)
@@ -144,6 +144,7 @@
/// \return
/// A byte reader containing the rendered tile image.
///
+ /// \since 3.0
virtual MgByteReader* RenderTileXYZ(
MgMap* map,
CREFSTRING baseMapLayerGroupName,
Modified: sandbox/jng/tiling/Common/MapGuideCommon/Services/TileService.h
===================================================================
--- sandbox/jng/tiling/Common/MapGuideCommon/Services/TileService.h 2014-06-11 13:19:17 UTC (rev 8200)
+++ sandbox/jng/tiling/Common/MapGuideCommon/Services/TileService.h 2014-06-14 00:09:48 UTC (rev 8201)
@@ -61,10 +61,15 @@
/////////////////////////////////////////////////////////////////
/// \brief
- /// Returns the specified base map tile for the given map. If a cached tile
- /// image exists it will return it, otherwise the tile is rendered and added
- /// to the cache.
+ /// Returns the specified base map tile for the given map or tile set.
+ /// If a cached tile image exists it will return it, otherwise the tile
+ /// is rendered and added to the cache.
///
+ /// \remarks
+ /// If retrieving a tile from a tile set, the row, column and scale index
+ /// may take on different meaning depending on the tile provider specified
+ /// in the tile set
+ ///
/// \param resource
/// Input
/// Resource identifier for the map definition or Tile Set Definition
@@ -164,8 +169,12 @@
//////////////////////////////////////////////////////////////////
/// \brief
- /// Returns the list of available tile providers, along with supported connection parameters
+ /// Returns the XML description of available tile providers, along with supported connection parameters. This provides
+ /// sufficient information for client applications to build rich editor user interfaces for editing Tile Set Definitions
///
+ /// \return
+ /// The XML description of available tile providers
+ ///
/// \since 3.0
virtual MgByteReader* GetTileProviders() = 0;
Modified: sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroup.h
===================================================================
--- sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroup.h 2014-06-11 13:19:17 UTC (rev 8200)
+++ sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroup.h 2014-06-14 00:09:48 UTC (rev 8201)
@@ -442,13 +442,13 @@
///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
- /// bool SetExpandInLegend(bool expandInLegend);
+ /// MgResourceIdentifier GetTileSetDefinition();
/// \htmlinclude SyntaxBottom.html
/// \htmlinclude JavaSyntaxTop.html
- /// boolean SetExpandInLegend(boolean expandInLegend);
+ /// MgResourceIdentifier GetTileSetDefinition();
/// \htmlinclude SyntaxBottom.html
/// \htmlinclude PHPSyntaxTop.html
- /// bool SetExpandInLegend(bool expandInLegend);
+ /// MgResourceIdentifier GetTileSetDefinition();
/// \htmlinclude SyntaxBottom.html
///
/// \since 3.0
Modified: sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroupType.h
===================================================================
--- sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroupType.h 2014-06-11 13:19:17 UTC (rev 8200)
+++ sandbox/jng/tiling/Common/PlatformBase/MapLayer/LayerGroupType.h 2014-06-14 00:09:48 UTC (rev 8201)
@@ -42,8 +42,12 @@
static const INT32 BaseMap = 2;
/////////////////////////////////////////////////
/// \brief
- /// Specifies that the layer is a base map layer from a TileSetDefinition resource
+ /// Specifies that the layer is a base map layer from a TileSetDefinition resource.
///
+ /// \remarks
+ /// From a client application perspective, a layer group with of this type should be treated
+ /// the same as layer group of type \link MgLayerGroupType::BaseMap BaseMap \endlink
+ ///
/// \since 3.0
static const INT32 BaseMapFromTileSet = 3;
};
Modified: sandbox/jng/tiling/Common/PlatformBase/MapLayer/MapBase.h
===================================================================
--- sandbox/jng/tiling/Common/PlatformBase/MapLayer/MapBase.h 2014-06-11 13:19:17 UTC (rev 8200)
+++ sandbox/jng/tiling/Common/PlatformBase/MapLayer/MapBase.h 2014-06-14 00:09:48 UTC (rev 8201)
@@ -158,7 +158,9 @@
/// Returns the resource identifier that specifies the location
/// of the map definition that was used to create this map.
///
- /// \note1
+ /// \remarks
+ /// If this map was created from a Tile Set Definition, this method
+ /// will return NULL
///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
@@ -173,7 +175,8 @@
///
/// \return
/// Returns an MgResourceIdentifier that specifies the location
- /// of the map definition.
+ /// of the map definition. NULL is returned if this map was created
+ /// from a Tile Set Definition
///
virtual MgResourceIdentifier* GetMapDefinition(); /// __get
More information about the mapguide-commits
mailing list