diff options
Diffstat (limited to 'Software/Visual_Studio/Tango.Synchronization/Local')
5 files changed, 29 insertions, 0 deletions
diff --git a/Software/Visual_Studio/Tango.Synchronization/Local/Constants.cs b/Software/Visual_Studio/Tango.Synchronization/Local/Constants.cs index a1494243c..c5e974be3 100644 --- a/Software/Visual_Studio/Tango.Synchronization/Local/Constants.cs +++ b/Software/Visual_Studio/Tango.Synchronization/Local/Constants.cs @@ -6,6 +6,9 @@ using System.Threading.Tasks; namespace Tango.Synchronization.Local { + /// <summary> + /// Contains Tango database synchronization convention constants. + /// </summary> internal static class Constants { //SQLite Internal Constants diff --git a/Software/Visual_Studio/Tango.Synchronization/Local/ExtensionMethods.cs b/Software/Visual_Studio/Tango.Synchronization/Local/ExtensionMethods.cs index 89b3969e4..f2e0e9b00 100644 --- a/Software/Visual_Studio/Tango.Synchronization/Local/ExtensionMethods.cs +++ b/Software/Visual_Studio/Tango.Synchronization/Local/ExtensionMethods.cs @@ -8,6 +8,9 @@ using System.Threading.Tasks; namespace Tango.Synchronization.Local { + /// <summary> + /// Contains Database comparison and synchronization extension methods. + /// </summary> internal static class SQLExtensions { /// <summary> diff --git a/Software/Visual_Studio/Tango.Synchronization/Local/ILocalDataBase.cs b/Software/Visual_Studio/Tango.Synchronization/Local/ILocalDataBase.cs index 66b111467..a435bea97 100644 --- a/Software/Visual_Studio/Tango.Synchronization/Local/ILocalDataBase.cs +++ b/Software/Visual_Studio/Tango.Synchronization/Local/ILocalDataBase.cs @@ -101,5 +101,10 @@ namespace Tango.Synchronization.Local /// <param name="row">The row.</param> /// <returns></returns> String GetUpdateRowCommand(DataTable table, DataRow row); + + /// <summary> + /// Clears the data base. + /// </summary> + void ClearDataBase(); } } diff --git a/Software/Visual_Studio/Tango.Synchronization/Local/LocalDBSynchronizer.cs b/Software/Visual_Studio/Tango.Synchronization/Local/LocalDBSynchronizer.cs index c7b6900d6..7e654c161 100644 --- a/Software/Visual_Studio/Tango.Synchronization/Local/LocalDBSynchronizer.cs +++ b/Software/Visual_Studio/Tango.Synchronization/Local/LocalDBSynchronizer.cs @@ -6,8 +6,17 @@ using System.Threading.Tasks; namespace Tango.Synchronization.Local { + /// <summary> + /// Represents an SQLite to SQLite file synchronizer. + /// </summary> public class LocalDBSynchronizer { + /// <summary> + /// Synchronizes the specified master and slave SQLite files. + /// </summary> + /// <param name="masterSQLiteFile">The master SQLite file.</param> + /// <param name="slaveSQLiteFile">The slave SQLite file.</param> + /// <returns></returns> public static List<Diff> Synchronize(String masterSQLiteFile, String slaveSQLiteFile) { using (LocalDBComparer comparer = new LocalDBComparer(new SQLiteDataBase(masterSQLiteFile), new SQLiteDataBase(slaveSQLiteFile))) @@ -22,6 +31,12 @@ namespace Tango.Synchronization.Local } } + /// <summary> + /// Synchronizes the specified master and slave SQLite files asynchronously. + /// </summary> + /// <param name="masterSQLiteFile">The master SQLite file.</param> + /// <param name="slaveSQLiteFile">The slave SQLite file.</param> + /// <returns></returns> public static Task<List<Diff>> SynchronizeAsync(String masterSQLiteFile, String slaveSQLiteFile) { return Task.Factory.StartNew<List<Diff>>(() => { return Synchronize(masterSQLiteFile, slaveSQLiteFile); }); diff --git a/Software/Visual_Studio/Tango.Synchronization/Local/SqliteDataBase.cs b/Software/Visual_Studio/Tango.Synchronization/Local/SqliteDataBase.cs index 2596853c6..8e2656a98 100644 --- a/Software/Visual_Studio/Tango.Synchronization/Local/SqliteDataBase.cs +++ b/Software/Visual_Studio/Tango.Synchronization/Local/SqliteDataBase.cs @@ -100,6 +100,9 @@ namespace Tango.Synchronization.Local return table; } + /// <summary> + /// Clears the data base. + /// </summary> public void ClearDataBase() { foreach (var table in Tables) |