Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/OperatorBaseView.cs @ 1307

Last change on this file since 1307 was 776, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Core namespace (#331)

File size: 3.5 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.Core {
31  /// <summary>
32  /// The base class for visual representation of operators (contains description view, variable view,
33  /// variable info view,...).
34  /// </summary>
35  public partial class OperatorBaseView : ViewBase {
36    /// <summary>
37    /// Gets or sets the operator to represent visually.
38    /// </summary>
39    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
40    /// No own data storage present.</remarks>
41    public IOperator Operator {
42      get { return (IOperator)Item; }
43      set {base.Item = value; }
44    }
45
46    /// <summary>
47    /// Initializes a new instance of <see cref="OperatorBaseView"/> with caption "Operator".
48    /// </summary>
49    public OperatorBaseView() {
50      InitializeComponent();
51      Caption = "Operator";
52    }
53    /// <summary>
54    /// Initializes a new instance of <see cref="OperatorBaseView"/>
55    /// with the given operator <paramref name="op"/>.
56    /// </summary>
57    /// <remarks>Calls <see cref="OperatorBaseView()"/>.</remarks>
58    /// <param name="op">The operator to represent visually.</param>
59    public OperatorBaseView(IOperator op)
60      : this() {
61      Operator = op;
62    }
63
64    /// <summary>
65    /// Removes event handlers in all children.
66    /// </summary>
67    protected override void RemoveItemEvents() {
68      operatorBaseVariableInfosView.Operator = null;
69      operatorBaseVariablesView.Operator = null;
70      constrainedItemBaseView.ConstrainedItem = null;
71      operatorBaseDescriptionView.Operator = null;
72      base.RemoveItemEvents();
73    }
74    /// <summary>
75    /// Adds event handlers in all children.
76    /// </summary>
77    protected override void AddItemEvents() {
78      base.AddItemEvents();
79      operatorBaseVariableInfosView.Operator = Operator;
80      operatorBaseVariablesView.Operator = Operator;
81      constrainedItemBaseView.ConstrainedItem = Operator;
82      operatorBaseDescriptionView.Operator = Operator;
83    }
84
85    /// <summary>
86    /// Updates all controls with the latest data of the model.
87    /// </summary>
88    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class <see cref="ViewBase"/>.</remarks>
89    protected override void UpdateControls() {
90      base.UpdateControls();
91      if (Operator == null) {
92        Caption = "Operator";
93        tabControl.Enabled = false;
94      } else {
95        Caption = Operator.Name + " (" + Operator.GetType().Name + ")";
96        tabControl.Enabled = true;
97      }
98    }
99  }
100}
Note: See TracBrowser for help on using the repository browser.