Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Data/BoolArrayDataView.cs @ 1065

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

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

File size: 3.3 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="BoolArrayData"/>,
33  /// symbolizing an array of boolean values.
34  /// </summary>
35  public partial class BoolArrayDataView : ArrayDataBaseView {
36    /// <summary>
37    /// Gets or sets the instance of the boolean array to represent visually.
38    /// </summary>
39    /// <remarks>Uses property <see cref="ArrayDataBase"/> of
40    /// base class <see cref="ArrayDataBaseView"/>. No own data storage present.</remarks>
41    public BoolArrayData BoolArrayData {
42      get { return (BoolArrayData)base.ArrayDataBase; }
43      set { base.ArrayDataBase = value; }
44    }
45
46    /// <summary>
47    /// Initializes a new instance of the class <see cref="BoolArrayDataView"/>.
48    /// </summary>
49    public BoolArrayDataView() {
50      InitializeComponent();
51    }
52    /// <summary>
53    /// Initializes a new instance of the class <see cref="BoolArrayDataView"/>
54    /// with the given <paramref name="boolArrayData"/>.
55    /// <note type="caution"> No CopyConstructor! <paramref name="boolArrayData"/> is not copied!</note>
56    /// </summary>
57    /// <param name="boolArrayData">The boolean array to represent visually.</param>
58    public BoolArrayDataView(BoolArrayData boolArrayData)
59      : this() {
60      BoolArrayData = boolArrayData;
61    }
62
63    /// <summary>
64    /// Sets the element on position <paramref name="index"/> to the
65    /// given <paramref name="element"/> as boolean value.
66    /// </summary>
67    /// <param name="index">The position where to substitute the element.</param>
68    /// <param name="element">The element to insert.</param>
69    protected override void SetArrayElement(int index, string element) {
70      bool result;
71      bool.TryParse(element, out result);
72
73      BoolArrayData.Data[index] = result;
74    }
75
76    /// <summary>
77    /// Checks whether the given <paramref name="element"/> can be converted to a boolean value.
78    /// </summary>
79    /// <param name="element">The data to validate.</param>
80    /// <returns><c>true</c> if the <paramref name="element"/> could be converted,
81    /// <c>false</c> otherwise.</returns>
82    protected override bool ValidateData(string element) {
83      bool result;
84      return element != null && bool.TryParse(element, out result);
85    }
86  }
87}
Note: See TracBrowser for help on using the repository browser.