[mapguide-commits] r6219 - in trunk/Tools/Maestro:
ExtendedModels/LayerDefinition-1.1.0/Properties Maestro.Base
Maestro.Base/Events Maestro.Base/Services Maestro.Editors
Maestro.Editors/Common Maestro.Editors/FeatureSource
Maestro.Editors/FeatureSource/Preview
Maestro.Editors/FeatureSource/Providers/Odbc Maestro.Editors/Fusion
Maestro.Editors/Generic Maestro.Editors/LayerDefinition
Maestro.Editors/LayerDefinition/Vector/Scales
Maestro.Editors/LayerDefinition/Vector/StyleEditors
Maestro.Editors/MapDefinition Maestro.Editors/Packaging
Maestro.Editors/SymbolDefinition Maestro.Editors/WatermarkDefinition
Maestro.Login Maestro.Packaging Maestro.Shared.UI MaestroAPITests
OSGeo.MapGuide.MaestroAPI OSGeo.MapGuide.MaestroAPI/Commands
OSGeo.MapGuide.MaestroAPI/CoordinateSystem
OSGeo.MapGuide.MaestroAPI/CrossConnection
OSGeo.MapGuide.MaestroAPI/Exceptions OSGeo.MapGuide.MaestroAPI/Expression
OSGeo.MapGuide.MaestroAPI/Feature OSGeo.MapGuide.MaestroAPI/Mapping
OSGeo.MapGuide.MaestroAPI/ObjectModels
OSGeo.MapGuide.MaestroAPI/Resource
OSGeo.MapGuide.MaestroAPI/Resource/Conversion
OSGeo.MapGuide.MaestroAPI/Resource/Validation
OSGeo.MapGuide.MaestroAPI/Schema OSGeo.MapGuide.MaestroAPI/SchemaOverrides
Properties
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Fri Nov 11 08:49:12 EST 2011
Author: jng
Date: 2011-11-11 05:49:12 -0800 (Fri, 11 Nov 2011)
New Revision: 6219
Modified:
trunk/Tools/Maestro/ExtendedModels/LayerDefinition-1.1.0/Properties/AssemblyInfo.cs
trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs
trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs
trunk/Tools/Maestro/Maestro.Base/ViewContentBase.cs
trunk/Tools/Maestro/Maestro.Editors/Common/ColorPickerDialog.cs
trunk/Tools/Maestro/Maestro.Editors/Common/GenericInputDialog.cs
trunk/Tools/Maestro/Maestro.Editors/Common/ResourceDataCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/Common/ResourcePicker.cs
trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Preview/PreviewPane.cs
trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/OdbcDriverMap.cs
trunk/Tools/Maestro/Maestro.Editors/FeatureSource/SpatialContextsDialog.cs
trunk/Tools/Maestro/Maestro.Editors/Fusion/FlexibleLayoutEditor.cs
trunk/Tools/Maestro/Maestro.Editors/Fusion/FusionWidgetEditorMap.cs
trunk/Tools/Maestro/Maestro.Editors/Fusion/WidgetEditorFactory.cs
trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/LastSelectedFolder.cs
trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/RasterLayerEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ColorExpressionField.cs
trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs
trunk/Tools/Maestro/Maestro.Editors/Packaging/AddResourceEntryDialog.cs
trunk/Tools/Maestro/Maestro.Editors/Packaging/EditResourceDataEntryDialog.cs
trunk/Tools/Maestro/Maestro.Editors/Packaging/PackageEditorDialog.cs
trunk/Tools/Maestro/Maestro.Editors/RepositoryHandle.cs
trunk/Tools/Maestro/Maestro.Editors/RepositoryIcons.cs
trunk/Tools/Maestro/Maestro.Editors/ResourceEditorServiceBase.cs
trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/CompoundSymbolDefinitionEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SimpleSymbolDefinitionEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SymbolField.cs
trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/UsageContextsCtrl.cs
trunk/Tools/Maestro/Maestro.Editors/WatermarkDefinition/WatermarkEditorCtrl.cs
trunk/Tools/Maestro/Maestro.Login/LocalLoginCtrl.cs
trunk/Tools/Maestro/Maestro.Packaging/PackageBuilder.cs
trunk/Tools/Maestro/Maestro.Packaging/PackageUploadOptionDialog.cs
trunk/Tools/Maestro/Maestro.Packaging/PackageUploadResultDialog.cs
trunk/Tools/Maestro/Maestro.Packaging/UploadPackageResult.cs
trunk/Tools/Maestro/Maestro.Shared.UI/ErrorDialog.cs
trunk/Tools/Maestro/MaestroAPITests/ResourceTests.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/IGetFdoCacheInfo.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/CoordinateSystemCatalog.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/ISimpleTransform.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CrossConnection/ResourceRebaser.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Exceptions/NestedExceptionMessageProcessor.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Expression/ExpressionFeatureReader.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureReaderBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/IReader.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/PropertyValue.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/ReaderBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/RecordBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/MapSelection.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ApplicationDefinitionInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/CommonTypes.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/DrawingSourceInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/IFdoSpatialContext.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ObjectFactory.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolDefFactory.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/WatermarkInterfaces.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/IResourceConverter.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/IResourceValidator.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/BaseSymbolDefinitionValidator.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/MapDefinitionValidator.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidationContext.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidatorSet.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ValidationStatusCode.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/ClassDefinition.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/DataPropertyDefinition.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSchema.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSourceDescription.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/GeometricPropertyDefinition.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/PropertyDefinition.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/RasterPropertyDefinition.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/RasterWmsItem.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsLayerDefinition.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/XmlValidator.cs
trunk/Tools/Maestro/Properties/SignedAssemblyInfo.cs
trunk/Tools/Maestro/Properties/SignedAssemblyInfo2.cs
Log:
#1319: Flesh out API documentation. Also fix some broken unit tests
Modified: trunk/Tools/Maestro/ExtendedModels/LayerDefinition-1.1.0/Properties/AssemblyInfo.cs
===================================================================
--- trunk/Tools/Maestro/ExtendedModels/LayerDefinition-1.1.0/Properties/AssemblyInfo.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/ExtendedModels/LayerDefinition-1.1.0/Properties/AssemblyInfo.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -1,6 +1,5 @@
using System.Reflection;
-using System.Reflection;
using System.Runtime.InteropServices;
// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
Modified: trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Base/Events/EventWatcher.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -68,7 +68,7 @@
conn.FeatureService.GetProviderCapabilities("OSGeo.SDF");
LoggingService.Info("Session kept alive: " + sessionId);
}
- catch (Exception ex)
+ catch (Exception)
{
if (smShowingError)
return;
Modified: trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Base/Services/NewItemTemplateService.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -81,7 +81,7 @@
var tpl = new UserItemTemplate(file);
tpls.Add(tpl);
}
- catch (Exception ex)
+ catch (Exception)
{
LoggingService.Info("Could not load user template: " + file); //LOCALIZE
}
Modified: trunk/Tools/Maestro/Maestro.Base/ViewContentBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Base/ViewContentBase.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Base/ViewContentBase.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -36,6 +36,9 @@
[ToolboxItem(false)]
public partial class ViewContentBase : UserControl, IViewContent
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ViewContentBase"/> class.
+ /// </summary>
public ViewContentBase()
{
InitializeComponent();
@@ -43,6 +46,9 @@
private string _title;
+ /// <summary>
+ /// The title of the view
+ /// </summary>
public string Title
{
get
@@ -61,13 +67,24 @@
}
}
+ /// <summary>
+ /// Fires when the title has been changed
+ /// </summary>
public event EventHandler TitleChanged;
+ /// <summary>
+ /// Detrmines if this view can be closed by the user, note that this does not affect the <see cref="Close"/> method
+ /// in any way. All view content can still be programmatically closed if they inherit from <see cref="ViewContentBase"/> and
+ /// does not override the default implementation of <see cref="Close"/>
+ /// </summary>
public virtual bool AllowUserClose
{
get { return true; }
}
+ /// <summary>
+ /// Closes the view. This raises the <see cref="ViewContentClosing"/> event
+ /// </summary>
public virtual void Close()
{
CancelEventArgs ce = new CancelEventArgs(false);
@@ -83,33 +100,69 @@
handler(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Fired when the view has been closed internally
+ /// </summary>
public event CancelEventHandler ViewContentClosing;
+ /// <summary>
+ /// Displays an exception message
+ /// </summary>
+ /// <param name="ex">The exception object</param>
public void ShowError(Exception ex)
{
ErrorDialog.Show(ex);
}
+ /// <summary>
+ /// Displays an error message
+ /// </summary>
+ /// <param name="message">The message</param>
public void ShowError(string message)
{
MessageService.ShowError(message);
}
+ /// <summary>
+ /// Displays an alert message
+ /// </summary>
+ /// <param name="title">The title of this message</param>
+ /// <param name="message">The message</param>
public void ShowMessage(string title, string message)
{
MessageService.ShowMessage(message, title);
}
+ /// <summary>
+ /// Make a request for confirmation
+ /// </summary>
+ /// <param name="title">The title of the confirmation message</param>
+ /// <param name="message">The message</param>
+ /// <returns>
+ /// true if confirmed, false otherwise
+ /// </returns>
public bool Confirm(string title, string message)
{
return MessageService.AskQuestion(message, title);
}
+ /// <summary>
+ /// Make a request for confirmation
+ /// </summary>
+ /// <param name="title">The title of the confirmation message</param>
+ /// <param name="format">The message template</param>
+ /// <param name="args">The template values</param>
+ /// <returns>
+ /// true if confirmed, false otherwise
+ /// </returns>
public bool ConfirmFormatted(string title, string format, params string[] args)
{
return MessageService.AskQuestion(string.Format(format, args), title);
}
+ /// <summary>
+ /// The underlying control
+ /// </summary>
public Control ContentControl
{
get { return this; }
@@ -117,6 +170,9 @@
private string _description;
+ /// <summary>
+ /// The view's description, this is the ToolTip content
+ /// </summary>
public string Description
{
get
@@ -135,8 +191,14 @@
}
}
+ /// <summary>
+ /// Raised when the description has changed
+ /// </summary>
public event EventHandler DescriptionChanged;
+ /// <summary>
+ /// Makes this content active
+ /// </summary>
public void Activate()
{
var handler = this.ViewContentActivating;
@@ -144,12 +206,30 @@
handler(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Fired when the view is going to hide
+ /// </summary>
public event EventHandler ViewContentHiding;
+ /// <summary>
+ /// Fired when the view, which was hidden is now being shown
+ /// </summary>
public event EventHandler ViewContentShowing;
+ /// <summary>
+ /// Fired when the view is activating
+ /// </summary>
public event EventHandler ViewContentActivating;
+ /// <summary>
+ /// Conceals the control from the user.
+ /// </summary>
+ /// <PermissionSet>
+ /// <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true"/>
+ /// <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true"/>
+ /// <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence"/>
+ /// <IPermission class="System.Diagnostics.PerformanceCounterPermission, System, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true"/>
+ /// </PermissionSet>
void IViewContent.Hide()
{
var handler = this.ViewContentHiding;
@@ -157,17 +237,26 @@
handler(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Indicates whether this view is attached to a workbench
+ /// </summary>
public bool IsAttached
{
get;
internal set;
}
+ /// <summary>
+ /// Indicates the default region this view content will be put in
+ /// </summary>
public virtual ViewRegion DefaultRegion
{
get { return ViewRegion.Document; }
}
+ /// <summary>
+ /// Fired when the view has been closed internally
+ /// </summary>
public event EventHandler ViewContentClosed;
}
}
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/ColorPickerDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/ColorPickerDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/ColorPickerDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -32,6 +32,9 @@
/// </summary>
public partial class ColorPickerDialog : Form
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ColorPickerDialog"/> class.
+ /// </summary>
public ColorPickerDialog()
{
InitializeComponent();
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/GenericInputDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/GenericInputDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/GenericInputDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -32,11 +32,17 @@
/// </summary>
public partial class GenericInputDialog : Form
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="GenericInputDialog"/> class.
+ /// </summary>
public GenericInputDialog()
{
InitializeComponent();
}
+ /// <summary>
+ /// Gets the input value.
+ /// </summary>
public string InputValue { get { return txtInput.Text; } }
private void button1_Click(object sender, EventArgs e)
@@ -49,6 +55,13 @@
this.DialogResult = DialogResult.Cancel;
}
+ /// <summary>
+ /// Gets the value.
+ /// </summary>
+ /// <param name="title">The title.</param>
+ /// <param name="prompt">The prompt.</param>
+ /// <param name="initialValue">The initial value.</param>
+ /// <returns></returns>
public static string GetValue(string title, string prompt, string initialValue)
{
using (var diag = new GenericInputDialog())
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/ResourceDataCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/ResourceDataCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/ResourceDataCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -195,6 +195,10 @@
}
}
+ /// <summary>
+ /// Uploads the file.
+ /// </summary>
+ /// <param name="fileName">Name of the file.</param>
public void UploadFile(string fileName)
{
using (var fs = new FileStream(fileName, FileMode.Open))
@@ -335,6 +339,13 @@
}
}
+ /// <summary>
+ /// Determines whether the specified name contains file.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <returns>
+ /// <c>true</c> if the specified name contains file; otherwise, <c>false</c>.
+ /// </returns>
public bool ContainsFile(string name)
{
return lstDataFiles.Items.ContainsKey(name);
Modified: trunk/Tools/Maestro/Maestro.Editors/Common/ResourcePicker.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Common/ResourcePicker.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Common/ResourcePicker.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -109,6 +109,9 @@
}
+ /// <summary>
+ /// Gets the selected folder.
+ /// </summary>
public string SelectedFolder { get; private set; }
private ResourcePickerMode _mode = ResourcePickerMode.OpenResource;
Modified: trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Preview/PreviewPane.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Preview/PreviewPane.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Preview/PreviewPane.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -45,7 +45,6 @@
private QueryMode _mode;
private ClassDefinition _cls;
private IFeatureService _featSvc;
- private FdoProviderCapabilities _caps;
private string _fsId;
public PreviewPane(string fsId, QueryMode mode, ClassDefinition cls, IFeatureService featSvc, FdoProviderCapabilities caps)
Modified: trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/OdbcDriverMap.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/OdbcDriverMap.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/FeatureSource/Providers/Odbc/OdbcDriverMap.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -86,9 +86,33 @@
// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dncscol/html/csharp07192001.asp
//
+ /// <summary>
+ /// Initializes a new instance of the <see cref="OdbcDriverNotFoundException"/> class.
+ /// </summary>
public OdbcDriverNotFoundException() { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="OdbcDriverNotFoundException"/> class.
+ /// </summary>
+ /// <param name="message">The message.</param>
public OdbcDriverNotFoundException(string message) : base(message) { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="OdbcDriverNotFoundException"/> class.
+ /// </summary>
+ /// <param name="message">The message.</param>
+ /// <param name="inner">The inner.</param>
public OdbcDriverNotFoundException(string message, Exception inner) : base(message, inner) { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="OdbcDriverNotFoundException"/> class.
+ /// </summary>
+ /// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ /// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ /// <exception cref="T:System.ArgumentNullException">
+ /// The <paramref name="info"/> parameter is null.
+ /// </exception>
+ ///
+ /// <exception cref="T:System.Runtime.Serialization.SerializationException">
+ /// The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
+ /// </exception>
protected OdbcDriverNotFoundException(
System.Runtime.Serialization.SerializationInfo info,
System.Runtime.Serialization.StreamingContext context)
Modified: trunk/Tools/Maestro/Maestro.Editors/FeatureSource/SpatialContextsDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/FeatureSource/SpatialContextsDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/FeatureSource/SpatialContextsDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -40,6 +40,10 @@
InitializeComponent();
}
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SpatialContextsDialog"/> class.
+ /// </summary>
+ /// <param name="fs">The fs.</param>
public SpatialContextsDialog(IFeatureSource fs)
: this()
{
@@ -48,6 +52,11 @@
lblCount.Text = string.Format(Properties.Resources.SpatialContextsFound, grdSpatialContexts.Rows.Count);
}
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SpatialContextsDialog"/> class.
+ /// </summary>
+ /// <param name="fsId">The fs id.</param>
+ /// <param name="featSvc">The feat SVC.</param>
public SpatialContextsDialog(string fsId, IFeatureService featSvc)
: this()
{
Modified: trunk/Tools/Maestro/Maestro.Editors/Fusion/FlexibleLayoutEditor.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Fusion/FlexibleLayoutEditor.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Fusion/FlexibleLayoutEditor.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -33,6 +33,9 @@
/// </summary>
public partial class FlexibleLayoutEditor : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="FlexibleLayoutEditor"/> class.
+ /// </summary>
public FlexibleLayoutEditor()
{
InitializeComponent();
@@ -40,6 +43,12 @@
private IApplicationDefinition _flexLayout;
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
_flexLayout = (IApplicationDefinition)service.GetEditedResource();
Modified: trunk/Tools/Maestro/Maestro.Editors/Fusion/FusionWidgetEditorMap.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Fusion/FusionWidgetEditorMap.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Fusion/FusionWidgetEditorMap.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -87,6 +87,13 @@
//_edTypes[KnownWidgetNames.ZoomToSelection]
}
+ /// <summary>
+ /// Gets the editor for widget.
+ /// </summary>
+ /// <param name="widget">The widget.</param>
+ /// <param name="context">The context.</param>
+ /// <param name="edsvc">The edsvc.</param>
+ /// <returns></returns>
public static IWidgetEditor GetEditorForWidget(IWidget widget, FlexibleLayoutEditorContext context, IEditorService edsvc)
{
Check.NotNull(widget, "widget");
Modified: trunk/Tools/Maestro/Maestro.Editors/Fusion/WidgetEditorFactory.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Fusion/WidgetEditorFactory.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Fusion/WidgetEditorFactory.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -38,6 +38,11 @@
_editorTypes = new Dictionary<string, Type>();
}
+ /// <summary>
+ /// Registers the editor.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="type">The type.</param>
public static void RegisterEditor(string name, Type type)
{
if (!typeof(IWidgetEditor).IsAssignableFrom(type))
@@ -46,6 +51,11 @@
_editorTypes[name] = type;
}
+ /// <summary>
+ /// Gets the editor for widget.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <returns></returns>
public static IWidgetEditor GetEditorForWidget(string name)
{
if (_editorTypes.ContainsKey(name))
Modified: trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Generic/XmlEditorCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -152,6 +152,11 @@
FindAndReplace(txtFind.Text, txtReplace.Text);
}
+ /// <summary>
+ /// Finds and replaces the specified search string with the specified replacement string
+ /// </summary>
+ /// <param name="szFind">The search string.</param>
+ /// <param name="szReplace">The replacement string.</param>
public void FindAndReplace(string szFind, string szReplace)
{
var textEditor = txtXmlContent;
@@ -270,7 +275,10 @@
/// Performs validation of the XML content
/// </summary>
/// <param name="silentSuccess">If true will not show a success dialog on successful validation</param>
- /// <returns>true if validation was successful, false otherwise</returns>
+ /// <param name="errorsOnly">if set to <c>true</c> displays only errors in validation, otherwise it shows both errors and warnings.</param>
+ /// <returns>
+ /// true if validation was successful, false otherwise
+ /// </returns>
public bool PerformValidation(bool silentSuccess, bool errorsOnly)
{
if (this.Validator != null)
Modified: trunk/Tools/Maestro/Maestro.Editors/LastSelectedFolder.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/LastSelectedFolder.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/LastSelectedFolder.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -23,6 +23,9 @@
namespace Maestro.Editors
{
+ /// <summary>
+ /// Used to keep track of the last selected folder in file/directory pickers
+ /// </summary>
public static class LastSelectedFolder
{
/// <summary>
Modified: trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/RasterLayerEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/RasterLayerEditorCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/RasterLayerEditorCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -44,6 +44,12 @@
private IRasterLayerDefinition _rldf;
private IEditorService _edsvc;
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
_edsvc = service;
Modified: trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/Scales/CompositeStyleListCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -28,9 +28,15 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
+ /// <summary>
+ /// A user control to manage composite styles
+ /// </summary>
[ToolboxItem(true)]
public partial class CompositeStyleListCtrl : UserControl
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CompositeStyleListCtrl"/> class.
+ /// </summary>
public CompositeStyleListCtrl()
{
InitializeComponent();
@@ -42,6 +48,11 @@
private IVectorScaleRange2 _parent;
private BindingList<ICompositeTypeStyle> _styles;
+ /// <summary>
+ /// Loads the specified parent.
+ /// </summary>
+ /// <param name="parent">The parent.</param>
+ /// <param name="styles">The styles.</param>
public void Load(IVectorScaleRange2 parent, BindingList<ICompositeTypeStyle> styles)
{
_parent = parent;
Modified: trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ColorExpressionField.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ColorExpressionField.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ColorExpressionField.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -29,14 +29,26 @@
namespace Maestro.Editors.LayerDefinition.Vector.StyleEditors
{
+ /// <summary>
+ /// A field for entering color values by color picker selection or FDO expressions
+ /// </summary>
[ToolboxItem(true)]
public partial class ColorExpressionField : UserControl
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ColorExpressionField"/> class.
+ /// </summary>
public ColorExpressionField()
{
InitializeComponent();
}
+ /// <summary>
+ /// Gets or sets the color expression.
+ /// </summary>
+ /// <value>
+ /// The color expression.
+ /// </value>
[DefaultValue("00000000")]
public string ColorExpression
{
@@ -47,8 +59,14 @@
}
}
+ /// <summary>
+ /// Occurs when [current color changed].
+ /// </summary>
public event EventHandler CurrentColorChanged;
+ /// <summary>
+ /// Occurs when [request expression editor].
+ /// </summary>
public event EventHandler RequestExpressionEditor;
private void btnExpr_Click(object sender, EventArgs e)
Modified: trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/MapDefinition/ExtentCalculationDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -32,10 +32,17 @@
namespace Maestro.Editors.MapDefinition
{
+ /// <summary>
+ /// Displays the progress and result of Map Definition extent calculation
+ /// </summary>
public partial class ExtentCalculationDialog : Form
{
private IMapDefinition _mdf;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ExtentCalculationDialog"/> class.
+ /// </summary>
+ /// <param name="mdf">The MDF.</param>
public ExtentCalculationDialog(IMapDefinition mdf)
{
InitializeComponent();
@@ -62,6 +69,10 @@
return count;
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.Form.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
bgCalculation.RunWorkerAsync(_mdf);
@@ -93,6 +104,9 @@
private BindingList<CalculationResult> _results = new BindingList<CalculationResult>();
+ /// <summary>
+ /// Gets the extents.
+ /// </summary>
public IEnvelope Extents
{
get
Modified: trunk/Tools/Maestro/Maestro.Editors/Packaging/AddResourceEntryDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Packaging/AddResourceEntryDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Packaging/AddResourceEntryDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -29,8 +29,14 @@
namespace Maestro.Editors.Packaging
{
+ /// <summary>
+ /// A dialog for entering information for a new package resource entry
+ /// </summary>
public partial class AddResourceEntryDialog : Form
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="AddResourceEntryDialog"/> class.
+ /// </summary>
public AddResourceEntryDialog()
{
InitializeComponent();
@@ -89,8 +95,20 @@
this.Close();
}
+ /// <summary>
+ /// Gets the content filepath.
+ /// </summary>
public string ContentFilepath { get { return ContentPath.Text; } }
+ /// <summary>
+ /// Gets the header filepath.
+ /// </summary>
public string HeaderFilepath { get { return UseHeader.Checked ? HeaderPath.Text : null; } }
+ /// <summary>
+ /// Gets the name of the resource.
+ /// </summary>
+ /// <value>
+ /// The name of the resource.
+ /// </value>
public string ResourceName { get { return UseAlternateName.Checked ? AlternateName.Text : System.IO.Path.GetFileName(ContentPath.Text); } }
private void UseAlternateName_CheckedChanged(object sender, EventArgs e)
Modified: trunk/Tools/Maestro/Maestro.Editors/Packaging/EditResourceDataEntryDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Packaging/EditResourceDataEntryDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Packaging/EditResourceDataEntryDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -27,6 +27,9 @@
namespace Maestro.Editors.Packaging
{
+ /// <summary>
+ /// A dialog to allow editing of a resource data entry
+ /// </summary>
public partial class EditResourceDataEntryDialog : Form
{
private string m_resourceName;
@@ -34,30 +37,57 @@
private string m_filename;
private string m_datatype;
+ /// <summary>
+ /// Gets or sets the name of the resource.
+ /// </summary>
+ /// <value>
+ /// The name of the resource.
+ /// </value>
public string ResourceName
{
get { return m_resourceName; }
set { m_resourceName = value; }
}
+ /// <summary>
+ /// Gets or sets the type of the content.
+ /// </summary>
+ /// <value>
+ /// The type of the content.
+ /// </value>
public string ContentType
{
get { return m_contentType; }
set { m_contentType = value; }
}
+ /// <summary>
+ /// Gets or sets the filename.
+ /// </summary>
+ /// <value>
+ /// The filename.
+ /// </value>
public string Filename
{
get { return m_filename; }
set { m_filename = value; }
}
+ /// <summary>
+ /// Gets or sets the type of the data.
+ /// </summary>
+ /// <value>
+ /// The type of the data.
+ /// </value>
public string DataType
{
get { return m_datatype; }
set { m_datatype = value; }
}
+ /// <summary>
+ /// Initializes a new instance of the <see cref="EditResourceDataEntryDialog"/> class.
+ /// </summary>
public EditResourceDataEntryDialog()
{
InitializeComponent();
@@ -88,8 +118,5 @@
this.DialogResult = DialogResult.OK;
this.Close();
}
-
-
-
}
}
\ No newline at end of file
Modified: trunk/Tools/Maestro/Maestro.Editors/Packaging/PackageEditorDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/Packaging/PackageEditorDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/Packaging/PackageEditorDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -32,12 +32,20 @@
namespace Maestro.Editors.Packaging
{
+ /// <summary>
+ /// A dialog for editing the contents of a MapGuide Package
+ /// </summary>
public partial class PackageEditorDialog : Form
{
private string m_filename;
private Dictionary<string, ResourceItem> m_resources;
private IServerConnection _conn;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="PackageEditorDialog"/> class.
+ /// </summary>
+ /// <param name="filename">The filename.</param>
+ /// <param name="conn">The conn.</param>
public PackageEditorDialog(string filename, IServerConnection conn)
: this()
{
Modified: trunk/Tools/Maestro/Maestro.Editors/RepositoryHandle.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/RepositoryHandle.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/RepositoryHandle.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -25,12 +25,26 @@
namespace Maestro.Editors
{
+ /// <summary>
+ /// Represents a resource id in teh context of a connection
+ /// </summary>
public class RepositoryHandle
{
+ /// <summary>
+ /// Gets the resource id.
+ /// </summary>
public ResourceIdentifier ResourceId { get; private set; }
+ /// <summary>
+ /// Gets the connection.
+ /// </summary>
public IServerConnection Connection { get; private set; }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RepositoryHandle"/> class.
+ /// </summary>
+ /// <param name="resId">The res id.</param>
+ /// <param name="conn">The conn.</param>
public RepositoryHandle(ResourceIdentifier resId, IServerConnection conn)
{
this.ResourceId = resId;
Modified: trunk/Tools/Maestro/Maestro.Editors/RepositoryIcons.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/RepositoryIcons.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/RepositoryIcons.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -30,22 +30,69 @@
/// </summary>
public class RepositoryIcons
{
+ /// <summary>
+ /// Icon for resource types
+ /// </summary>
public const int RES_UNKNOWN = 0;
+ /// <summary>
+ /// Icon for feature sources
+ /// </summary>
public const int RES_FEATURESOURCE = 1;
+ /// <summary>
+ /// Icon for layer definitions
+ /// </summary>
public const int RES_LAYERDEFINITION = 2;
+ /// <summary>
+ /// Icon for map definitions
+ /// </summary>
public const int RES_MAPDEFINITION = 3;
+ /// <summary>
+ /// Icon for web layouts
+ /// </summary>
public const int RES_WEBLAYOUT = 4;
+ /// <summary>
+ /// Icon for symbol libraries
+ /// </summary>
public const int RES_SYMBOLLIBRARY = 5;
+ /// <summary>
+ /// Icon for print layouts
+ /// </summary>
public const int RES_PRINTLAYOUT = 6;
+ /// <summary>
+ /// Icon for drawing sources
+ /// </summary>
public const int RES_DRAWINGSOURCE = 7;
+ /// <summary>
+ /// Icon for application definitions
+ /// </summary>
public const int RES_APPLICATIONDEFINITION = 8;
+ /// <summary>
+ /// Icon for symbol definitions
+ /// </summary>
public const int RES_SYMBOLDEFINITION = 9;
+ /// <summary>
+ /// Icon for watermark definitions
+ /// </summary>
public const int RES_WATERMARK = 10;
+ /// <summary>
+ /// Icon for load procedures
+ /// </summary>
public const int RES_LOADPROCEDURE = 11;
+ /// <summary>
+ /// Icon for the root of the repository
+ /// </summary>
public const int RES_ROOT = 12;
+ /// <summary>
+ /// Icon for folders
+ /// </summary>
public const int RES_FOLDER = 13;
+ /// <summary>
+ /// Gets the image icon index for the given resource type
+ /// </summary>
+ /// <param name="resType">Type of the resource.</param>
+ /// <returns></returns>
public static int GetImageIndexForResourceType(ResourceTypes resType)
{
switch (resType)
@@ -79,6 +126,10 @@
}
}
+ /// <summary>
+ /// Creates the image list.
+ /// </summary>
+ /// <returns></returns>
public static ImageList CreateImageList()
{
var imgList = new ImageList();
@@ -88,6 +139,10 @@
return imgList;
}
+ /// <summary>
+ /// Populates the image list.
+ /// </summary>
+ /// <param name="imgList">The img list.</param>
public static void PopulateImageList(ImageList imgList)
{
imgList.Images.Add(Properties.Resources.document);
Modified: trunk/Tools/Maestro/Maestro.Editors/ResourceEditorServiceBase.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/ResourceEditorServiceBase.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/ResourceEditorServiceBase.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -31,11 +31,25 @@
namespace Maestro.Editors
{
+ /// <summary>
+ /// A base class for providing editor services
+ /// </summary>
public abstract class ResourceEditorServiceBase : IEditorService
{
+ /// <summary>
+ /// The server connection
+ /// </summary>
protected IServerConnection _conn;
+ /// <summary>
+ /// The resource being edited
+ /// </summary>
protected IResource _editCopy;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceEditorServiceBase"/> class.
+ /// </summary>
+ /// <param name="resourceID">The resource ID.</param>
+ /// <param name="conn">The conn.</param>
protected ResourceEditorServiceBase(string resourceID, IServerConnection conn)
{
this.IsNew = ResourceIdentifier.IsSessionBased(resourceID);
@@ -43,8 +57,19 @@
_conn = conn;
}
+ /// <summary>
+ /// Raised when the edited resource has changed
+ /// </summary>
public event EventHandler DirtyStateChanged;
+ /// <summary>
+ /// Edits the expression.
+ /// </summary>
+ /// <param name="currentExpr">The current expr.</param>
+ /// <param name="classDef">The class def.</param>
+ /// <param name="providerName">Name of the provider.</param>
+ /// <param name="featureSourceId">The feature source id.</param>
+ /// <returns></returns>
public string EditExpression(string currentExpr, ClassDefinition classDef, string providerName, string featureSourceId)
{
var ed = new ExpressionEditor();
@@ -58,6 +83,14 @@
return null;
}
+ /// <summary>
+ /// Initiates the editing process. The resource to be edited is copied to the session repository and
+ /// a deserialized version is returned from this copy. Subsequent calls will return the same reference
+ /// to this resource object.
+ /// </summary>
+ /// <returns>
+ /// A deserialized version of a session-copy of the resource to be edited
+ /// </returns>
public IResource GetEditedResource()
{
if (_editCopy == null)
@@ -72,11 +105,19 @@
return _editCopy;
}
+ /// <summary>
+ /// Called when [resource property changed].
+ /// </summary>
+ /// <param name="sender">The sender.</param>
+ /// <param name="e">The <see cref="System.ComponentModel.PropertyChangedEventArgs"/> instance containing the event data.</param>
protected void OnResourcePropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
{
MarkDirty();
}
+ /// <summary>
+ /// Called when [dirty state changed].
+ /// </summary>
protected void OnDirtyStateChanged()
{
var handler = this.DirtyStateChanged;
@@ -84,28 +125,48 @@
handler(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Indicates whether the edited resource has unsaved changes
+ /// </summary>
public bool IsDirty
{
get;
private set;
}
+ /// <summary>
+ /// Forces the edited resource to be marked as dirty
+ /// </summary>
public void MarkDirty()
{
this.IsDirty = true;
OnDirtyStateChanged();
}
+ /// <summary>
+ /// Indicates whether the edited resource is a new resource
+ /// </summary>
public bool IsNew
{
get;
private set;
}
+ /// <summary>
+ /// Opens the specified URL
+ /// </summary>
+ /// <param name="url"></param>
public abstract void OpenUrl(string url);
+ /// <summary>
+ /// Gets the resource ID of the resource, whose session-copy is being edited
+ /// </summary>
public string ResourceID { get; private set; }
+ /// <summary>
+ /// Invokes a prompt to select a resource of any type
+ /// </summary>
+ /// <returns></returns>
public string SelectAnyResource()
{
var picker = new ResourcePicker(_conn.ResourceService, ResourcePickerMode.OpenResource);
@@ -116,6 +177,11 @@
return string.Empty;
}
+ /// <summary>
+ /// Invokes a prompt to select a resource of the specified type
+ /// </summary>
+ /// <param name="resType"></param>
+ /// <returns></returns>
public string SelectResource(OSGeo.MapGuide.MaestroAPI.ResourceTypes resType)
{
var picker = new ResourcePicker(_conn.ResourceService, resType, ResourcePickerMode.OpenResource);
@@ -126,6 +192,10 @@
return string.Empty;
}
+ /// <summary>
+ /// Invokes a prompt to select a folder
+ /// </summary>
+ /// <returns></returns>
public string SelectFolder()
{
var picker = new ResourcePicker(_conn.ResourceService, ResourcePickerMode.OpenFolder);
@@ -136,8 +206,18 @@
return string.Empty;
}
+ /// <summary>
+ /// Invokes a prompt to select a file from an unmanaged alias
+ /// </summary>
+ /// <param name="startPath"></param>
+ /// <param name="fileTypes"></param>
+ /// <returns></returns>
public abstract string SelectUnmanagedData(string startPath, System.Collections.Specialized.NameValueCollection fileTypes);
+ /// <summary>
+ /// Saves the edited resource. The session copy, which holds the current changes is copied back
+ /// to the original resource ID.
+ /// </summary>
public void Save()
{
if (!OnBeforeSave())
@@ -150,6 +230,11 @@
}
}
+ /// <summary>
+ /// Saves the edited resource under a different resource ID. The session copy, which holds the current changes is copied back
+ /// to the specified resource ID
+ /// </summary>
+ /// <param name="resourceID"></param>
public void SaveAs(string resourceID)
{
if (ResourceIdentifier.IsSessionBased(resourceID))
@@ -168,6 +253,9 @@
}
}
+ /// <summary>
+ /// Indicates whether an upgrade for this resource is available
+ /// </summary>
public bool IsUpgradeAvailable
{
get
@@ -178,11 +266,18 @@
}
}
+ /// <summary>
+ /// Gets the resource ID of the actively edited resource
+ /// </summary>
public string EditedResourceID
{
get { return _editCopy.ResourceID; }
}
+ /// <summary>
+ /// Registers a custom notifier
+ /// </summary>
+ /// <param name="irc"></param>
public void RegisterCustomNotifier(INotifyResourceChanged irc)
{
irc.ResourceChanged += (sender, e) =>
@@ -192,6 +287,10 @@
};
}
+ /// <summary>
+ /// Updates the session copy's resource content
+ /// </summary>
+ /// <param name="xml"></param>
public void UpdateResourceContent(string xml)
{
using (var ms = new MemoryStream(Encoding.UTF8.GetBytes(xml)))
@@ -200,6 +299,10 @@
}
}
+ /// <summary>
+ /// Called when [before save].
+ /// </summary>
+ /// <returns></returns>
private bool OnBeforeSave()
{
var e = new CancelEventArgs();
@@ -210,18 +313,31 @@
return e.Cancel;
}
+ /// <summary>
+ /// Raised before a save operation commences
+ /// </summary>
public event System.ComponentModel.CancelEventHandler BeforeSave;
+ /// <summary>
+ /// Gets the associated feature service
+ /// </summary>
public IFeatureService FeatureService
{
get { return _conn.FeatureService; }
}
+ /// <summary>
+ /// Gets the associated resource service
+ /// </summary>
public IResourceService ResourceService
{
get { return _conn.ResourceService; }
}
+ /// <summary>
+ /// Invokes a prompt to select the coordinate system
+ /// </summary>
+ /// <returns></returns>
public string GetCoordinateSystem()
{
var dlg = new CoordinateSystemPicker(_conn.CoordinateSystemCatalog);
@@ -233,36 +349,67 @@
}
+ /// <summary>
+ /// Gets the associated drawing service
+ /// </summary>
public IDrawingService DrawingService
{
get { return (IDrawingService)_conn.GetService((int)ServiceType.Drawing); }
}
+ /// <summary>
+ /// Forces the the <see cref="DirtyStateChanged"/> event. Normally the databinding
+ /// system should auto-flag dirty state, only call this if you don't utilise this
+ /// databinding system.
+ /// </summary>
public void HasChanged()
{
this.IsDirty = true;
OnDirtyStateChanged();
}
+ /// <summary>
+ /// Gets the session id
+ /// </summary>
public string SessionID
{
get { return _conn.SessionID; }
}
+ /// <summary>
+ /// Indicates if a specified custom command is supported and can be created
+ /// </summary>
+ /// <param name="cmdType"></param>
+ /// <returns></returns>
public bool SupportsCommand(OSGeo.MapGuide.MaestroAPI.Commands.CommandType cmdType)
{
return Array.IndexOf(_conn.Capabilities.SupportedCommands, (int)cmdType) >= 0;
}
+ /// <summary>
+ /// Create a custom command
+ /// </summary>
+ /// <param name="cmdType"></param>
+ /// <returns></returns>
public OSGeo.MapGuide.MaestroAPI.Commands.ICommand CreateCommand(OSGeo.MapGuide.MaestroAPI.Commands.CommandType cmdType)
{
return _conn.CreateCommand((int)cmdType);
}
+ /// <summary>
+ /// Raises a request to refresh the Site Explorer
+ /// </summary>
public abstract void RequestRefresh();
+ /// <summary>
+ /// Raises a request to refresh the Site Explorer at the specified folder id
+ /// </summary>
+ /// <param name="folderId"></param>
public abstract void RequestRefresh(string folderId);
+ /// <summary>
+ /// Called when [saved].
+ /// </summary>
protected void OnSaved()
{
var handler = this.Saved;
@@ -270,36 +417,66 @@
handler(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Raised when the edited resource is saved
+ /// </summary>
public event EventHandler Saved;
+ /// <summary>
+ /// Synchronises changes in the in-memory resource back to the session repository. This is usually called
+ /// before validation of the edited resource begins.
+ /// </summary>
public void SyncSessionCopy()
{
this.ResourceService.SetResourceXmlData(_editCopy.ResourceID, _editCopy.SerializeToStream());
}
+ /// <summary>
+ /// Gets the MapGuide Server version
+ /// </summary>
public Version SiteVersion
{
get { return _conn.SiteVersion; }
}
+ /// <summary>
+ /// Opens the specified resource
+ /// </summary>
+ /// <param name="resourceId"></param>
public abstract void OpenResource(string resourceId);
+ /// <summary>
+ /// Gets the suggested save folder for a "save as" operation
+ /// </summary>
public string SuggestedSaveFolder
{
get;
set;
}
+ /// <summary>
+ /// Gets the value of a custom connection property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public object GetCustomProperty(string name)
{
return _conn.GetCustomProperty(name);
}
+ /// <summary>
+ /// Gets the service of the specified type
+ /// </summary>
+ /// <param name="serviceType"></param>
+ /// <returns></returns>
public IService GetService(int serviceType)
{
return _conn.GetService(serviceType);
}
+ /// <summary>
+ /// Gets the supported services
+ /// </summary>
public int[] SupportedServiceTypes
{
get { return _conn.Capabilities.SupportedServices; }
Modified: trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/CompoundSymbolDefinitionEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/CompoundSymbolDefinitionEditorCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/CompoundSymbolDefinitionEditorCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -41,6 +41,9 @@
const int IDX_SYMBOL = 0;
const int IDX_REFERENCE = 1;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CompoundSymbolDefinitionEditorCtrl"/> class.
+ /// </summary>
public CompoundSymbolDefinitionEditorCtrl()
{
InitializeComponent();
@@ -49,6 +52,12 @@
private IEditorService _edSvc;
private ICompoundSymbolDefinition _compSym;
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
service.RegisterCustomNotifier(this);
Modified: trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SimpleSymbolDefinitionEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SimpleSymbolDefinitionEditorCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SimpleSymbolDefinitionEditorCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -33,11 +33,20 @@
[ToolboxItem(true)]
public partial class SimpleSymbolDefinitionEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SimpleSymbolDefinitionEditorCtrl"/> class.
+ /// </summary>
public SimpleSymbolDefinitionEditorCtrl()
{
InitializeComponent();
}
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
service.RegisterCustomNotifier(this);
Modified: trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SymbolField.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SymbolField.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/SymbolField.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -90,10 +90,20 @@
}
}
+ /// <summary>
+ /// A method for presenting symbol parameters for a given symbol field
+ /// </summary>
+ /// <param name="sender">The sender.</param>
public delegate void BrowseEventHandler(SymbolField sender);
+ /// <summary>
+ /// Occurs when a request has been made to present symbol parameters for selection
+ /// </summary>
public event BrowseEventHandler RequestBrowse;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SymbolField"/> class.
+ /// </summary>
public SymbolField()
{
InitializeComponent();
@@ -105,9 +115,18 @@
OnContentChanged();
}
+ /// <summary>
+ /// Occurs when [content changed].
+ /// </summary>
public event EventHandler ContentChanged;
//Important: We need to set this otherwise the Winforms Designer will put you in a world of pain
+ /// <summary>
+ /// Gets or sets the content.
+ /// </summary>
+ /// <value>
+ /// The content.
+ /// </value>
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public string Content
{
@@ -155,6 +174,12 @@
private string[] _items;
//Important: We need to set this otherwise the Winforms Designer will put you in a world of pain
+ /// <summary>
+ /// Gets or sets the items.
+ /// </summary>
+ /// <value>
+ /// The items.
+ /// </value>
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public string[] Items
{
@@ -184,9 +209,20 @@
//Important: We need to set this otherwise the Winforms Designer will put you in a world of pain
//[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
+ /// <summary>
+ /// Gets or sets the supported enhanced data types.
+ /// </summary>
+ /// <value>
+ /// The supported enhanced data types.
+ /// </value>
[Description("Indicates the parameter data type(s) that are suitable for this field. Leave empty for all types")]
public DataType2[] SupportedEnhancedDataTypes { get; set; }
+ /// <summary>
+ /// Gets the items.
+ /// </summary>
+ /// <typeparam name="T"></typeparam>
+ /// <returns></returns>
public static string[] GetItems<T>()
{
var values = Enum.GetValues(typeof(T));
@@ -209,6 +245,11 @@
private Type _boundObjectType;
private PropertyInfo _boundProperty;
+ /// <summary>
+ /// Binds the specified data source.
+ /// </summary>
+ /// <param name="dataSource">The data source.</param>
+ /// <param name="propertyName">Name of the property.</param>
public void Bind(object dataSource, string propertyName)
{
Check.NotNull(dataSource, "dataSource");
Modified: trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/UsageContextsCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/UsageContextsCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/SymbolDefinition/UsageContextsCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -29,9 +29,15 @@
namespace Maestro.Editors.SymbolDefinition
{
+ /// <summary>
+ /// Displays usage contexts options for a Symbol Definition
+ /// </summary>
[ToolboxItem(false)]
internal partial class UsageContextsCtrl : EditorBindableCollapsiblePanel
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="UsageContextsCtrl"/> class.
+ /// </summary>
public UsageContextsCtrl()
{
InitializeComponent();
@@ -46,6 +52,12 @@
private bool _init = false;
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
service.RegisterCustomNotifier(this);
Modified: trunk/Tools/Maestro/Maestro.Editors/WatermarkDefinition/WatermarkEditorCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Editors/WatermarkDefinition/WatermarkEditorCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Editors/WatermarkDefinition/WatermarkEditorCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -45,6 +45,12 @@
private IWatermarkDefinition _wm;
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
_wm = (IWatermarkDefinition)service.GetEditedResource();
Modified: trunk/Tools/Maestro/Maestro.Login/LocalLoginCtrl.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Login/LocalLoginCtrl.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Login/LocalLoginCtrl.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -29,8 +29,14 @@
namespace Maestro.Login
{
+ /// <summary>
+ /// A user control for entering connection information for a local connection
+ /// </summary>
public partial class LocalLoginCtrl : UserControl, ILoginCtrl
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="LocalLoginCtrl"/> class.
+ /// </summary>
public LocalLoginCtrl()
{
InitializeComponent();
@@ -51,21 +57,39 @@
}
}
+ /// <summary>
+ /// Gets the platform config path.
+ /// </summary>
public string PlatformConfigPath
{
get { return txtPlatformConfig.Text; }
}
+ /// <summary>
+ /// Gets the username.
+ /// </summary>
+ /// <value>
+ /// The username.
+ /// </value>
public string Username
{
get { return string.Empty; }
}
+ /// <summary>
+ /// Gets the password.
+ /// </summary>
+ /// <value>
+ /// The password.
+ /// </value>
public string Password
{
get { return string.Empty; }
}
+ /// <summary>
+ /// Updates the login status.
+ /// </summary>
public void UpdateLoginStatus()
{
if (this.PlatformConfigPath.Trim().Length > 0 && File.Exists(this.PlatformConfigPath))
@@ -74,10 +98,19 @@
DisabledOk(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Occurs when [enable ok].
+ /// </summary>
public event EventHandler EnableOk;
+ /// <summary>
+ /// Occurs when [disabled ok].
+ /// </summary>
public event EventHandler DisabledOk;
+ /// <summary>
+ /// Occurs when [check saved password].
+ /// </summary>
public event EventHandler CheckSavedPassword;
}
}
Modified: trunk/Tools/Maestro/Maestro.Packaging/PackageBuilder.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Packaging/PackageBuilder.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Packaging/PackageBuilder.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -1127,17 +1127,45 @@
}
}
+ /// <summary>
+ /// Base calss of all package operations
+ /// </summary>
public abstract class PackageOperation
{
+ /// <summary>
+ /// Gets or sets the resource id.
+ /// </summary>
+ /// <value>
+ /// The resource id.
+ /// </value>
public string ResourceId { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the operation.
+ /// </summary>
+ /// <value>
+ /// The name of the operation.
+ /// </value>
public string OperationName { get; set; }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="PackageOperation"/> class.
+ /// </summary>
+ /// <param name="resId">The res id.</param>
protected PackageOperation(string resId) { this.ResourceId = resId; }
}
+ /// <summary>
+ /// A SETRESOURCE package operation
+ /// </summary>
public class SetResourcePackageOperation : PackageOperation
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SetResourcePackageOperation"/> class.
+ /// </summary>
+ /// <param name="resId">The res id.</param>
+ /// <param name="content">The content.</param>
+ /// <param name="header">The header.</param>
public SetResourcePackageOperation(string resId, string content, string header)
: base(resId)
{
@@ -1146,8 +1174,20 @@
this.Header = header;
}
+ /// <summary>
+ /// Gets or sets the content.
+ /// </summary>
+ /// <value>
+ /// The content.
+ /// </value>
public string Content { get; set; }
+ /// <summary>
+ /// Gets or sets the header.
+ /// </summary>
+ /// <value>
+ /// The header.
+ /// </value>
public string Header { get; set; }
/// <summary>
@@ -1198,8 +1238,18 @@
}
}
+ /// <summary>
+ /// A SETRESOURCEDATA package operation
+ /// </summary>
public class SetResourceDataPackageOperation : PackageOperation
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SetResourceDataPackageOperation"/> class.
+ /// </summary>
+ /// <param name="resId">The res id.</param>
+ /// <param name="data">The data.</param>
+ /// <param name="dataName">Name of the data.</param>
+ /// <param name="dataType">Type of the data.</param>
public SetResourceDataPackageOperation(string resId, string data, string dataName, ResourceDataType dataType)
: base(resId)
{
@@ -1209,10 +1259,28 @@
this.DataType = dataType;
}
+ /// <summary>
+ /// Gets or sets the data.
+ /// </summary>
+ /// <value>
+ /// The data.
+ /// </value>
public string Data { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the data.
+ /// </summary>
+ /// <value>
+ /// The name of the data.
+ /// </value>
public string DataName { get; set; }
+ /// <summary>
+ /// Gets or sets the type of the data.
+ /// </summary>
+ /// <value>
+ /// The type of the data.
+ /// </value>
public ResourceDataType DataType { get; set; }
/// <summary>
Modified: trunk/Tools/Maestro/Maestro.Packaging/PackageUploadOptionDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Packaging/PackageUploadOptionDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Packaging/PackageUploadOptionDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -45,8 +45,14 @@
NonTransactional
}
+ /// <summary>
+ /// Dialog for showing package loading options
+ /// </summary>
public partial class PackageUploadOptionDialog : Form
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="PackageUploadOptionDialog"/> class.
+ /// </summary>
public PackageUploadOptionDialog()
{
InitializeComponent();
Modified: trunk/Tools/Maestro/Maestro.Packaging/PackageUploadResultDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Packaging/PackageUploadResultDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Packaging/PackageUploadResultDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -37,6 +37,10 @@
InitializeComponent();
}
+ /// <summary>
+ /// Initializes a new instance of the <see cref="PackageUploadResultDialog"/> class.
+ /// </summary>
+ /// <param name="result">The result.</param>
public PackageUploadResultDialog(UploadPackageResult result)
: this()
{
Modified: trunk/Tools/Maestro/Maestro.Packaging/UploadPackageResult.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Packaging/UploadPackageResult.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Packaging/UploadPackageResult.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -23,16 +23,35 @@
namespace Maestro.Packaging
{
+ /// <summary>
+ /// Represents the result of a non-transactional package loading operation
+ /// </summary>
public class UploadPackageResult
{
+ /// <summary>
+ /// Gets the successful operations
+ /// </summary>
public ICollection<PackageOperation> Successful { get; private set; }
+ /// <summary>
+ /// Gets the failed operations
+ /// </summary>
public Dictionary<PackageOperation, Exception> Failed { get; private set; }
+ /// <summary>
+ /// Gets the operations that were skipped
+ /// </summary>
public ICollection<PackageOperation> SkipOperations { get; private set; }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="UploadPackageResult"/> class.
+ /// </summary>
public UploadPackageResult() : this(new PackageOperation[0]) { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="UploadPackageResult"/> class.
+ /// </summary>
+ /// <param name="skip">The skip.</param>
public UploadPackageResult(IEnumerable<PackageOperation> skip)
{
this.Successful = new List<PackageOperation>();
Modified: trunk/Tools/Maestro/Maestro.Shared.UI/ErrorDialog.cs
===================================================================
--- trunk/Tools/Maestro/Maestro.Shared.UI/ErrorDialog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Maestro.Shared.UI/ErrorDialog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -34,6 +34,9 @@
/// </summary>
public partial class ErrorDialog : Form
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ErrorDialog"/> class.
+ /// </summary>
public ErrorDialog()
{
InitializeComponent();
@@ -59,6 +62,11 @@
}
}
+ /// <summary>
+ /// Shows the specified message.
+ /// </summary>
+ /// <param name="message">The message.</param>
+ /// <param name="detail">The detail.</param>
public static void Show(string message, string detail)
{
var diag = new ErrorDialog();
@@ -67,6 +75,10 @@
diag.ShowDialog();
}
+ /// <summary>
+ /// Shows the specified exception.
+ /// </summary>
+ /// <param name="ex">The exception.</param>
public static void Show(Exception ex)
{
Show(ex.Message, ex.ToString());
Modified: trunk/Tools/Maestro/MaestroAPITests/ResourceTests.cs
===================================================================
--- trunk/Tools/Maestro/MaestroAPITests/ResourceTests.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/MaestroAPITests/ResourceTests.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -607,6 +607,7 @@
var conn = _mocks.NewMock<IServerConnection>();
var conv = new ResourceObjectConverter();
var ldf = ObjectFactory.CreateDefaultLayer(conn, LayerType.Vector, new Version(1, 0, 0));
+ ldf.ResourceID = "Library://Samples/Sheboygan/Layers/Parcels.LayerDefinition";
ldf.SubLayer.ResourceId = "Library://Samples/Sheboygan/Data/Parcels.FeatureSource";
((IVectorLayerDefinition)ldf.SubLayer).FeatureName = "SHP_Schema:Parcels";
((IVectorLayerDefinition)ldf.SubLayer).Geometry = "Geometry";
@@ -697,6 +698,7 @@
var conv = new ResourceObjectConverter();
var mdf = ObjectFactory.CreateMapDefinition(conn, new Version(1, 0, 0), "Test Map");
+ mdf.ResourceID = "Library://Samples/Sheboygan/Maps/Sheboygan.MapDefinition";
Assert.AreEqual("1.0.0", mdf.GetResourceTypeDescriptor().Version);
Assert.AreEqual("MapDefinition-1.0.0.xsd", mdf.GetResourceTypeDescriptor().XsdName);
@@ -736,6 +738,7 @@
var conv = new ResourceObjectConverter();
var lproc = ObjectFactory.CreateLoadProcedure(conn, LoadType.Sdf);
+ lproc.ResourceID = "Library://Samples/Sheboygan/Load/Load.LoadProcedure";
Assert.AreEqual("1.0.0", lproc.GetResourceTypeDescriptor().Version);
Assert.AreEqual("LoadProcedure-1.0.0.xsd", lproc.GetResourceTypeDescriptor().XsdName);
@@ -790,6 +793,7 @@
var conv = new ResourceObjectConverter();
var wl = ObjectFactory.CreateWebLayout(conn, new Version(1, 0, 0), "Library://Test.MapDefinition");
+ wl.ResourceID = "Library://Test.WebLayout";
Assert.AreEqual("1.0.0", wl.GetResourceTypeDescriptor().Version);
Assert.AreEqual("WebLayout-1.0.0.xsd", wl.GetResourceTypeDescriptor().XsdName);
@@ -829,6 +833,7 @@
var conv = new ResourceObjectConverter();
var ssym = ObjectFactory.CreateSimpleSymbol(conn, new Version(1, 0, 0), "SimpleSymbolTest", "Test simple symbol");
+ ssym.ResourceID = "Library://Samples/Sheboygan/Symbols/Test.SymbolDefinition";
Assert.AreEqual("1.0.0", ssym.GetResourceTypeDescriptor().Version);
Assert.AreEqual("SymbolDefinition-1.0.0.xsd", ssym.GetResourceTypeDescriptor().XsdName);
@@ -860,6 +865,7 @@
}
var csym = ObjectFactory.CreateCompoundSymbol(conn, new Version(1, 0, 0), "CompoundSymbolTest", "Test compound symbol");
+ csym.ResourceID = "Library://Samples/Sheboygan/Symbols/Compound.SymbolDefinition";
Assert.AreEqual("1.0.0", csym.GetResourceTypeDescriptor().Version);
Assert.AreEqual("SymbolDefinition-1.0.0.xsd", csym.GetResourceTypeDescriptor().XsdName);
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/IGetFdoCacheInfo.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/IGetFdoCacheInfo.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Commands/IGetFdoCacheInfo.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -25,16 +25,30 @@
namespace OSGeo.MapGuide.MaestroAPI.Commands
{
+ /// <summary>
+ /// Defines the command for querying the cache status of FDO connections
+ /// </summary>
public interface IGetFdoCacheInfo : ICommand
{
+ /// <summary>
+ /// Executes this command and returns a <see cref="T:OSGeo.MapGuide.MaestroAPI.Commands.FdoCacheInfo"/> that
+ /// represents this cache status information
+ /// </summary>
+ /// <returns></returns>
FdoCacheInfo Execute();
}
+ /// <summary>
+ /// Represents the cache status of FDO connections currently managed by the MapGuide Server
+ /// </summary>
[XmlRoot(ElementName = "FdoCacheInformation")]
public class FdoCacheInfo
{
private static XmlSerializer smSerializer;
+ /// <summary>
+ /// Gets the serializer.
+ /// </summary>
public static XmlSerializer Serializer
{
get
@@ -46,105 +60,169 @@
}
}
+ /// <summary>
+ /// Gets the timestamp
+ /// </summary>
+ /// <value>
+ /// The time stamp.
+ /// </value>
[XmlElement]
public DateTime TimeStamp { get; set; }
-
+
+ /// <summary>
+ /// Gets the configuration settings
+ /// </summary>
+ /// <value>
+ /// The configuration.
+ /// </value>
[XmlElement(ElementName = "ConfigurationSettings")]
[DisplayName("Configuration Settings")]
public ConfigurationSettings Configuration { get; set; }
+ /// <summary>
+ /// Gets an array of cache status of connections for each provider
+ /// </summary>
[XmlElement(ElementName = "Provider")]
[DisplayName("Cached FDO Providers")]
public CachedProviderInfo[] Providers { get; set; }
}
+ /// <summary>
+ /// Represents information about a cached FDO connection
+ /// </summary>
[Serializable]
public class CachedFdoConnection
{
-
+
+ /// <summary>
+ /// Gets the feature source
+ /// </summary>
[XmlElement]
[DisplayName("Feature Source")]
public string Name { get; set; }
-
+ /// <summary>
+ /// Gets the state of this connection
+ /// </summary>
[XmlElement]
public string ConnectionState { get; set; }
-
+ /// <summary>
+ /// Gets whether this connection is currently in use
+ /// </summary>
[XmlElement]
public string InUse { get; set; }
-
+ /// <summary>
+ /// Gets the number of objects currently using this connection
+ /// </summary>
[XmlElement]
public int UseCount { get; set; }
-
+ /// <summary>
+ /// Gets the long transaction
+ /// </summary>
[XmlElement]
public string LongTransaction { get; set; }
-
+ /// <summary>
+ /// Gets the date this connection was last used
+ /// </summary>
[XmlElement]
public DateTime LastUsed { get; set; }
-
+ /// <summary>
+ /// Gets whether this connection is valid
+ /// </summary>
[XmlElement]
public string Valid { get; set; }
}
+ /// <summary>
+ /// Represents the cache status of connections for a particular provider
+ /// </summary>
[Serializable]
public class CachedProviderInfo
{
-
+ /// <summary>
+ /// Gets the feature source
+ /// </summary>
[XmlElement(ElementName = "Name")]
public string FeatureSourceId { get; set; }
-
+ /// <summary>
+ /// Gets the maximum connection pool size
+ /// </summary>
[XmlElement]
public int MaximumDataConnectionPoolSize { get; set; }
-
+ /// <summary>
+ /// Gets the current connection pool size
+ /// </summary>
[XmlElement]
public int CurrentDataConnectionPoolSize { get; set; }
-
+ /// <summary>
+ /// Gets the number of current connections
+ /// </summary>
[XmlElement]
public int CurrentDataConnections { get; set; }
-
+ /// <summary>
+ /// Gets the thread model
+ /// </summary>
[XmlElement]
public string ThreadModel { get; set; }
-
+ /// <summary>
+ /// Gets whether connections are cached
+ /// </summary>
[XmlElement]
public string KeepDataConnectionsCached { get; set; }
+ /// <summary>
+ /// Gets an array of cached connections using this provider
+ /// </summary>
[XmlElement(ElementName = "CachedFdoConnection")]
[DisplayName("Cached Feature Sources")]
public CachedFdoConnection[] CachedFdoConnections { get; set; }
}
+ /// <summary>
+ /// Represents the FDO cache configuration
+ /// </summary>
[Serializable]
public class ConfigurationSettings
{
-
+ /// <summary>
+ /// Gets whether connection pooling is enabled
+ /// </summary>
[XmlElement]
public string DataConnectionPoolEnabled { get; set; }
-
+ /// <summary>
+ /// Gets the FDO providers which are excluded from connection pooling
+ /// </summary>
[XmlElement]
public string DataConnectionPoolExcludedProviders { get; set; }
-
+ /// <summary>
+ /// Gets the size of the connection pool
+ /// </summary>
[XmlElement]
public int DataConnectionPoolSize { get; set; }
-
+ /// <summary>
+ /// Gets a delimited list of custom connection pool sizes by provider
+ /// </summary>
[XmlElement]
public string DataConnectionPoolSizeCustom { get; set; }
-
+ /// <summary>
+ /// Gets the connection timeout
+ /// </summary>
[XmlElement]
public int DataConnectionTimeout { get; set; }
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ConnectionProviderRegistry.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -50,6 +50,12 @@
/// </value>
public bool IsMultiPlatform { get; private set; }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ConnectionProviderEntry"/> class.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="desc">The desc.</param>
+ /// <param name="multiPlatform">if set to <c>true</c> [multi platform].</param>
public ConnectionProviderEntry(string name, string desc, bool multiPlatform)
{
this.Name = name;
@@ -58,6 +64,11 @@
}
}
+ /// <summary>
+ /// A method that creates <see cref="T:OSGeo.MapGuide.MaestroAPI.IServerConnection"/> instances from the given parameters
+ /// </summary>
+ /// <param name="initParams">The init params.</param>
+ /// <returns></returns>
public delegate IServerConnection ConnectionFactoryMethod(NameValueCollection initParams);
/// <summary>
@@ -190,8 +201,8 @@
/// <summary>
/// Registers a new connection provider
/// </summary>
- /// <param name="provider"></param>
- /// <param name="method"></param>
+ /// <param name="entry">The provider entry.</param>
+ /// <param name="method">The factory method.</param>
public static void RegisterProvider(ConnectionProviderEntry entry, ConnectionFactoryMethod method)
{
string name = entry.Name.ToUpper();
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/CoordinateSystemCatalog.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/CoordinateSystemCatalog.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/CoordinateSystemCatalog.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -139,6 +139,12 @@
/// <value></value>
public abstract bool IsLoaded { get; }
+ /// <summary>
+ /// Creates a simple coordinate system transformation from the source and target WKT strings
+ /// </summary>
+ /// <param name="sourceWkt"></param>
+ /// <param name="targetWkt"></param>
+ /// <returns></returns>
public virtual ISimpleTransform CreateTransform(string sourceWkt, string targetWkt)
{
return new DefaultSimpleTransform(sourceWkt, targetWkt);
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/ISimpleTransform.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/ISimpleTransform.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CoordinateSystem/ISimpleTransform.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -111,6 +111,9 @@
ty = pts[1];
}
+ /// <summary>
+ /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+ /// </summary>
public void Dispose()
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CrossConnection/ResourceRebaser.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CrossConnection/ResourceRebaser.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/CrossConnection/ResourceRebaser.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -31,6 +31,11 @@
/// </summary>
public class RebaseOptions
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RebaseOptions"/> class.
+ /// </summary>
+ /// <param name="sourceFolder">The source folder.</param>
+ /// <param name="targetFolder">The target folder.</param>
public RebaseOptions(string sourceFolder, string targetFolder)
{
Check.Precondition(ResourceIdentifier.IsFolderResource(sourceFolder), "ResourceIdentifier.IsFolderResource(sourceFolder)");
@@ -66,6 +71,10 @@
{
private IResource _res;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceRebaser"/> class.
+ /// </summary>
+ /// <param name="res">The res.</param>
public ResourceRebaser(IResource res)
{
_res = res;
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Exceptions/NestedExceptionMessageProcessor.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Exceptions/NestedExceptionMessageProcessor.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Exceptions/NestedExceptionMessageProcessor.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -29,7 +29,7 @@
public static class NestedExceptionMessageProcessor
{
/// <summary>
- /// Returns a formatted string containing the main exception message and all messages within the <see cref="InnerException"/> properties
+ /// Returns a formatted string containing the main exception message and all messages within the <see cref="P:System.Exception.InnerException"/> properties
/// </summary>
/// <param name="error">The error.</param>
/// <returns></returns>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Expression/ExpressionFeatureReader.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Expression/ExpressionFeatureReader.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Expression/ExpressionFeatureReader.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -27,7 +27,7 @@
namespace OSGeo.MapGuide.MaestroAPI.Expression
{
/// <summary>
- /// A <see cref="FeatureSetReader"/> that supports expression evaluation
+ /// A subclass <see cref="ReaderBase"/> that supports expression evaluation
/// </summary>
internal class ExpressionFeatureReader : ReaderBase
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureBase.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureBase.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -32,6 +32,10 @@
{
private ClassDefinition _clsDef;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="FeatureBase"/> class.
+ /// </summary>
+ /// <param name="clsDef">The class definition.</param>
public FeatureBase(ClassDefinition clsDef) : base()
{
_clsDef = clsDef;
@@ -96,18 +100,31 @@
}
}
+ /// <summary>
+ /// Gets the class definition of the object currently being read. If the user has requested
+ /// only a subset of the class properties (as specified in the filter text), the class
+ /// definition reflects what the user has requested, rather than the full class definition.
+ /// </summary>
public ClassDefinition ClassDefinition
{
get { return _clsDef; }
}
}
+ /// <summary>
+ /// A subclass of <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.FeatureReaderBase"/> that
+ /// iterates over an array of <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IFeature"/> instances
+ /// </summary>
public class FeatureArrayReader : FeatureReaderBase
{
private IFeature[] _features;
private int _pos;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="FeatureArrayReader"/> class.
+ /// </summary>
+ /// <param name="features">The features.</param>
public FeatureArrayReader(IFeature[] features)
{
_features = features;
@@ -117,6 +134,10 @@
_pos = -1;
}
+ /// <summary>
+ /// Reads the next feature.
+ /// </summary>
+ /// <returns></returns>
protected override IFeature ReadNextFeature()
{
_pos++;
@@ -126,6 +147,9 @@
return null;
}
+ /// <summary>
+ /// Closes the object, freeing any resources it may be holding.
+ /// </summary>
public override void Close()
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureReaderBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureReaderBase.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/FeatureReaderBase.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -32,10 +32,19 @@
/// </summary>
public abstract class FeatureReaderBase : ReaderBase, IFeatureReader
{
+ /// <summary>
+ /// Reads the next feature.
+ /// </summary>
+ /// <returns></returns>
protected abstract IFeature ReadNextFeature();
private ClassDefinition _cls;
+ /// <summary>
+ /// Gets the class definition of the object currently being read. If the user has requested
+ /// only a subset of the class properties (as specified in the filter text), the class
+ /// definition reflects what the user has requested, rather than the full class definition.
+ /// </summary>
public OSGeo.MapGuide.MaestroAPI.Schema.ClassDefinition ClassDefinition
{
get { return _cls; }
@@ -46,31 +55,63 @@
}
}
+ /// <summary>
+ /// Gets a <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IFeatureReader"/> containing
+ /// all the nested features of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public IFeatureReader GetFeatureObject(string name)
{
return ((IFeature)this.Current).GetFeatureObject(name);
}
+ /// <summary>
+ /// Gets a <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IFeatureReader"/> containing
+ /// all the nested features at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public IFeatureReader GetFeatureObject(int index)
{
return ((IFeature)this.Current).GetFeatureObject(index);
}
+ /// <summary>
+ /// Gets the name of the field at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public override string GetName(int index)
{
return this.ClassDefinition.Properties[index].Name;
}
+ /// <summary>
+ /// Gets the CLR type of the field at the specified index
+ /// </summary>
+ /// <param name="i"></param>
+ /// <returns></returns>
public override Type GetFieldType(int i)
{
return ClrFdoTypeMap.GetClrType(this.ClassDefinition[i]);
}
+ /// <summary>
+ /// Gets the type of the reader.
+ /// </summary>
+ /// <value>
+ /// The type of the reader.
+ /// </value>
public override ReaderType ReaderType
{
get { return ReaderType.Feature; }
}
+ /// <summary>
+ /// Reads the next record.
+ /// </summary>
+ /// <returns></returns>
protected override IRecord ReadNextRecord()
{
return ReadNextFeature();
@@ -111,11 +152,23 @@
}
}
+ /// <summary>
+ /// Returns an enumerator that iterates through the collection.
+ /// </summary>
+ /// <returns>
+ /// A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
+ /// </returns>
public IEnumerator<IFeature> GetEnumerator()
{
return new Enumerator(this);
}
+ /// <summary>
+ /// Returns an enumerator that iterates through a collection.
+ /// </summary>
+ /// <returns>
+ /// An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
+ /// </returns>
IEnumerator IEnumerable.GetEnumerator()
{
return new Enumerator(this);
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/IReader.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/IReader.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/IReader.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -67,6 +67,10 @@
/// </summary>
public interface IRecordReset
{
+ /// <summary>
+ /// Updates the specified record.
+ /// </summary>
+ /// <param name="record">The record.</param>
void Update(IRecord record);
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/PropertyValue.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/PropertyValue.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/PropertyValue.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -31,12 +31,27 @@
/// </summary>
public abstract class PropertyValue
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="PropertyValue"/> class.
+ /// </summary>
protected PropertyValue() { this.IsNull = true; }
+ /// <summary>
+ /// Gets or sets a value indicating whether this instance is null.
+ /// </summary>
+ /// <value>
+ /// <c>true</c> if this instance is null; otherwise, <c>false</c>.
+ /// </value>
public virtual bool IsNull { get; protected set; }
+ /// <summary>
+ /// Sets the value to null.
+ /// </summary>
public virtual void SetNull() { this.IsNull = true; }
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public abstract PropertyValueType Type { get; }
}
@@ -46,8 +61,15 @@
/// <typeparam name="T"></typeparam>
public abstract class ValueTypePropertyValue<T> : PropertyValue where T : struct
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ValueTypePropertyValue<T>"/> class.
+ /// </summary>
protected ValueTypePropertyValue() : base() { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ValueTypePropertyValue<T>"/> class.
+ /// </summary>
+ /// <param name="value">The value.</param>
protected ValueTypePropertyValue(T value)
: base()
{
@@ -56,6 +78,12 @@
private Nullable<T> _value;
+ /// <summary>
+ /// Gets or sets a value indicating whether this instance is null.
+ /// </summary>
+ /// <value>
+ /// <c>true</c> if this instance is null; otherwise, <c>false</c>.
+ /// </value>
public override bool IsNull
{
get
@@ -64,6 +92,12 @@
}
}
+ /// <summary>
+ /// Gets or sets the value.
+ /// </summary>
+ /// <value>
+ /// The value.
+ /// </value>
public T Value
{
get
@@ -79,6 +113,9 @@
}
}
+ /// <summary>
+ /// Sets the value to null.
+ /// </summary>
public override void SetNull()
{
_value = null;
@@ -91,8 +128,15 @@
/// <typeparam name="T"></typeparam>
public abstract class ReferenceTypePropertyValue<T> : PropertyValue where T : class
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ReferenceTypePropertyValue<T>"/> class.
+ /// </summary>
protected ReferenceTypePropertyValue() : base() { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ReferenceTypePropertyValue<T>"/> class.
+ /// </summary>
+ /// <param name="value">The value.</param>
protected ReferenceTypePropertyValue(T value)
: base()
{
@@ -102,6 +146,12 @@
private T _value;
+ /// <summary>
+ /// Gets or sets the value.
+ /// </summary>
+ /// <value>
+ /// The value.
+ /// </value>
public T Value
{
get
@@ -124,6 +174,9 @@
/// </summary>
public class ByteValue : ValueTypePropertyValue<byte>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Byte; }
@@ -135,6 +188,9 @@
/// </summary>
public class BooleanValue : ValueTypePropertyValue<bool>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Boolean; }
@@ -146,6 +202,9 @@
/// </summary>
public class BlobValue : ReferenceTypePropertyValue<byte[]>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Blob; }
@@ -157,6 +216,9 @@
/// </summary>
public class ClobValue : ReferenceTypePropertyValue<char[]>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Clob; }
@@ -168,6 +230,9 @@
/// </summary>
public class DateTimeValue : ValueTypePropertyValue<DateTime>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.DateTime; }
@@ -179,6 +244,9 @@
/// </summary>
public class DoubleValue : ValueTypePropertyValue<double>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Double; }
@@ -190,6 +258,9 @@
/// </summary>
public class FeatureValue : ReferenceTypePropertyValue<IFeature[]>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Feature; }
@@ -201,6 +272,9 @@
/// </summary>
public class GeometryValue : ReferenceTypePropertyValue<IGeometry>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Geometry; }
@@ -212,6 +286,9 @@
/// </summary>
public class Int16Value : ValueTypePropertyValue<short>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Int16; }
@@ -223,6 +300,9 @@
/// </summary>
public class Int32Value : ValueTypePropertyValue<int>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Int32; }
@@ -234,6 +314,9 @@
/// </summary>
public class Int64Value : ValueTypePropertyValue<long>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Int64; }
@@ -245,6 +328,9 @@
/// </summary>
public class RasterValue : ReferenceTypePropertyValue<byte[]>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Raster; }
@@ -256,6 +342,9 @@
/// </summary>
public class SingleValue : ValueTypePropertyValue<float>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.Single; }
@@ -267,6 +356,9 @@
/// </summary>
public class StringValue : ReferenceTypePropertyValue<string>
{
+ /// <summary>
+ /// Gets the type.
+ /// </summary>
public override PropertyValueType Type
{
get { return PropertyValueType.String; }
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/ReaderBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/ReaderBase.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/ReaderBase.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -30,169 +30,340 @@
/// </summary>
public abstract class ReaderBase : IReader
{
+ /// <summary>
+ /// Gets the current iterated record
+ /// </summary>
public IRecord Current { get; private set; }
+ /// <summary>
+ /// Gets the type of the reader.
+ /// </summary>
+ /// <value>
+ /// The type of the reader.
+ /// </value>
public abstract ReaderType ReaderType { get; }
+ /// <summary>
+ /// Gets the number of fields in this record
+ /// </summary>
public int FieldCount
{
get;
protected set;
}
+ /// <summary>
+ /// Gets the name of the field at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public abstract string GetName(int index);
+ /// <summary>
+ /// Advances the reader to the next item and determines whether there is another object to read.
+ /// </summary>
+ /// <returns></returns>
public bool ReadNext()
{
this.Current = ReadNextRecord();
return this.Current != null;
}
+ /// <summary>
+ /// Reads the next record.
+ /// </summary>
+ /// <returns></returns>
protected abstract IRecord ReadNextRecord();
+ /// <summary>
+ /// Closes the object, freeing any resources it may be holding.
+ /// </summary>
public virtual void Close() { }
+ /// <summary>
+ /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+ /// </summary>
public virtual void Dispose() { }
+ /// <summary>
+ /// Gets the CLR type of the field at the specified index
+ /// </summary>
+ /// <param name="i"></param>
+ /// <returns></returns>
public abstract Type GetFieldType(int i);
+ /// <summary>
+ /// Gets whether the specified property name has a null property value
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public bool IsNull(string name)
{
return this.Current.IsNull(name);
}
+ /// <summary>
+ /// Gets whether the property value at the specified index has a null property value. You must
+ /// call this method first to determine if it is safe to call the corresponding GetXXX() methods
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public bool IsNull(int index)
{
return this.Current.IsNull(index);
}
+ /// <summary>
+ /// Gets the boolean value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public bool GetBoolean(string name)
{
return this.Current.GetBoolean(name);
}
+ /// <summary>
+ /// Gets the byte value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public byte GetByte(string name)
{
return this.Current.GetByte(name);
}
+ /// <summary>
+ /// Gets the blob value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public byte[] GetBlob(string name)
{
return this.Current.GetBlob(name);
}
+ /// <summary>
+ /// Gets the clob value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public char[] GetClob(string name)
{
return this.Current.GetClob(name);
}
+ /// <summary>
+ /// Gets the double value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public double GetDouble(string name)
{
return this.Current.GetDouble(name);
}
+ /// <summary>
+ /// Gets the datetime value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public DateTime GetDateTime(string name)
{
return this.Current.GetDateTime(name);
}
-
-
+ /// <summary>
+ /// Gets the int16 value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public short GetInt16(string name)
{
return this.Current.GetInt16(name);
}
+ /// <summary>
+ /// Gets the int32 value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public int GetInt32(string name)
{
return this.Current.GetInt32(name);
}
+ /// <summary>
+ /// Gets the int64 value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public long GetInt64(string name)
{
return this.Current.GetInt64(name);
}
+ /// <summary>
+ /// Gets the single value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public float GetSingle(string name)
{
return this.Current.GetSingle(name);
}
+ /// <summary>
+ /// Gets the string value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public string GetString(string name)
{
return this.Current.GetString(name);
}
+ /// <summary>
+ /// Gets the geometry value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public IGeometry GetGeometry(string name)
{
return this.Current.GetGeometry(name);
}
+ /// <summary>
+ /// Gets the boolean value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public bool GetBoolean(int index)
{
return this.Current.GetBoolean(index);
}
+ /// <summary>
+ /// Gets the byte value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public byte GetByte(int index)
{
return this.Current.GetByte(index);
}
+ /// <summary>
+ /// Gets the blob value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public byte[] GetBlob(int index)
{
return this.Current.GetBlob(index);
}
+ /// <summary>
+ /// Gets the clob value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public char[] GetClob(int index)
{
return this.Current.GetClob(index);
}
+ /// <summary>
+ /// Gets the double value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public double GetDouble(int index)
{
return this.Current.GetDouble(index);
}
+ /// <summary>
+ /// Gets the datetime value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public DateTime GetDateTime(int index)
{
return this.Current.GetDateTime(index);
}
+ /// <summary>
+ /// Gets the int16 value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public short GetInt16(int index)
{
return this.Current.GetInt16(index);
}
+ /// <summary>
+ /// Gets the int32 value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public int GetInt32(int index)
{
return this.Current.GetInt32(index);
}
+ /// <summary>
+ /// Gets the int64 value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public long GetInt64(int index)
{
return this.Current.GetInt64(index);
}
+ /// <summary>
+ /// Gets the single value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public float GetSingle(int index)
{
return this.Current.GetSingle(index);
}
+ /// <summary>
+ /// Gets the string value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public string GetString(int index)
{
return this.Current.GetString(index);
}
+ /// <summary>
+ /// Gets the geometry value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public IGeometry GetGeometry(int index)
{
return this.Current.GetGeometry(index);
}
+ /// <summary>
+ /// Gets the <see cref="System.Object"/> at the specified index.
+ /// </summary>
public object this[int index]
{
get { return this.Current[index]; }
}
+ /// <summary>
+ /// Gets the <see cref="System.Object"/> with the specified name.
+ /// </summary>
public object this[string name]
{
get { return this.Current[name]; }
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/RecordBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/RecordBase.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Feature/RecordBase.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -31,20 +31,39 @@
/// </summary>
public abstract class RecordBase : IRecord, IRecordReset, IRecordInitialize
{
+ /// <summary>
+ /// The map of property values
+ /// </summary>
protected Dictionary<string, PropertyValue> _values;
+ /// <summary>
+ /// A dictionary to map indexes to property names
+ /// </summary>
protected Dictionary<int, string> _ordinalMap;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RecordBase"/> class.
+ /// </summary>
protected RecordBase()
{
_values = new Dictionary<string, PropertyValue>();
_ordinalMap = new Dictionary<int, string>();
}
+ /// <summary>
+ /// Gets the specified property value by name
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public PropertyValue GetValue(string name)
{
return _values[name];
}
+ /// <summary>
+ /// Adds the specified property value
+ /// </summary>
+ /// <param name="name"></param>
+ /// <param name="value"></param>
public void PutValue(string name, PropertyValue value)
{
if (_values.ContainsKey(name))
@@ -53,151 +72,298 @@
_values[name] = value;
}
+ /// <summary>
+ /// Gets whether the specified property name has a null property value
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public bool IsNull(string name)
{
return _values[name].IsNull;
}
+ /// <summary>
+ /// Gets whether the property value at the specified index has a null property value. You must
+ /// call this method first to determine if it is safe to call the corresponding GetXXX() methods
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public bool IsNull(int index)
{
return IsNull(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the boolean value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public bool GetBoolean(string name)
{
return ((BooleanValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the byte value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public byte GetByte(string name)
{
return ((ByteValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the blob value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public byte[] GetBlob(string name)
{
return ((BlobValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the clob value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public char[] GetClob(string name)
{
return ((ClobValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the double value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public double GetDouble(string name)
{
return ((DoubleValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the datetime value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public DateTime GetDateTime(string name)
{
return ((DateTimeValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the feature object.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <returns></returns>
public IFeatureReader GetFeatureObject(string name)
{
return new FeatureArrayReader(((FeatureValue)_values[name]).Value);
}
+ /// <summary>
+ /// Gets the int16 value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public short GetInt16(string name)
{
return ((Int16Value)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the int32 value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public int GetInt32(string name)
{
return ((Int32Value)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the int64 value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public long GetInt64(string name)
{
return ((Int64Value)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the single value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public float GetSingle(string name)
{
return ((SingleValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the string value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public string GetString(string name)
{
return ((StringValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the geometry value of the specified property
+ /// </summary>
+ /// <param name="name"></param>
+ /// <returns></returns>
public IGeometry GetGeometry(string name)
{
return ((GeometryValue)_values[name]).Value;
}
+ /// <summary>
+ /// Gets the boolean value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public bool GetBoolean(int index)
{
return GetBoolean(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the byte value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public byte GetByte(int index)
{
return GetByte(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the blob value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public byte[] GetBlob(int index)
{
return GetBlob(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the clob value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public char[] GetClob(int index)
{
return GetClob(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the double value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public double GetDouble(int index)
{
return GetDouble(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the datetime value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public DateTime GetDateTime(int index)
{
return GetDateTime(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the feature object.
+ /// </summary>
+ /// <param name="index">The index.</param>
+ /// <returns></returns>
public IFeatureReader GetFeatureObject(int index)
{
return GetFeatureObject(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the int16 value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public short GetInt16(int index)
{
return GetInt16(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the int32 value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public int GetInt32(int index)
{
return GetInt32(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the int64 value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public long GetInt64(int index)
{
return GetInt64(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the single value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public float GetSingle(int index)
{
return GetSingle(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the string value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public string GetString(int index)
{
return GetString(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the geometry value at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public IGeometry GetGeometry(int index)
{
return GetGeometry(_ordinalMap[index]);
}
+ /// <summary>
+ /// Gets the <see cref="System.Object"/> at the specified index.
+ /// </summary>
public object this[int index]
{
get { return this[_ordinalMap[index]]; }
}
+ /// <summary>
+ /// Gets the <see cref="System.Object"/> with the specified name.
+ /// </summary>
public object this[string name]
{
get
@@ -237,21 +403,38 @@
}
}
+ /// <summary>
+ /// Gets the number of fields in this record
+ /// </summary>
public int FieldCount
{
get { return _values.Count; }
}
+ /// <summary>
+ /// Gets the name of the field at the specified index
+ /// </summary>
+ /// <param name="index"></param>
+ /// <returns></returns>
public string GetName(int index)
{
return _ordinalMap[index];
}
+ /// <summary>
+ /// Gets the CLR type of the field at the specified index
+ /// </summary>
+ /// <param name="i"></param>
+ /// <returns></returns>
public Type GetFieldType(int i)
{
return ClrFdoTypeMap.GetClrType(_values[GetName(i)].Type);
}
+ /// <summary>
+ /// Updates the specified record.
+ /// </summary>
+ /// <param name="record">The record.</param>
public void Update(IRecord record)
{
if (record.FieldCount != this.FieldCount)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/MapSelection.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/MapSelection.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/MapSelection.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -466,6 +466,10 @@
#endregion
}
+ /// <summary>
+ /// Serializes this instance using the specified serializer.
+ /// </summary>
+ /// <param name="s">The serializer.</param>
public void Serialize(MgBinarySerializer s)
{
var m_selection = new XmlDocument();
@@ -499,6 +503,10 @@
}
}
+ /// <summary>
+ /// Deserializes this object using the specified deserializer.
+ /// </summary>
+ /// <param name="d">The deserializer.</param>
public void Deserialize(MgBinaryDeserializer d)
{
XmlDocument doc = new XmlDocument();
@@ -538,8 +546,10 @@
/// <summary>
/// Returns the index of the given layer
/// </summary>
- /// <param name="item">The layer to look for</param>
- /// <returns>The index of the layer, or -1 if the layer is not in the collection</returns>
+ /// <param name="layer">The layer.</param>
+ /// <returns>
+ /// The index of the layer, or -1 if the layer is not in the collection
+ /// </returns>
public int IndexOf(RuntimeMapLayer layer)
{
for (int i = 0; i < _layers.Count; i++)
@@ -667,6 +677,28 @@
return IndexOf(item) >= 0;
}
+ /// <summary>
+ /// Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1"/> to an <see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index.
+ /// </summary>
+ /// <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
+ /// <param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
+ /// <exception cref="T:System.ArgumentNullException">
+ /// <paramref name="array"/> is null.
+ /// </exception>
+ ///
+ /// <exception cref="T:System.ArgumentOutOfRangeException">
+ /// <paramref name="arrayIndex"/> is less than 0.
+ /// </exception>
+ ///
+ /// <exception cref="T:System.ArgumentException">
+ /// <paramref name="array"/> is multidimensional.
+ /// -or-
+ /// <paramref name="arrayIndex"/> is equal to or greater than the length of <paramref name="array"/>.
+ /// -or-
+ /// The number of elements in the source <see cref="T:System.Collections.Generic.ICollection`1"/> is greater than the available space from <paramref name="arrayIndex"/> to the end of the destination <paramref name="array"/>.
+ /// -or-
+ /// Type <paramref name="T"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
+ /// </exception>
public void CopyTo(MapSelection.LayerSelection[] array, int arrayIndex)
{
throw new NotImplementedException();
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -137,9 +137,18 @@
/// </summary>
protected Dictionary<string, RuntimeMapLayer> _layerIdMap;
+ /// <summary>
+ /// The mapping service
+ /// </summary>
protected IMappingService _mapSvc;
+ /// <summary>
+ /// The GetResourceContents command
+ /// </summary>
protected IGetResourceContents _getRes;
+ /// <summary>
+ /// The amount to increment the Z order for successive layers being added
+ /// </summary>
public const double Z_ORDER_INCREMENT = 100.0;
internal RuntimeMap(IServerConnection conn)
@@ -990,6 +999,11 @@
AddLayerInternal(layer, index);
}
+ /// <summary>
+ /// Sets the layer to the specified index
+ /// </summary>
+ /// <param name="index">The index.</param>
+ /// <param name="layer">The layer.</param>
public void SetLayerIndex(int index, RuntimeMapLayer layer)
{
if (index >= _layers.Count || index < 0)
@@ -1003,6 +1017,10 @@
}
}
+ /// <summary>
+ /// Removes the layer at the specified index
+ /// </summary>
+ /// <param name="index">The index.</param>
public void RemoveLayerAt(int index)
{
if (index >= _layers.Count || index < 0)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapGroup.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -256,7 +256,7 @@
}
/// <summary>
- /// Raises the <see cref="PropertyChanged"/> event
+ /// Raises the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/> event
/// </summary>
/// <param name="propertyName"></param>
protected override void OnPropertyChanged(string propertyName)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMapLayer.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -525,6 +525,11 @@
}
}
+ /// <summary>
+ /// Parses encoded id string into an array of values
+ /// </summary>
+ /// <param name="encodedId">The encoded id string.</param>
+ /// <returns></returns>
public object[] ParseSelectionValues(string encodedId)
{
int index = 0;
@@ -752,7 +757,7 @@
}
/// <summary>
- /// Raises the <see cref="PropertyChanged"/> event
+ /// Raises the <see cref="E:System.ComponentModel.INotfiyPropertyChanged.PropertyChanged"/> event
/// </summary>
/// <param name="propertyName"></param>
protected override void OnPropertyChanged(string propertyName)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ApplicationDefinitionInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ApplicationDefinitionInterfaces.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ApplicationDefinitionInterfaces.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -612,10 +612,11 @@
}
/// <summary>
- /// Removes the specified widget from this
+ /// Removes the specified widget from this
/// </summary>
- /// <param name="widget"></param>
- /// <param name="deleteReferences"></param>
+ /// <param name="appDef">The app definition.</param>
+ /// <param name="widgetName">Name of the widget to remove.</param>
+ /// <param name="deleteReferences">if set to <c>true</c> [deletes any references to the widget to be deleted].</param>
public static void RemoveWidget(this IApplicationDefinition appDef, string widgetName, bool deleteReferences)
{
Check.NotNull(appDef, "appDef");
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/CommonTypes.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/CommonTypes.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/CommonTypes.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -17,6 +17,7 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
+#pragma warning disable 1591, 0114, 0108, 0114, 0108
using System;
using System.Collections.Generic;
using System.Text;
@@ -287,52 +288,190 @@
ExpressionDataType ExpressionType { get; }
}
+ /// <summary>
+ /// The types of valid FDO expressions for use in Symbol Definitions
+ /// </summary>
public enum ExpressionDataType
{
+ /// <summary>
+ /// BLOB data property
+ /// </summary>
Data_Blob,
+ /// <summary>
+ /// Boolean data property
+ /// </summary>
Data_Boolean,
+ /// <summary>
+ /// Byte data property
+ /// </summary>
Data_Byte,
+ /// <summary>
+ /// CLOB data property
+ /// </summary>
Data_Clob,
+ /// <summary>
+ /// DateTime data property
+ /// </summary>
Data_DateTime,
+ /// <summary>
+ /// Double data property
+ /// </summary>
Data_Double,
+ /// <summary>
+ /// Int16 data property
+ /// </summary>
Data_Int16,
+ /// <summary>
+ /// Int32 data property
+ /// </summary>
Data_Int32,
+ /// <summary>
+ /// Int64 data property
+ /// </summary>
Data_Int64,
+ /// <summary>
+ /// Single data property
+ /// </summary>
Data_Single,
+ /// <summary>
+ /// String data property
+ /// </summary>
Data_String,
+ /// <summary>
+ /// Geometry property
+ /// </summary>
Geometry,
+ /// <summary>
+ /// Raster property
+ /// </summary>
Raster,
+ /// <summary>
+ /// Association property
+ /// </summary>
Association,
+ /// <summary>
+ /// String symbol parameter
+ /// </summary>
Sym_String,
+ /// <summary>
+ /// Boolean symbol parameter
+ /// </summary>
Sym_Boolean,
+ /// <summary>
+ /// Integer symbol parameter
+ /// </summary>
Sym_Integer,
+ /// <summary>
+ /// Real symbol parameter
+ /// </summary>
Sym_Real,
+ /// <summary>
+ /// Color symbol parameter
+ /// </summary>
Sym_Color,
+ /// <summary>
+ /// Angle symbol parameter
+ /// </summary>
Sym_Angle,
+ /// <summary>
+ /// Fill color symbol parameter
+ /// </summary>
Sym_FillColor,
+ /// <summary>
+ /// Line color symbol parameter
+ /// </summary>
Sym_LineColor,
+ /// <summary>
+ /// Line weight symbol parameter
+ /// </summary>
Sym_LineWeight,
+ /// <summary>
+ /// Content symbol parameter
+ /// </summary>
Sym_Content,
+ /// <summary>
+ /// Markup symbol parameter
+ /// </summary>
Sym_Markup,
+ /// <summary>
+ /// Font name symbol parameter
+ /// </summary>
Sym_FontName,
+ /// <summary>
+ /// Bold symbol parameter
+ /// </summary>
Sym_Bold,
+ /// <summary>
+ /// Italic symbol parameter
+ /// </summary>
Sym_Italic,
+ /// <summary>
+ /// Underlined symbol parameter
+ /// </summary>
Sym_Underlined,
+ /// <summary>
+ /// Overlined symbol parameter
+ /// </summary>
Sym_Overlined,
+ /// <summary>
+ /// Oblique angle symbol parameter
+ /// </summary>
Sym_ObliqueAngle,
+ /// <summary>
+ /// Track spacing symbol parameter
+ /// </summary>
Sym_TrackSpacing,
+ /// <summary>
+ /// Font height symbol parameter
+ /// </summary>
Sym_FontHeight,
+ /// <summary>
+ /// Horizontal alignment symbol parameter
+ /// </summary>
Sym_HorizontalAlignment,
+ /// <summary>
+ /// Vertical alignment symbol parameter
+ /// </summary>
Sym_VerticalAlignment,
+ /// <summary>
+ /// Justification symbol parameter
+ /// </summary>
Sym_Justification,
+ /// <summary>
+ /// Line spacing symbol parameter
+ /// </summary>
Sym_LineSpacing,
+ /// <summary>
+ /// Text color symbol parameter
+ /// </summary>
Sym_TextColor,
+ /// <summary>
+ /// Ghost color symbol parameter
+ /// </summary>
Sym_GhostColor,
+ /// <summary>
+ /// Frame line color symbol parameter
+ /// </summary>
Sym_FrameLineColor,
+ /// <summary>
+ /// Frame fill color symbol parameter
+ /// </summary>
Sym_FrameFillColor,
+ /// <summary>
+ /// Start offset symbol parameter
+ /// </summary>
Sym_StartOffset,
+ /// <summary>
+ /// End offset symbol parameter
+ /// </summary>
Sym_EndOffset,
+ /// <summary>
+ /// Repeat X symbol parameter
+ /// </summary>
Sym_RepeatX,
+ /// <summary>
+ /// Repeat Y symbol parameter
+ /// </summary>
Sym_RepeatY
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/DrawingSourceInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/DrawingSourceInterfaces.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/DrawingSourceInterfaces.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -98,6 +98,9 @@
IEnvelope Extent { get; set; }
}
+ /// <summary>
+ /// Extension methods for Drawing Sources
+ /// </summary>
public static class DrawingSourceExtensions
{
/// <summary>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/IFdoSpatialContext.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/IFdoSpatialContext.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/IFdoSpatialContext.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -17,6 +17,7 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
+#pragma warning disable 1591, 0114, 0108, 0114, 0108
using System;
using System.Collections.Generic;
using System.Text;
@@ -32,20 +33,68 @@
/// </summary>
public interface IFdoSpatialContext : IFdoSerializable
{
+ /// <summary>
+ /// Gets or sets the name of the coordinate system.
+ /// </summary>
+ /// <value>
+ /// The name of the coordinate system.
+ /// </value>
string CoordinateSystemName { get; set; }
+ /// <summary>
+ /// Gets or sets the coordinate system WKT.
+ /// </summary>
+ /// <value>
+ /// The coordinate system WKT.
+ /// </value>
string CoordinateSystemWkt { get; set; }
+ /// <summary>
+ /// Gets or sets the description.
+ /// </summary>
+ /// <value>
+ /// The description.
+ /// </value>
string Description { get; set; }
+ /// <summary>
+ /// Gets or sets the extent.
+ /// </summary>
+ /// <value>
+ /// The extent.
+ /// </value>
IEnvelope Extent { get; set; }
+ /// <summary>
+ /// Gets or sets the type of the extent.
+ /// </summary>
+ /// <value>
+ /// The type of the extent.
+ /// </value>
FdoSpatialContextListSpatialContextExtentType ExtentType { get; set; }
+ /// <summary>
+ /// Gets or sets the name.
+ /// </summary>
+ /// <value>
+ /// The name.
+ /// </value>
string Name { get; set; }
+ /// <summary>
+ /// Gets or sets the XY tolerance.
+ /// </summary>
+ /// <value>
+ /// The XY tolerance.
+ /// </value>
double XYTolerance { get; set; }
+ /// <summary>
+ /// Gets or sets the Z tolerance.
+ /// </summary>
+ /// <value>
+ /// The Z tolerance.
+ /// </value>
double ZTolerance { get; set; }
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/LayerInterfaces.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -332,8 +332,16 @@
/// <returns></returns>
IW2DSymbol CreateDefaultW2DSymbol(string symbolLibrary, string symbolName);
+ /// <summary>
+ /// Creates the default composite rule.
+ /// </summary>
+ /// <returns></returns>
ICompositeRule CreateDefaultCompositeRule();
+ /// <summary>
+ /// Creates the default composite style.
+ /// </summary>
+ /// <returns></returns>
ICompositeTypeStyle CreateDefaultCompositeStyle();
}
@@ -536,10 +544,23 @@
/// <param name="range"></param>
void RemoveGridScaleRange(IGridScaleRange range);
+ /// <summary>
+ /// Indexes the of scale range.
+ /// </summary>
+ /// <param name="range">The range.</param>
+ /// <returns></returns>
int IndexOfScaleRange(IGridScaleRange range);
+ /// <summary>
+ /// Gets the scale range at.
+ /// </summary>
+ /// <param name="index">The index.</param>
+ /// <returns></returns>
IGridScaleRange GetScaleRangeAt(int index);
+ /// <summary>
+ /// Gets the grid scale range count.
+ /// </summary>
int GridScaleRangeCount { get; }
}
@@ -668,6 +689,9 @@
/// </summary>
StyleType StyleType { get; }
+ /// <summary>
+ /// Gets the rule count.
+ /// </summary>
int RuleCount { get; }
}
@@ -748,13 +772,6 @@
/// Removes all current rules
/// </summary>
void RemoveAllRules();
-
- /// <summary>
- /// Gets the line rule at the specified index
- /// </summary>
- /// <param name="index"></param>
- /// <returns></returns>
- ILineRule GetRuleAt(int index);
}
/// <summary>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/MapDefinitionInterfaces.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -434,8 +434,9 @@
/// <summary>
/// Updates the group name references of all layers belonging to a particular group
/// </summary>
- /// <param name="oldGroupName"></param>
- /// <param name="newGroupName"></param>
+ /// <param name="map">The map.</param>
+ /// <param name="oldGroupName">Old name of the group.</param>
+ /// <param name="newGroupName">New name of the group.</param>
public static void UpdateDynamicGroupName(this IMapDefinition map, string oldGroupName, string newGroupName)
{
Check.NotNull(map, "map");
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ObjectFactory.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ObjectFactory.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/ObjectFactory.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -474,6 +474,9 @@
/// Creates a simple symbol definition.
/// </summary>
/// <param name="owner">The owner.</param>
+ /// <param name="version">The version.</param>
+ /// <param name="name">The name.</param>
+ /// <param name="description">The description.</param>
/// <returns></returns>
public static ISimpleSymbolDefinition CreateSimpleSymbol(IServerConnection owner, Version version, string name, string description)
{
@@ -506,6 +509,9 @@
/// Creates the compound symbol.
/// </summary>
/// <param name="owner">The owner.</param>
+ /// <param name="version">The version.</param>
+ /// <param name="name">The name.</param>
+ /// <param name="description">The description.</param>
/// <returns></returns>
public static ICompoundSymbolDefinition CreateCompoundSymbol(IServerConnection owner, Version version, string name, string description)
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolDefFactory.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolDefFactory.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolDefFactory.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -17,6 +17,7 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
+#pragma warning disable 1591, 0114, 0108, 0114, 0108
using System;
using System.Collections.Generic;
using System.Text;
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolInterfaces.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/SymbolInterfaces.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -132,8 +132,16 @@
ISymbolDefinitionBase SymbolDefinition { get; set; }
}
+ /// <summary>
+ /// Extension methods for symbol definitions
+ /// </summary>
public static class SymbolDefExtensions
{
+ /// <summary>
+ /// Gets the parameters.
+ /// </summary>
+ /// <param name="sym">The sym.</param>
+ /// <returns></returns>
public static IEnumerable<IParameter> GetParameters(this ISymbolDefinitionBase sym)
{
Check.NotNull(sym, "sym");
@@ -143,12 +151,22 @@
return ((ICompoundSymbolDefinition)sym).GetParameters();
}
+ /// <summary>
+ /// Gets the parameters.
+ /// </summary>
+ /// <param name="ssym">The ssym.</param>
+ /// <returns></returns>
public static IEnumerable<IParameter> GetParameters(this ISimpleSymbolDefinition ssym)
{
Check.NotNull(ssym, "ssym");
return ssym.ParameterDefinition.Parameter;
}
+ /// <summary>
+ /// Gets the parameters.
+ /// </summary>
+ /// <param name="csym">The csym.</param>
+ /// <returns></returns>
public static IEnumerable<IParameter> GetParameters(this ICompoundSymbolDefinition csym)
{
Check.NotNull(csym, "csym");
@@ -316,14 +334,34 @@
/// <returns></returns>
IResizeBox CreateResizeBox();
+ /// <summary>
+ /// Creates the frame.
+ /// </summary>
+ /// <returns></returns>
ITextFrame CreateFrame();
+ /// <summary>
+ /// Creates the text graphics.
+ /// </summary>
+ /// <returns></returns>
ITextGraphic CreateTextGraphics();
+ /// <summary>
+ /// Creates the path graphics.
+ /// </summary>
+ /// <returns></returns>
IPathGraphic CreatePathGraphics();
+ /// <summary>
+ /// Creates the image graphics.
+ /// </summary>
+ /// <returns></returns>
IImageGraphic CreateImageGraphics();
+ /// <summary>
+ /// Creates the parameter.
+ /// </summary>
+ /// <returns></returns>
IParameter CreateParameter();
/// <summary>
@@ -365,7 +403,7 @@
/// <summary>
/// Creates a resource id based symbol reference
/// </summary>
- /// <param name="p"></param>
+ /// <param name="resourceId">The resource id.</param>
/// <returns></returns>
ISimpleSymbolReferenceBase CreateSymbolReference(string resourceId);
@@ -722,7 +760,9 @@
/// <summary>
/// Gets or sets the description.
/// </summary>
- /// <value>The description.</value>
+ /// <value>
+ /// The description.
+ /// </value>
string Description { get; set; }
/// <summary>
@@ -926,15 +966,18 @@
public enum ImageType
{
/// <summary>
- ///
+ /// A reference to an image
/// </summary>
Reference,
/// <summary>
- ///
+ /// Inline content
/// </summary>
Inline
}
+ /// <summary>
+ /// Defines an image graphic
+ /// </summary>
public interface IImageGraphic : IGraphicBase
{
/// <summary>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/WatermarkInterfaces.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/WatermarkInterfaces.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/ObjectModels/WatermarkInterfaces.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -126,8 +126,16 @@
/// <returns></returns>
IWatermark CreateInstance();
+ /// <summary>
+ /// Creates the XY position.
+ /// </summary>
+ /// <returns></returns>
IXYPosition CreateXYPosition();
+ /// <summary>
+ /// Creates the tile position.
+ /// </summary>
+ /// <returns></returns>
ITilePosition CreateTilePosition();
}
@@ -152,7 +160,13 @@
/// </summary>
public enum PositionType
{
+ /// <summary>
+ /// X/Y based position
+ /// </summary>
XY,
+ /// <summary>
+ /// Tile-based position
+ /// </summary>
Tile
}
@@ -309,10 +323,22 @@
/// </summary>
IPosition PositionOverride { get; set; }
+ /// <summary>
+ /// Creates the default appearance.
+ /// </summary>
+ /// <returns></returns>
IWatermarkAppearance CreateDefaultAppearance();
+ /// <summary>
+ /// Creates the default XY position.
+ /// </summary>
+ /// <returns></returns>
IXYPosition CreateDefaultXYPosition();
+ /// <summary>
+ /// Creates the default tile position.
+ /// </summary>
+ /// <returns></returns>
ITilePosition CreateDefaultTilePosition();
}
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/PlatformConnectionBase.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -1767,10 +1767,11 @@
}
/// <summary>
- /// Creates a new runtime map instance from an existing map definition. The runtime map resource id is calculated from the
+ /// Creates a new runtime map instance from an existing map definition. The runtime map resource id is calculated from the
/// current session id and the name component of the Map Definition resource id
/// </summary>
- /// <param name="mdf"></param>
+ /// <param name="mdf">The map definition.</param>
+ /// <param name="metersPerUnit">The meters per unit.</param>
/// <returns></returns>
public RuntimeMap CreateMap(IMapDefinition mdf, double metersPerUnit)
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/IResourceConverter.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/IResourceConverter.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Conversion/IResourceConverter.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -38,8 +38,17 @@
IResource Convert(IResource resource, Version targetVersion);
}
+ /// <summary>
+ /// Performs schematic upgrades of resources
+ /// </summary>
public class ResourceObjectConverter : IResourceConverter
{
+ /// <summary>
+ /// Converts the resource to the specified version
+ /// </summary>
+ /// <param name="resource">The resource.</param>
+ /// <param name="targetVersion">The target version.</param>
+ /// <returns></returns>
public IResource Convert(IResource resource, Version targetVersion)
{
//How does this work? If source and target versions are known, it means the classes
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/IResourceValidator.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/IResourceValidator.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/IResourceValidator.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -54,9 +54,10 @@
/// <summary>
/// Initializes a new instance of the <see cref="ValidationIssue"/> class.
/// </summary>
- /// <param name="res">The res.</param>
- /// <param name="stat">The stat.</param>
- /// <param name="msg">The MSG.</param>
+ /// <param name="res">The resource.</param>
+ /// <param name="stat">The validation status.</param>
+ /// <param name="code">The validation status code.</param>
+ /// <param name="msg">The message.</param>
public ValidationIssue(IResource res, ValidationStatus stat, ValidationStatusCode code, string msg)
{
Check.NotNull(res, "res");
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/BaseSymbolDefinitionValidator.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/BaseSymbolDefinitionValidator.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/BaseSymbolDefinitionValidator.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -5,6 +5,9 @@
namespace OSGeo.MapGuide.MaestroAPI.Resource.Validation
{
+ /// <summary>
+ /// The base class of Symbol Definition validators
+ /// </summary>
public abstract class BaseSymbolDefinitionValidator : IResourceValidator
{
/// <summary>
@@ -76,6 +79,12 @@
return issues.ToArray();
}
+ /// <summary>
+ /// Validates the simple symbol definition.
+ /// </summary>
+ /// <param name="ssym">The ssym.</param>
+ /// <param name="context">The context.</param>
+ /// <returns></returns>
protected static IEnumerable<ValidationIssue> ValidateSimpleSymbolDefinition(ISimpleSymbolDefinition ssym, ResourceValidationContext context)
{
//Check that one geometry usage context has been specified
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/MapDefinitionValidator.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/MapDefinitionValidator.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/MapDefinitionValidator.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -31,6 +31,9 @@
namespace OSGeo.MapGuide.MaestroAPI.Resource.Validation
{
+ /// <summary>
+ /// A Map Definition validator
+ /// </summary>
public class MapDefinitionValidator : BaseMapDefinitionValidator
{
/// <summary>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidationContext.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidationContext.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidationContext.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -41,6 +41,11 @@
private IResourceService _resSvc;
private IFeatureService _featSvc;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceValidationContext"/> class.
+ /// </summary>
+ /// <param name="resSvc">The res SVC.</param>
+ /// <param name="featSvc">The feat SVC.</param>
public ResourceValidationContext(IResourceService resSvc, IFeatureService featSvc)
{
_resSvc = resSvc;
@@ -62,6 +67,11 @@
_spatialContexts.Clear();
}
+ /// <summary>
+ /// Gets the spatial contexts.
+ /// </summary>
+ /// <param name="resourceId">The resource id.</param>
+ /// <returns></returns>
public FdoSpatialContextList GetSpatialContexts(string resourceId)
{
if (_spatialContexts.ContainsKey(resourceId))
@@ -76,6 +86,11 @@
return scList;
}
+ /// <summary>
+ /// Describes the feature source
+ /// </summary>
+ /// <param name="resourceId">The resource id.</param>
+ /// <returns></returns>
public FeatureSourceDescription DescribeFeatureSource(string resourceId)
{
if (_schemas.ContainsKey(resourceId))
@@ -90,6 +105,11 @@
return desc;
}
+ /// <summary>
+ /// Gets the resource.
+ /// </summary>
+ /// <param name="resourceId">The resource id.</param>
+ /// <returns></returns>
public IResource GetResource(string resourceId)
{
if (_resources.ContainsKey(resourceId))
@@ -104,6 +124,13 @@
return res;
}
+ /// <summary>
+ /// Determines whether the specified resource has already been validated
+ /// </summary>
+ /// <param name="resourceId">The resource id.</param>
+ /// <returns>
+ /// <c>true</c> if [the specified resource has already been validated]; otherwise, <c>false</c>.
+ /// </returns>
public bool IsAlreadyValidated(string resourceId)
{
var res = _validated.ContainsKey(resourceId);
@@ -114,6 +141,10 @@
return res;
}
+ /// <summary>
+ /// Marks the specified resource id as being validated.
+ /// </summary>
+ /// <param name="resourceId">The resource id.</param>
public void MarkValidated(string resourceId)
{
_validated[resourceId] = resourceId;
@@ -121,6 +152,11 @@
Trace.TraceInformation("Validated: " + resourceId);
}
+ /// <summary>
+ /// Gets whether the specified resource exists
+ /// </summary>
+ /// <param name="resourceId">The resource id.</param>
+ /// <returns></returns>
public bool ResourceExists(string resourceId)
{
return _resSvc.ResourceExists(resourceId);
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidatorSet.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidatorSet.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ResourceValidatorSet.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -46,6 +46,7 @@
/// <summary>
/// Validates the specified items.
/// </summary>
+ /// <param name="context">The context.</param>
/// <param name="items">The items.</param>
/// <param name="recurse">if set to <c>true</c> [recurse].</param>
/// <returns></returns>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ValidationStatusCode.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ValidationStatusCode.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Resource/Validation/ValidationStatusCode.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -133,6 +133,9 @@
/// </summary>
Warning_MapDefinition_LayerMissingLegendLabel = 3301,
+ /// <summary>
+ /// Could not find a spatial context for a referenced layer definition in the map definition
+ /// </summary>
Warning_MapDefinition_MissingSpatialContext,
/// <summary>
@@ -147,6 +150,9 @@
/// </summary>
Warning_MapDefinition_DataOutsideMapBounds,
+ /// <summary>
+ /// The Map Definition does not have a coordinate system
+ /// </summary>
Warning_MapDefinition_MissingCoordinateSystem,
/// <summary>
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/ClassDefinition.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/ClassDefinition.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/ClassDefinition.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -45,6 +45,11 @@
_properties = new List<PropertyDefinition>();
}
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ClassDefinition"/> class.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="description">The description.</param>
public ClassDefinition(string name, string description)
: this()
{
@@ -67,6 +72,11 @@
get { return _properties[index]; }
}
+ /// <summary>
+ /// Gets the ordinal of the specified property name
+ /// </summary>
+ /// <param name="name">The property name.</param>
+ /// <returns></returns>
public int GetOrdinal(string name)
{
if (_ordinalMap.ContainsKey(name))
@@ -196,6 +206,9 @@
return removed;
}
+ /// <summary>
+ /// Gets the parent schema
+ /// </summary>
public FeatureSchema Parent { get; internal set; }
/// <summary>
@@ -218,6 +231,11 @@
/// </summary>
public string QualifiedName { get { return this.Parent != null ? this.Parent.Name + ":" + this.Name : this.Name; } }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(XmlDocument doc, XmlNode currentNode)
{
XmlElement id = null;
@@ -291,6 +309,11 @@
currentNode.AppendChild(ctype);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(XmlNode node, XmlNamespaceManager mgr)
{
var en = Utility.EncodeFDOName(this.Name);
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/DataPropertyDefinition.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/DataPropertyDefinition.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/DataPropertyDefinition.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -35,6 +35,11 @@
{
private DataPropertyDefinition() { this.DataType = DataPropertyType.String; }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="DataPropertyDefinition"/> class.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="description">The description.</param>
public DataPropertyDefinition(string name, string description)
: this()
{
@@ -121,6 +126,11 @@
}
}
+ /// <summary>
+ /// Gets the type of the data.
+ /// </summary>
+ /// <param name="xmlType">Type of the XML.</param>
+ /// <returns></returns>
public static DataPropertyType GetDataType(string xmlType)
{
switch (xmlType)
@@ -163,6 +173,11 @@
}
}
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public override void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var en = Utility.EncodeFDOName(this.Name);
@@ -193,6 +208,11 @@
currentNode.AppendChild(prop);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public override void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
var ro = Utility.GetFdoAttribute(node, "readOnly");
@@ -249,6 +269,9 @@
throw new ArgumentException();
}
+ /// <summary>
+ /// Gets the expression data type
+ /// </summary>
public override ExpressionDataType ExpressionType
{
get { return GetExpressionType(this.DataType); }
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSchema.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSchema.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSchema.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -35,6 +35,11 @@
internal FeatureSchema() { _classes = new List<ClassDefinition>(); }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="FeatureSchema"/> class.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="description">The description.</param>
public FeatureSchema(string name, string description)
: this()
{
@@ -114,6 +119,11 @@
/// <returns></returns>
public ClassDefinition GetItem(int index) { return _classes[index]; }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var schema = doc.CreateElement("xs", "schema", XmlNamespaces.XS);
@@ -132,6 +142,11 @@
currentNode.AppendChild(schema);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
if (!node.Name.Equals("xs:schema"))
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSourceDescription.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSourceDescription.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/FeatureSourceDescription.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -35,6 +35,10 @@
/// </summary>
public class FeatureSourceDescription
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="FeatureSourceDescription"/> class.
+ /// </summary>
+ /// <param name="stream">The stream.</param>
public FeatureSourceDescription(System.IO.Stream stream)
{
List<FeatureSchema> schemas = new List<FeatureSchema>();
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/GeometricPropertyDefinition.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/GeometricPropertyDefinition.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/GeometricPropertyDefinition.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -30,10 +30,25 @@
[Flags]
public enum FeatureGeometricType : int
{
+ /// <summary>
+ /// Points
+ /// </summary>
Point = 1,
+ /// <summary>
+ /// Curves (lines)
+ /// </summary>
Curve = 2,
+ /// <summary>
+ /// Surfaces (polygons)
+ /// </summary>
Surface = 4,
+ /// <summary>
+ /// Solids
+ /// </summary>
Solid = 8,
+ /// <summary>
+ /// All types
+ /// </summary>
All = Curve | Point | Solid | Surface
}
@@ -42,16 +57,49 @@
/// </summary>
public enum SpecificGeometryType
{
+ /// <summary>
+ /// Points
+ /// </summary>
Point = 1,
+ /// <summary>
+ /// Line Strings
+ /// </summary>
LineString = 2,
+ /// <summary>
+ /// Polygons
+ /// </summary>
Polygon = 3,
+ /// <summary>
+ /// Multi Points
+ /// </summary>
MultiPoint = 4,
+ /// <summary>
+ /// Multi Line Strings
+ /// </summary>
MultiLineString = 5,
+ /// <summary>
+ /// Multi Polygons
+ /// </summary>
MultiPolygon = 6,
+ /// <summary>
+ /// Multi Geometries
+ /// </summary>
MultiGeometry = 7,
+ /// <summary>
+ /// Curve Strings
+ /// </summary>
CurveString = 10,
+ /// <summary>
+ /// Curve Polygons
+ /// </summary>
CurvePolygon = 11,
+ /// <summary>
+ /// Multi Curve Strings
+ /// </summary>
MultiCurveString = 12,
+ /// <summary>
+ /// Multi Curve Polygons
+ /// </summary>
MultiCurvePolygon = 13
}
@@ -62,6 +110,11 @@
{
private GeometricPropertyDefinition() { this.SpecificGeometryTypes = new SpecificGeometryType[0]; }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="GeometricPropertyDefinition"/> class.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="description">The description.</param>
public GeometricPropertyDefinition(string name, string description)
: this()
{
@@ -209,6 +262,11 @@
get { return PropertyDefinitionType.Geometry; }
}
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public override void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var en = Utility.EncodeFDOName(this.Name);
@@ -226,6 +284,11 @@
currentNode.AppendChild(geom);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public override void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
var gt = Utility.GetFdoAttribute(node, "geometricTypes");
@@ -245,6 +308,10 @@
this.SpatialContextAssociation = (srs != null ? srs.Value : string.Empty);
}
+ /// <summary>
+ /// Converts the current specified geometry types to a space-delimited list of types
+ /// </summary>
+ /// <returns></returns>
public string GeometryTypesToString()
{
List<string> values = new List<string>();
@@ -386,6 +453,9 @@
throw new ArgumentException();
}
+ /// <summary>
+ /// Gets the expression data type
+ /// </summary>
public override OSGeo.MapGuide.ObjectModels.Common.ExpressionDataType ExpressionType
{
get { return OSGeo.MapGuide.ObjectModels.Common.ExpressionDataType.Geometry; }
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/PropertyDefinition.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/PropertyDefinition.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/PropertyDefinition.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -30,10 +30,25 @@
/// </summary>
public enum PropertyDefinitionType : int
{
+ /// <summary>
+ /// Data Properties
+ /// </summary>
Data = 100,
+ /// <summary>
+ /// Geometric Properties
+ /// </summary>
Geometry = 102,
+ /// <summary>
+ /// Raster Properties
+ /// </summary>
Raster = 104,
+ /// <summary>
+ /// Association Properties
+ /// </summary>
Association = 103,
+ /// <summary>
+ /// Object Properties
+ /// </summary>
Object = 101
}
@@ -42,20 +57,65 @@
/// </summary>
public enum PropertyValueType : int
{
+ /// <summary>
+ /// BLOB
+ /// </summary>
Blob = 10,
+ /// <summary>
+ /// Boolean
+ /// </summary>
Boolean = 1,
+ /// <summary>
+ /// Byte
+ /// </summary>
Byte = 2,
+ /// <summary>
+ /// CLOB
+ /// </summary>
Clob = 11,
+ /// <summary>
+ /// DateTime
+ /// </summary>
DateTime = 3,
+ /// <summary>
+ /// Double
+ /// </summary>
Double = 5,
+ /// <summary>
+ /// Feature
+ /// </summary>
Feature = 12,
+ /// <summary>
+ /// Geometry
+ /// </summary>
Geometry = 13,
+ /// <summary>
+ /// Int16
+ /// </summary>
Int16 = 6,
+ /// <summary>
+ /// Int32
+ /// </summary>
Int32 = 7,
+ /// <summary>
+ /// Int64
+ /// </summary>
Int64 = 8,
+ /// <summary>
+ /// Invalid or Unknown
+ /// </summary>
Null = 0,
+ /// <summary>
+ /// Raster
+ /// </summary>
Raster = 14,
+ /// <summary>
+ /// Single
+ /// </summary>
Single = 4,
+ /// <summary>
+ /// String
+ /// </summary>
String = 9
}
@@ -64,16 +124,49 @@
/// </summary>
public enum DataPropertyType : int
{
+ /// <summary>
+ /// BLOB
+ /// </summary>
Blob = PropertyValueType.Blob,
+ /// <summary>
+ /// Boolean
+ /// </summary>
Boolean = PropertyValueType.Boolean,
+ /// <summary>
+ /// Byte
+ /// </summary>
Byte = PropertyValueType.Byte,
+ /// <summary>
+ /// CLOB
+ /// </summary>
Clob = PropertyValueType.Clob,
+ /// <summary>
+ /// DateTime
+ /// </summary>
DateTime = PropertyValueType.DateTime,
+ /// <summary>
+ /// Double
+ /// </summary>
Double = PropertyValueType.Double,
+ /// <summary>
+ /// Int16
+ /// </summary>
Int16 = PropertyValueType.Int16,
+ /// <summary>
+ /// Int32
+ /// </summary>
Int32 = PropertyValueType.Int32,
+ /// <summary>
+ /// Int64
+ /// </summary>
Int64 = PropertyValueType.Int64,
+ /// <summary>
+ /// Single
+ /// </summary>
Single = PropertyValueType.Single,
+ /// <summary>
+ /// String
+ /// </summary>
String = PropertyValueType.String
}
@@ -92,8 +185,18 @@
/// </summary>
public abstract PropertyDefinitionType Type { get; }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public abstract void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode);
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public abstract void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr);
/// <summary>
@@ -133,6 +236,9 @@
return prop;
}
+ /// <summary>
+ /// Gets the expression data type
+ /// </summary>
public abstract ExpressionDataType ExpressionType
{
get;
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/RasterPropertyDefinition.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/RasterPropertyDefinition.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Schema/RasterPropertyDefinition.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -29,6 +29,11 @@
/// </summary>
public class RasterPropertyDefinition : PropertyDefinition
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RasterPropertyDefinition"/> class.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="description">The description.</param>
public RasterPropertyDefinition(string name, string description)
{
this.Name = name;
@@ -68,6 +73,11 @@
get { return PropertyDefinitionType.Raster; }
}
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public override void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var en = Utility.EncodeFDOName(this.Name);
@@ -82,6 +92,11 @@
currentNode.AppendChild(geom);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public override void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
var dix = Utility.GetFdoAttribute(node, "defaultImageXSize");
@@ -100,6 +115,9 @@
this.SpatialContextAssociation = (srs != null ? srs.Value : string.Empty);
}
+ /// <summary>
+ /// Gets the expression data type
+ /// </summary>
public override OSGeo.MapGuide.ObjectModels.Common.ExpressionDataType ExpressionType
{
get { return OSGeo.MapGuide.ObjectModels.Common.ExpressionDataType.Raster; }
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -31,24 +31,52 @@
/// </summary>
public abstract class ConfigurationDocument : IFdoSerializable
{
+ /// <summary>
+ /// The list of spatial contexts
+ /// </summary>
protected List<IFdoSpatialContext> _spatialContexts;
+ /// <summary>
+ /// The list of logical schemas
+ /// </summary>
protected List<FeatureSchema> _schemas;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ConfigurationDocument"/> class.
+ /// </summary>
protected ConfigurationDocument()
{
_spatialContexts = new List<IFdoSpatialContext>();
_schemas = new List<FeatureSchema>();
}
+ /// <summary>
+ /// Gets the array of spatial contexts.
+ /// </summary>
public IFdoSpatialContext[] SpatialContexts { get { return _spatialContexts.ToArray(); } }
+ /// <summary>
+ /// Gets the array of logical schemas.
+ /// </summary>
public FeatureSchema[] Schemas { get { return _schemas.ToArray(); } }
+ /// <summary>
+ /// Adds the spatial context.
+ /// </summary>
+ /// <param name="context">The context.</param>
public void AddSpatialContext(IFdoSpatialContext context) { _spatialContexts.Add(context); }
+ /// <summary>
+ /// Removes the spatial context.
+ /// </summary>
+ /// <param name="context">The context.</param>
public void RemoveSpatialContext(IFdoSpatialContext context) { _spatialContexts.Remove(context); }
+ /// <summary>
+ /// Gets the spatial context by name
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <returns></returns>
public IFdoSpatialContext GetSpatialContext(string name)
{
foreach (var ctx in _spatialContexts)
@@ -59,6 +87,10 @@
return null;
}
+ /// <summary>
+ /// Gets the array spatial context names.
+ /// </summary>
+ /// <returns></returns>
public string[] GetSpatialContextNames()
{
List<string> names = new List<string>();
@@ -71,10 +103,23 @@
return names.ToArray();
}
+ /// <summary>
+ /// Adds the logical schema.
+ /// </summary>
+ /// <param name="schema">The schema.</param>
public void AddSchema(FeatureSchema schema) { _schemas.Add(schema); }
+ /// <summary>
+ /// Removes the logical schema.
+ /// </summary>
+ /// <param name="schema">The schema.</param>
public void RemoveSchema(FeatureSchema schema) { _schemas.Remove(schema); }
+ /// <summary>
+ /// Gets the schema by name.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <returns></returns>
public FeatureSchema GetSchema(string name)
{
foreach (var fsc in _schemas)
@@ -85,12 +130,23 @@
return null;
}
+ /// <summary>
+ /// Gets the class definition by schema and class names
+ /// </summary>
+ /// <param name="schemaName">Name of the schema.</param>
+ /// <param name="className">Name of the class.</param>
+ /// <returns></returns>
public ClassDefinition GetClass(string schemaName, string className)
{
var fs = GetSchema(schemaName);
return fs.GetClass(className);
}
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var dstore = doc.CreateElement("fdo", "DataStore", XmlNamespaces.FDO);
@@ -113,10 +169,25 @@
currentNode.AppendChild(dstore);
}
+ /// <summary>
+ /// Write this document's schema mappings to the given XML document
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
protected abstract void WriteSchemaMappings(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode);
+ /// <summary>
+ /// Write this document's schema mappings from the given XML document
+ /// </summary>
+ /// <param name="node">The node.</param>
+ /// <param name="mgr">The namespace manager.</param>
protected abstract void ReadSchemaMappings(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr);
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
if (!node.Name.Equals("fdo:DataStore"))
@@ -145,6 +216,10 @@
ReadSchemaMappings(node, mgr);
}
+ /// <summary>
+ /// Returns the XML form of this document
+ /// </summary>
+ /// <returns></returns>
public string ToXml()
{
XmlDocument doc = new XmlDocument();
@@ -152,6 +227,11 @@
return doc.OuterXml;
}
+ /// <summary>
+ /// Creates a configuration document from XML.
+ /// </summary>
+ /// <param name="xml">The XML.</param>
+ /// <returns>The configuration document</returns>
public static ConfigurationDocument LoadXml(string xml)
{
XmlDocument doc = new XmlDocument();
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -92,6 +92,11 @@
/// </summary>
public GdalRasterLocationItem[] RasterLocations { get { return new List<GdalRasterLocationItem>(_items.Values).ToArray(); } }
+ /// <summary>
+ /// Write this document's schema mappings to the given XML document
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
protected override void WriteSchemaMappings(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
foreach (var schema in base._schemas)
@@ -130,6 +135,11 @@
}
}
+ /// <summary>
+ /// Write this document's schema mappings from the given XML document
+ /// </summary>
+ /// <param name="node">The node.</param>
+ /// <param name="mgr">The namespace manager.</param>
protected override void ReadSchemaMappings(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
//XmlNodeList mappings = node.SelectNodes("SchemaMapping");
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -83,6 +83,11 @@
/// </summary>
public GdalRasterItem[] Items { get { return new List<GdalRasterItem>(_items.Values).ToArray(); } }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var loc = doc.CreateElement("Location");
@@ -98,6 +103,11 @@
currentNode.AppendChild(loc);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
if (node.Name != "Location")
@@ -155,6 +165,11 @@
/// </summary>
public double MaxY { get; set; }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var feat = doc.CreateElement("Feature");
@@ -194,6 +209,11 @@
currentNode.AppendChild(feat);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
if (node.Name != "Feature")
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -32,8 +32,16 @@
{
private XmlNode[] _mappings;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="GenericConfigurationDocument"/> class.
+ /// </summary>
public GenericConfigurationDocument() { _mappings = new XmlNode[0]; }
+ /// <summary>
+ /// Write this document's schema mappings to the given XML document
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
protected override void WriteSchemaMappings(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
foreach (var el in _mappings)
@@ -42,6 +50,11 @@
}
}
+ /// <summary>
+ /// Write this document's schema mappings from the given XML document
+ /// </summary>
+ /// <param name="node">The node.</param>
+ /// <param name="mgr">The namespace manager.</param>
protected override void ReadSchemaMappings(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
var children = node.ChildNodes;
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -33,6 +33,9 @@
{
private List<OdbcTableItem> _tables;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="OdbcConfigurationDocument"/> class.
+ /// </summary>
public OdbcConfigurationDocument() { _tables = new List<OdbcTableItem>(); }
/// <summary>
@@ -66,6 +69,11 @@
return items;
}
+ /// <summary>
+ /// Write this document's schema mappings to the given XML document
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
protected override void WriteSchemaMappings(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
foreach (var fs in _schemas)
@@ -89,6 +97,11 @@
}
}
+ /// <summary>
+ /// Write this document's schema mappings from the given XML document
+ /// </summary>
+ /// <param name="node">The node.</param>
+ /// <param name="mgr">The namespace manager.</param>
protected override void ReadSchemaMappings(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
//var mappings = node.SelectNodes("SchemaMapping", mgr);
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -61,6 +61,11 @@
/// </summary>
public string ZColumn { get; set; }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var cls = this.Parent.GetClass(this.SchemaName, this.ClassName);
@@ -114,6 +119,11 @@
}
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
if (!node.Name.Equals("complexType"))
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/RasterWmsItem.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/RasterWmsItem.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/RasterWmsItem.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -28,50 +28,143 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// A WMS Raster configuration element
+ /// </summary>
public class RasterWmsItem : IFdoSerializable
{
+ /// <summary>
+ /// Represents all valid WMS image formats
+ /// </summary>
public class WmsImageFormat
{
+ /// <summary>
+ /// Portable Network Graphics (PNG)
+ /// </summary>
public const string PNG = "PNG";
+ /// <summary>
+ /// Tagged Image File (TIF)
+ /// </summary>
public const string TIF = "TIF";
+ /// <summary>
+ /// Joint Photographic Experts Group (JPEG)
+ /// </summary>
public const string JPG = "JPG";
+ /// <summary>
+ /// Graphics Interchange Format (GIF)
+ /// </summary>
public const string GIF = "GIF";
}
internal RasterWmsItem() { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RasterWmsItem"/> class.
+ /// </summary>
+ /// <param name="className">Name of the class.</param>
+ /// <param name="rasterPropertyName">Name of the raster property.</param>
public RasterWmsItem(string className, string rasterPropertyName)
{
this.FeatureClass = className;
this.RasterPropertyName = rasterPropertyName;
}
+ /// <summary>
+ /// Gets or sets the feature class.
+ /// </summary>
+ /// <value>
+ /// The feature class.
+ /// </value>
public string FeatureClass { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the raster property.
+ /// </summary>
+ /// <value>
+ /// The name of the raster property.
+ /// </value>
public string RasterPropertyName { get; set; }
+ /// <summary>
+ /// Gets or sets the elevation dimension.
+ /// </summary>
+ /// <value>
+ /// The elevation dimension.
+ /// </value>
public string ElevationDimension { get; set; }
+ /// <summary>
+ /// Gets or sets the image format.
+ /// </summary>
+ /// <value>
+ /// The image format.
+ /// </value>
public string ImageFormat { get; set; }
private List<WmsLayerDefinition> _layers = new List<WmsLayerDefinition>();
+ /// <summary>
+ /// Gets the array of WMS layer configuration elements
+ /// </summary>
public WmsLayerDefinition[] Layers { get { return _layers.ToArray(); } }
+ /// <summary>
+ /// Adds a WMS layer configuration element.
+ /// </summary>
+ /// <param name="layer">The layer.</param>
public void AddLayer(WmsLayerDefinition layer) { _layers.Add(layer); }
+ /// <summary>
+ /// Removes the given WMS layer configuration element
+ /// </summary>
+ /// <param name="layer">The layer.</param>
public void RemoveLayer(WmsLayerDefinition layer) { _layers.Remove(layer); }
+ /// <summary>
+ /// Gets or sets a value indicating whether tile caching is used
+ /// </summary>
+ /// <value>
+ /// <c>true</c> if tile caching is used; otherwise, <c>false</c>.
+ /// </value>
public bool UseTileCache { get; set; }
+ /// <summary>
+ /// Gets or sets the time.
+ /// </summary>
+ /// <value>
+ /// The time.
+ /// </value>
public string Time { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the spatial context.
+ /// </summary>
+ /// <value>
+ /// The name of the spatial context.
+ /// </value>
public string SpatialContextName { get; set; }
+ /// <summary>
+ /// Gets or sets a value indicating whether this instance is transparent.
+ /// </summary>
+ /// <value>
+ /// <c>true</c> if this instance is transparent; otherwise, <c>false</c>.
+ /// </value>
public bool IsTransparent { get; set; }
+ /// <summary>
+ /// Gets or sets the color of the background.
+ /// </summary>
+ /// <value>
+ /// The color of the background.
+ /// </value>
public Color BackgroundColor { get; set; }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var rasterDef = doc.CreateElement("RasterDefinition");
@@ -138,6 +231,11 @@
currentNode.AppendChild(rasterDef);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
if (node.Name != "RasterDefinition")
@@ -200,6 +298,9 @@
}
}
+ /// <summary>
+ /// Removes all WMS layer configuration elements
+ /// </summary>
public void RemoveAllLayers()
{
_layers.Clear();
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -48,6 +48,11 @@
/// <param name="item"></param>
public void RemoveRasterItem(RasterWmsItem item) { _rasterItems.Remove(item); }
+ /// <summary>
+ /// Write this document's schema mappings to the given XML document
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
protected override void WriteSchemaMappings(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var map = doc.CreateElement("SchemaMapping");
@@ -70,6 +75,11 @@
currentNode.AppendChild(map);
}
+ /// <summary>
+ /// Write this document's schema mappings from the given XML document
+ /// </summary>
+ /// <param name="node">The node.</param>
+ /// <param name="mgr">The namespace manager.</param>
protected override void ReadSchemaMappings(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
//XmlNodeList mappings = node.SelectNodes("SchemaMapping");
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsLayerDefinition.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsLayerDefinition.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsLayerDefinition.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -24,16 +24,43 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// WMS Layer Definition configuration element
+ /// </summary>
public class WmsLayerDefinition : IFdoSerializable
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="WmsLayerDefinition"/> class.
+ /// </summary>
public WmsLayerDefinition() { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="WmsLayerDefinition"/> class.
+ /// </summary>
+ /// <param name="layerName">Name of the layer.</param>
public WmsLayerDefinition(string layerName) { this.Name = layerName; }
+ /// <summary>
+ /// Gets or sets the name.
+ /// </summary>
+ /// <value>
+ /// The name.
+ /// </value>
public string Name { get; set; }
+ /// <summary>
+ /// Gets or sets the style.
+ /// </summary>
+ /// <value>
+ /// The style.
+ /// </value>
public string Style { get; set; }
+ /// <summary>
+ /// Writes the current element's content
+ /// </summary>
+ /// <param name="doc"></param>
+ /// <param name="currentNode"></param>
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
{
var layer = doc.CreateElement("Layer");
@@ -50,6 +77,11 @@
currentNode.AppendChild(layer);
}
+ /// <summary>
+ /// Set the current element's content from the current XML node
+ /// </summary>
+ /// <param name="node"></param>
+ /// <param name="mgr"></param>
public void ReadXml(System.Xml.XmlNode node, System.Xml.XmlNamespaceManager mgr)
{
if (node.Name != "Layer")
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Utility.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -705,6 +705,13 @@
}
}
+ /// <summary>
+ /// Transforms the envelope.
+ /// </summary>
+ /// <param name="env">The env.</param>
+ /// <param name="srcCsWkt">The source coordinate system WKT.</param>
+ /// <param name="dstCsWkt">The destination coordinate system WKT.</param>
+ /// <returns></returns>
public static OSGeo.MapGuide.ObjectModels.Common.IEnvelope TransformEnvelope(OSGeo.MapGuide.ObjectModels.Common.IEnvelope env, string srcCsWkt, string dstCsWkt)
{
try
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/XmlValidator.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/XmlValidator.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/XmlValidator.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -41,11 +41,17 @@
private List<string> warnings = new List<string>();
private List<string> errors = new List<string>();
+ /// <summary>
+ /// Gets the validation warnings.
+ /// </summary>
public ReadOnlyCollection<string> ValidationWarnings
{
get { return this.warnings.AsReadOnly(); }
}
+ /// <summary>
+ /// Gets the validation errors.
+ /// </summary>
public ReadOnlyCollection<string> ValidationErrors
{
get { return this.errors.AsReadOnly(); }
@@ -108,6 +114,13 @@
return null;
}
+ /// <summary>
+ /// Validates the content of the resource XML.
+ /// </summary>
+ /// <param name="xmlContent">Content of the XML.</param>
+ /// <param name="xsdPath">The XSD path.</param>
+ /// <param name="errors">The errors.</param>
+ /// <param name="warnings">The warnings.</param>
public static void ValidateResourceXmlContent(string xmlContent, string xsdPath, out string[] errors, out string[] warnings)
{
errors = new string[0];
Modified: trunk/Tools/Maestro/Properties/SignedAssemblyInfo.cs
===================================================================
--- trunk/Tools/Maestro/Properties/SignedAssemblyInfo.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Properties/SignedAssemblyInfo.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -17,6 +17,7 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
+#pragma warning disable 1699
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
Modified: trunk/Tools/Maestro/Properties/SignedAssemblyInfo2.cs
===================================================================
--- trunk/Tools/Maestro/Properties/SignedAssemblyInfo2.cs 2011-11-11 02:25:36 UTC (rev 6218)
+++ trunk/Tools/Maestro/Properties/SignedAssemblyInfo2.cs 2011-11-11 13:49:12 UTC (rev 6219)
@@ -17,6 +17,7 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
+#pragma warning disable 1699
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
More information about the mapguide-commits
mailing list