docs

Author: jackbrookes

Assets/UXF/Scripts/Etc/UXFDataTable.cs

@@ -12,6 +12,11 @@ public class UXFDataTable
         public string[] Headers { get { return dict.Keys.ToArray(); } }
         private Dictionary<string, List<object>> dict;
 
+        /// <summary>
+        /// Construct a table with given estimated row capacity and column names.
+        /// </summary>
+        /// <param name="capacity"></param>
+        /// <param name="columnNames"></param>
         public UXFDataTable(int capacity, params string[] columnNames)
         {
             dict = new Dictionary<string, List<object>>();
@@ -21,6 +26,10 @@ public UXFDataTable(int capacity, params string[] columnNames)
             }
         }
 
+        /// <summary>
+        /// Construct a table with given column names.
+        /// </summary>
+        /// <param name="columnNames"></param>
         public UXFDataTable(params string[] columnNames)
         {
             dict = new Dictionary<string, List<object>>();
@@ -30,6 +39,10 @@ public UXFDataTable(params string[] columnNames)
             }
         }
 
+        /// <summary>
+        /// Add a complete row to the table
+        /// </summary>
+        /// <param name="newRow"></param>
         public void AddCompleteRow(UXFDataRow newRow)
         {
             bool sameKeys = (dict
@@ -59,6 +72,10 @@ public void AddCompleteRow(UXFDataRow newRow)
             }
         }
 
+        /// <summary>
+        /// Count and return the number of rows.
+        /// </summary>
+        /// <returns></returns>
         public int CountRows()
         {
             string[] keyArray = dict.Keys.ToArray();
@@ -67,6 +84,10 @@ public int CountRows()
             return dict[keyArray[0]].Count();
         }
 
+        /// <summary>
+        /// Return the table as a set of strings, each string a line a row with comma-seperated values.
+        /// </summary>
+        /// <returns></returns>
         public string[] GetCSVLines()
         {
             string[] headers = Headers;
@@ -83,6 +104,10 @@ public string[] GetCSVLines()
             return lines;
         }
 
+        /// <summary>
+        /// Return the table as a dictionary of lists.
+        /// </summary>
+        /// <returns></returns>
         public Dictionary<string, List<object>> GetAsDictOfList()
         {
             Dictionary<string, List<object>> dictCopy = new Dictionary<string, List<object>>();
@@ -93,6 +118,10 @@ public Dictionary<string, List<object>> GetAsDictOfList()
             return dictCopy;
         }
 
+        /// <summary>
+        /// Return the table as a list of dictionaries.
+        /// </summary>
+        /// <returns></returns>
         public List<Dictionary<string, object>> GetAsListOfDict()
         {
             int numRows = CountRows();