[mapguide-commits] r6324 - in trunk/Tools/Maestro: Doc/Images Doc/Topics OSGeo.MapGuide.MaestroAPI OSGeo.MapGuide.MaestroAPI/Mapping

svn_mapguide at osgeo.org svn_mapguide at osgeo.org
Fri Dec 9 05:27:04 EST 2011


Author: jng
Date: 2011-12-09 02:27:04 -0800 (Fri, 09 Dec 2011)
New Revision: 6324

Modified:
   trunk/Tools/Maestro/Doc/Images/CoreTypesClassDiagram.png
   trunk/Tools/Maestro/Doc/Topics/Concept_RuntimeMap.aml
   trunk/Tools/Maestro/Doc/Topics/GettingStarted.aml
   trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoreTypes.cd
   trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs
   trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs
   trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs
   trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs
Log:
Remove unnecessary try/catch in Utility.CopyStream. Also some more API documentation updates (#1319)

Modified: trunk/Tools/Maestro/Doc/Images/CoreTypesClassDiagram.png
===================================================================
(Binary files differ)

Modified: trunk/Tools/Maestro/Doc/Topics/Concept_RuntimeMap.aml
===================================================================
--- trunk/Tools/Maestro/Doc/Topics/Concept_RuntimeMap.aml	2011-12-09 06:34:18 UTC (rev 6323)
+++ trunk/Tools/Maestro/Doc/Topics/Concept_RuntimeMap.aml	2011-12-09 10:27:04 UTC (rev 6324)
@@ -44,7 +44,8 @@
 		<code>Session:session-id//mapName.Map</code>
 		<para>
 		Most of this runtime map state can be manipulated through the APIs provided by the Maestro API. When manipulating the state
-		of the runtime map, you must remember to call <codeEntityReference qualifyHint="false">M:OSGeo.MapGuide.MaestroAPI.Mapping.RuntimeMap.Save</codeEntityReference> on the map
+		of the runtime map (which also includes modifications to layers and groups that belong to it), you must remember to call 
+		<codeEntityReference qualifyHint="false">M:OSGeo.MapGuide.MaestroAPI.Mapping.RuntimeMap.Save</codeEntityReference> on the map
 		to persist your modifications.
 		</para>
       </content>

Modified: trunk/Tools/Maestro/Doc/Topics/GettingStarted.aml
===================================================================
--- trunk/Tools/Maestro/Doc/Topics/GettingStarted.aml	2011-12-09 06:34:18 UTC (rev 6323)
+++ trunk/Tools/Maestro/Doc/Topics/GettingStarted.aml	2011-12-09 10:27:04 UTC (rev 6324)
@@ -85,8 +85,7 @@
         
         Then in your application's entry point, add the following line of code:
         </para>
-		<code language="cs">
-		/// Code 
+		<code language="cs"> 
 		ModelSetup.Initialize();
 		</code>
 		<para>

Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoreTypes.cd
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoreTypes.cd	2011-12-09 06:34:18 UTC (rev 6323)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoreTypes.cd	2011-12-09 10:27:04 UTC (rev 6324)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <ClassDiagram MajorVersion="1" MinorVersion="1" GroupingSetting="Access">
   <Comment CommentText="Runtime Map Classes">
-    <Position X="24.312" Y="1.387" Height="0.311" Width="2.134" />
+    <Position X="24.124" Y="1.189" Height="0.311" Width="2.759" />
   </Comment>
   <Comment CommentText="Maestro API root classes / interfaces">
     <Position X="23.786" Y="6.767" Height="0.441" Width="2.653" />
@@ -18,8 +18,8 @@
   <Comment CommentText="Use IServerConnection.GetService(int) to create service objects of the specified type, passing in a ServiceType enum casted to an int. Use connection capabilities to determine supported services. All IServerConnection implementations have built-in support for resource and feature services and are accessible  via the top-level ResourceService and FeatureService properties.">
     <Position X="11.946" Y="6.668" Height="1.073" Width="4.942" />
   </Comment>
-  <Comment CommentText="The IMappingService provides operations to create, open and interact with a RuntimeMap">
-    <Position X="24.298" Y="1.851" Height="0.609" Width="2.134" />
+  <Comment CommentText="The IMappingService provides operations to create, open and interact with a RuntimeMap and methods to create RuntimeMapLayer and RuntimeMapGroup instances that can then be added to the RuntimeMap">
+    <Position X="24.11" Y="1.653" Height="0.984" Width="3.113" />
   </Comment>
   <Comment CommentText="Schema API - Classes used to model the structure of a Feature Source">
     <Position X="22.665" Y="9.539" Height="0.353" Width="4.34" />
@@ -61,7 +61,7 @@
     <Position X="7.266" Y="9.617" Height="0.531" Width="1.971" />
   </Comment>
   <Comment CommentText="Used for creating, opening and interacting with a Runtime Map">
-    <Position X="9.508" Y="10.805" Height="0.552" Width="1.971" />
+    <Position X="9.529" Y="11.295" Height="0.552" Width="1.971" />
   </Comment>
   <Comment CommentText="Used for querying MapGuide Server information">
     <Position X="11.758" Y="10.034" Height="0.51" Width="1.981" />
@@ -273,7 +273,7 @@
   <Interface Name="OSGeo.MapGuide.MaestroAPI.Services.IMappingService">
     <Position X="9.5" Y="8.25" Width="2" />
     <TypeIdentifier>
-      <HashCode>AAAAAAAAEAAAAAAAAAAAAAAAAEAAAAAEABAAEAAAUAA=</HashCode>
+      <HashCode>AAAAAAAAEAAAAAAAAAEAAAAAAEAAAAAEABAAEAAAUAE=</HashCode>
       <FileName>Services\IMappingService.cs</FileName>
     </TypeIdentifier>
   </Interface>

Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs	2011-12-09 06:34:18 UTC (rev 6323)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs	2011-12-09 10:27:04 UTC (rev 6324)
@@ -26,7 +26,8 @@
 namespace OSGeo.MapGuide.MaestroAPI.Mapping
 {
     /// <summary>
-    /// Represents a group of layers in a runtime map
+    /// Represents a group of layers in a runtime map. Use <see cref="M:OSGeo.MapGuide.MaestroAPI.Services.IMappingService.CreateMapGroup(OSGeo.MapGuide.MaestroAPI.Mapping.RuntimeMap,OSGeo.MapGuide.ObjectModels.MapDefinition.IMapLayerGroup)"/> to create
+    /// instances of this class.
     /// </summary>
     public class RuntimeMapGroup : MapObservable
     {

Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs	2011-12-09 06:34:18 UTC (rev 6323)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs	2011-12-09 10:27:04 UTC (rev 6324)
@@ -60,7 +60,8 @@
     }
 
     /// <summary>
-    /// Represents a runtime map layer
+    /// Represents a runtime map layer. Use <see cref="M:OSGeo.MapGuide.MaestroAPI.Services.IMappingService.CreateMapLayer(OSGeo.MapGuide.MaestroAPI.Mapping.RuntimeMap,OSGeo.MapGuide.ObjectModels.LayerDefinition.ILayerDefinition)"/> to create
+    /// instances of this class.
     /// </summary>
     public class RuntimeMapLayer : MapObservable
     {

Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs	2011-12-09 06:34:18 UTC (rev 6323)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs	2011-12-09 10:27:04 UTC (rev 6324)
@@ -1729,6 +1729,7 @@
         /// <returns></returns>
         public virtual RuntimeMapGroup CreateMapGroup(RuntimeMap parent, string name)
         {
+            //TODO: Review when we split implementations
             return new RuntimeMapGroup(parent, name);
         }
 
@@ -1740,6 +1741,7 @@
         /// <returns></returns>
         public virtual RuntimeMapGroup CreateMapGroup(RuntimeMap parent, IBaseMapGroup group)
         {
+            //TODO: Review when we split implementations
             return new RuntimeMapGroup(parent, group);
         }
 
@@ -1751,6 +1753,7 @@
         /// <returns></returns>
         public virtual RuntimeMapGroup CreateMapGroup(RuntimeMap parent, IMapLayerGroup group)
         {
+            //TODO: Review when we split implementations
             return new RuntimeMapGroup(parent, group);
         }
 

Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs	2011-12-09 06:34:18 UTC (rev 6323)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs	2011-12-09 10:27:04 UTC (rev 6324)
@@ -273,8 +273,8 @@
         public static void CopyStream(System.IO.Stream source, System.IO.Stream target, StreamCopyProgressDelegate callback, long updateFrequence)
         {
             long length = -1;
-            try { length = source.Length; }
-            catch { }
+            if (source.CanSeek)
+                length = source.Length;
 
             long copied = 0;
             long freqCount = 0;



More information about the mapguide-commits mailing list