Changeset 5097 for trunk/sources/HeuristicLab.Analysis.Views/3.3/DataTableView.cs

Timestamp:

12/14/10 11:30:55 (13 years ago)

Author:

epitzer

Message:

DataTable, DataRow and DataTableView have been unsealed. (#1338)

A possible persistence problem has also been fixed by directly persisting the visualProperties property otherwise an ArgumentException might break backwards compatibility.

File:

• trunk/sources/HeuristicLab.Analysis.Views/3.3/DataTableView.cs (modified) (7 diffs)

trunk/sources/HeuristicLab.Analysis.Views/3.3/DataTableView.cs

@@ -36 +36 @@
   [View("DataTable View")]
   [Content(typeof(DataTable), true)]
-  public sealed partial class DataTableView : NamedItemView {
-    private List<Series> invisibleSeries;
-    private Dictionary<IObservableList<double>, DataRow> valuesRowsTable;
+  public partial class DataTableView : NamedItemView {
+    protected List<Series> invisibleSeries;
+    protected Dictionary<IObservableList<double>, DataRow> valuesRowsTable;
     /// <summary>
     /// Gets or sets the variable to represent visually.
@@ -113 +113 @@
     }
 
-    private void AddDataRow(DataRow row) {
+
+    /// <summary>
+    /// Add the DataRow as a series to the chart.
+    /// </summary>
+    /// <param name="row">DataRow to add as series to the chart.</param>
+    protected virtual void AddDataRow(DataRow row) {
       Series series = new Series(row.Name);
       switch (row.VisualProperties.ChartType) {
@@ -141 +146 @@
     }
 
-    private void UpdateYCursorInterval() {
+
+    /// <summary>
+    /// Set the Y Cursor interval to visible points of enabled series.
+    /// </summary>
+    protected virtual void UpdateYCursorInterval() {
       double interestingValuesRange = (from series in chart.Series
                                        where series.Enabled
@@ -159 +168 @@
     }
 
-    private void RemoveDataRow(DataRow row) {
+
+    /// <summary>
+    /// Remove the corresponding series for a certain DataRow.
+    /// </summary>
+    /// <param name="row">DataRow which series should be removed.</param>
+    protected virtual void RemoveDataRow(DataRow row) {
       Series series = chart.Series[row.Name];
       chart.Series.Remove(series);
@@ -168 +182 @@
 
     #region Content Events
-    private void RegisterDataRowEvents(DataRow row) {
+    /// <summary>
+    /// Automatically called for every existing data row and whenever a data row is added
+    /// to the data table. Do not call this method directly.
+    /// </summary>
+    /// <param name="row">The DataRow that was added.</param>
+    protected virtual void RegisterDataRowEvents(DataRow row) {
       row.NameChanged += new EventHandler(Row_NameChanged);
       row.VisualPropertiesChanged += new EventHandler(Row_VisualPropertiesChanged);
@@ -178 +197 @@
       row.Values.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_CollectionReset);
     }
-    private void DeregisterDataRowEvents(DataRow row) {
+
+    /// <summary>
+    /// Automatically called for every data row that is removed from the DataTable. Do
+    /// not directly call this method.
+    /// </summary>
+    /// <param name="row">The DataRow that was removed.</param>
+    protected virtual void DeregisterDataRowEvents(DataRow row) {
       row.Values.ItemsAdded -= new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsAdded);
       row.Values.ItemsRemoved -= new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsRemoved);
@@ -436 +461 @@
     #endregion
 
-    private bool IsInvalidValue(double x) {
+
+    /// <summary>
+    /// Determines whether a double value can be displayed (converted to Decimal and not an NaN).
+    /// </summary>
+    /// <param name="x">The number to check.</param>
+    /// <returns><code>true</code> if the value can be safely shwon in the chart,
+    /// <code>false</code> otherwise.</returns>
+    protected static bool IsInvalidValue(double x) {
       return double.IsNaN(x) || x < (double)decimal.MinValue || x > (double)decimal.MaxValue;
     }