Dont want to do that again --- MySQL interface is now fully documented. Added little bit more documentation to the MSSQL interface.

1 files changed, 54 insertions, 1 deletions

diff --git a/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLGridData.cs b/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLGridData.cs
index e047c6d..5c2e567 100644
--- a/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLGridData.cs
+++ b/OpenGridServices/OpenGrid.Framework.Data.MySQL/MySQLGridData.cs
@@ -1,3 +1,29 @@
+/*

+* Copyright (c) OpenSim project, http://sim.opensecondlife.org/

+*

+* Redistribution and use in source and binary forms, with or without

+* modification, are permitted provided that the following conditions are met:

+*     * Redistributions of source code must retain the above copyright

+*       notice, this list of conditions and the following disclaimer.

+*     * Redistributions in binary form must reproduce the above copyright

+*       notice, this list of conditions and the following disclaimer in the

+*       documentation and/or other materials provided with the distribution.

+*     * Neither the name of the <organization> nor the

+*       names of its contributors may be used to endorse or promote products

+*       derived from this software without specific prior written permission.

+*

+* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY

+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

+* DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY

+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+* 

+*/

 using System;

 using System.Collections.Generic;

 using System.Text;

@@ -5,8 +31,14 @@ using OpenGrid.Framework.Data;
 

 namespace OpenGrid.Framework.Data.MySQL

 {

+    /// <summary>

+    /// A MySQL Interface for the Grid Server

+    /// </summary>

     public class MySQLGridData : IGridData

     {

+        /// <summary>

+        /// MySQL Database Manager

+        /// </summary>

         private MySQLManager database;

 

         /// <summary>

@@ -33,16 +65,32 @@ namespace OpenGrid.Framework.Data.MySQL
             database.Close();

         }

 

+        /// <summary>

+        /// Returns the plugin name

+        /// </summary>

+        /// <returns>Plugin name</returns>

         public string getName()

         {

             return "MySql OpenGridData";

         }

 

+        /// <summary>

+        /// Returns the plugin version

+        /// </summary>

+        /// <returns>Plugin version</returns>

         public string getVersion()

         {

             return "0.1";

         }

 

+        /// <summary>

+        /// Returns all the specified region profiles within coordates -- coordinates are inclusive

+        /// </summary>

+        /// <param name="xmin">Minimum X coordinate</param>

+        /// <param name="ymin">Minimum Y coordinate</param>

+        /// <param name="xmax">Maximum X coordinate</param>

+        /// <param name="ymax">Maximum Y coordinate</param>

+        /// <returns></returns>

         public SimProfileData[] GetProfilesInRange(uint xmin, uint ymin, uint xmax, uint ymax)

         {

             try

@@ -145,11 +193,16 @@ namespace OpenGrid.Framework.Data.MySQL
             }

         }

 

+        /// <summary>

+        /// Adds a new profile to the database

+        /// </summary>

+        /// <param name="profile">The profile to add</param>

+        /// <returns>Successful?</returns>

         public DataResponse AddProfile(SimProfileData profile)

         {

             lock (database)

             {

-                if (database.insertRow(profile))

+                if (database.insertRegion(profile))

                 {

                     return DataResponse.RESPONSE_OK;

                 }