Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Operator Architecture Refactoring/HeuristicLab.Data/DoubleArrayDataView.cs @ 1982

Last change on this file since 1982 was 737, checked in by vdorfer, 16 years ago

Created API documentation for HeuristLab.Data namespace (#331)

File size: 3.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.ComponentModel;
25using System.Drawing;
26using System.Data;
27using System.Text;
28using System.Windows.Forms;
29
30namespace HeuristicLab.Data {
31  /// <summary>
32  /// The visual representation of the class <see cref="DoubleArrayData"/>,
33  /// symbolizing an array of double values.
34  /// </summary>
35  public partial class DoubleArrayDataView : ArrayDataBaseView {
36    /// <summary>
37    /// Gets or sets the double array to represent as <see cref="DoubleArrayData"/>.
38    /// </summary>
39    /// <remarks>Uses property <see cref="ArrayDataBase"/> of
40    /// base class <see cref="ArrayDataBaseView"/>. No own data storage present.</remarks>
41    public DoubleArrayData DoubleArrayData {
42      get { return (DoubleArrayData)base.ArrayDataBase; }
43      set { base.ArrayDataBase = value; }
44    }
45
46    /// <summary>
47    /// Initializes a new instance of the class <see cref="DoubleArrayDataView"/>.
48    /// </summary>
49    public DoubleArrayDataView() {
50      InitializeComponent();
51      // round-trip format for all cells
52      dataGridView.DefaultCellStyle.Format = "r";
53    }
54    /// <summary>
55    /// Initializes a new instance of the class <see cref="DoubleArrayDataView"/> with the given
56    /// <paramref name="doubleArrayData"/>.
57    /// <note type="caution"> No CopyConstructor! <paramref name="doubleArrayData"/> is not copied!</note>
58    /// </summary>
59    /// <param name="doubleArrayData">The double array to represent visually.</param>
60    public DoubleArrayDataView(DoubleArrayData doubleArrayData)
61      : this() {
62      DoubleArrayData = doubleArrayData;
63    }
64
65    /// <summary>
66    /// Sets the element on position <paramref name="index"/> to the
67    /// given <paramref name="element"/> as double value.
68    /// </summary>
69    /// <param name="index">The position where to substitute the element.</param>
70    /// <param name="element">The element to insert.</param>
71    protected override void SetArrayElement(int index, string element) {
72      double result;
73      double.TryParse(element, out result);
74
75      DoubleArrayData.Data[index] = result;
76    }
77
78    /// <summary>
79    /// Checks whether the given <paramref name="element"/> can be converted to a double value.
80    /// </summary>
81    /// <param name="element">The data to validate.</param>
82    /// <returns><c>true</c> if the <paramref name="element"/> could be converted,
83    /// <c>false</c> otherwise.</returns>
84    protected override bool ValidateData(string element) {
85      double result;
86      return element != null && double.TryParse(element, out result);
87    }
88  }
89}
Note: See TracBrowser for help on using the repository browser.