Changeset 1167


Ignore:
Timestamp:
01/22/09 12:06:29 (12 years ago)
Author:
vdorfer
Message:

Created API documentation for HeuristicLab.Operators.Metaprogramming and HeuristicLab.Logging namespace and changed a comment in HeuristicLab.Core namespace(#331)

Location:
trunk/sources
Files:
20 edited

Legend:

Unmodified
Added
Removed
  • trunk/sources/HeuristicLab.Core/ConstrainedItemBase.cs

    r776 r1167  
    115115    /// to represent the current instance visually.
    116116    /// </summary>
    117     /// <returns>The created view as <see cref="ConstrainedItemBase"/>.</returns>
     117    /// <returns>The created view as <see cref="ConstrainedItemBaseView"/>.</returns>
    118118    public override IView CreateView() {
    119119      return new ConstrainedItemBaseView(this);
     
    168168    }
    169169    /// <summary>
    170     ///  Loads the persisted item from the specified <paramref name="node"/>.
     170    /// Loads the persisted item from the specified <paramref name="node"/>.
    171171    /// </summary>
    172172    /// <remarks>See <see cref="GetXmlNode"/> to get information about how the constrained item must
  • trunk/sources/HeuristicLab.Logging/BestAverageWorstQualityCalculator.cs

    r77 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Captures the best, the average and the worst quality of the current population.
     32  /// </summary>
    3033  public class BestAverageWorstQualityCalculator : OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return @"TODO\r\nOperator description still missing ..."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="BestAverageWorstQualityCalculator"/> with five variable
     41    /// infos (<c>Quality</c>, <c>Maximization</c>, <c>BestQuality</c>, <c>AverageQuality</c>
     42    /// and <c>WorstQuality</c>).
     43    /// </summary>
    3544    public BestAverageWorstQualityCalculator()
    3645      : base() {
     
    4251    }
    4352
     53    /// <summary>
     54    /// Captures the best, the average and the worst quality of the current population.
     55    /// </summary>
     56    /// <param name="scope">The scope whose population to test and where to inject the captured values.</param>
     57    /// <returns><c>null</c>.</returns>
    4458    public override IOperation Apply(IScope scope) {
    4559      double[] qualities = new double[scope.SubScopes.Count];
  • trunk/sources/HeuristicLab.Logging/BestSolutionStorer.cs

    r368 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Keeps a variable in the global scope that contains the scope representing the best solution.
     32  /// </summary>
    3033  public class BestSolutionStorer : DelegatingOperator {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return @"Keeps a variable in the global scope that contains the scope representing the best of run solution."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="BestSolutionStorer"/> with three variable infos
     41    /// (<c>Quality</c>, <c>Maximization</c> and <c>BestSolution</c>).
     42    /// </summary>
    3543    public BestSolutionStorer()
    3644      : base() {
     
    4048    }
    4149
     50    /// <summary>
     51    /// Keeps a variable in the global scope that contains the scope representing the best solution.
     52    /// </summary>
     53    /// <param name="scope">The scope whose populations to check for the best solution.</param>
     54    /// <returns><c>null</c>.</returns>
    4255    public override IOperation Apply(IScope scope) {
    4356      if(scope.GetVariable(Guid.ToString() + "-Active") == null) {
  • trunk/sources/HeuristicLab.Logging/HeuristicLabLoggingPlugin.cs

    r582 r1167  
    2626
    2727namespace HeuristicLab.Logging {
     28  /// <summary>
     29  /// Plugin class for HeuristicLab.Logging plugin.
     30  /// </summary>
    2831  [ClassInfo(Name = "HeuristicLab.Logging-3.2")]
    2932  [PluginFile(Filename = "HeuristicLab.Logging-3.2.dll", Filetype = PluginFileType.Assembly)]
  • trunk/sources/HeuristicLab.Logging/Linechart.cs

    r2 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Class to represent a Linechart.
     32  /// </summary>
    3033  public class Linechart : ItemBase, IVisualizationItem {
    3134    private IntData myNumberOfLines;
     35    /// <summary>
     36    /// Gets or sets the number of lines of the current instance.
     37    /// </summary>
     38    /// <remarks>Calls <see cref="OnNumberOfLinesChanged"/> in the setter.</remarks>
    3239    public int NumberOfLines {
    3340      get { return myNumberOfLines.Data; }
     
    4047    }
    4148    private ItemList myValues;
     49    /// <summary>
     50    /// Gets or sets the values of the current instance.
     51    /// </summary>
     52    /// <remarks>Calls <see cref="OnValuesChanged"/> in the setter.</remarks>
    4253    public ItemList Values {
    4354      get { return myValues; }
     
    5162
    5263
     64    /// <summary>
     65    /// Initializes a new instance of <see cref="Linechart"/>.
     66    /// </summary>
    5367    public Linechart() {
    5468      myNumberOfLines = new IntData(0);
    5569    }
     70    /// <summary>
     71    /// Initializes a new instance of <see cref="Linechart"/> with the given <paramref name="numberOfLines"/>
     72    /// and the given <paramref name="values"/>.
     73    /// </summary>
     74    /// <param name="numberOfLines">The number of lines with which to initialize the current instance.</param>
     75    /// <param name="values">The values with which to initialize the current instance.</param>
    5676    public Linechart(int numberOfLines, ItemList values) {
    5777      myNumberOfLines = new IntData(numberOfLines);
     
    5979    }
    6080
    61 
     81    /// <summary>
     82    /// Clones the current instance (deep clone).
     83    /// </summary>
     84    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class
     85    /// <see cref="Auxiliary"/>.</remarks>
     86    /// <param name="clonedObjects">Dictionary of all already clone objects. (Needed to avoid cycles.)</param>
     87    /// <returns>The cloned object as <see cref="Linechart"/>.</returns>
    6288    public override object Clone(IDictionary<Guid, object> clonedObjects) {
    6389      Linechart clone = (Linechart)base.Clone(clonedObjects);
     
    6793    }
    6894
     95    /// <summary>
     96    /// Creates an instance of <see cref="LinechartView"/> to represent the current instance visually.
     97    /// </summary>
     98    /// <returns>The created view as <see cref="LinechartView"/>.</returns>
    6999    public override IView CreateView() {
    70100      return new LinechartView(this);
    71101    }
    72102
     103    /// <summary>
     104    /// Occurs when the number of lines has been changed.
     105    /// </summary>
    73106    public event EventHandler NumberOfLinesChanged;
     107    /// <summary>
     108    /// Fires a new <c>NumberOfLinesChanged</c> event.
     109    /// </summary>
    74110    protected virtual void OnNumberOfLinesChanged() {
    75111      if (NumberOfLinesChanged != null)
    76112        NumberOfLinesChanged(this, new EventArgs());
    77113    }
     114    /// <summary>
     115    /// Occurs when the values have been changed.
     116    /// </summary>
    78117    public event EventHandler ValuesChanged;
     118    /// <summary>
     119    /// Fires a new <c>ValuesChanged</c> event.
     120    /// </summary>
    79121    protected virtual void OnValuesChanged() {
    80122      if (ValuesChanged != null)
     
    83125
    84126    #region Persistence Methods
     127    /// <summary>
     128    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
     129    /// </summary>
     130    /// <remarks>The number of lines and the values are saved as child nodes with tag
     131    /// name <c>NumberOfLines</c> and <c>Values</c> respectively.</remarks>
     132    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
     133    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
     134    /// <param name="persistedObjects">The dictionary of all already persisted objects.
     135    /// (Needed to avoid cycles.)</param>
     136    /// <returns>The saved <see cref="XmlNode"/>.</returns>
    85137    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) {
    86138      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
     
    89141      return node;
    90142    }
     143    /// <summary>
     144    /// Loads the persisted item from the specified <paramref name="node"/>.
     145    /// </summary>
     146    /// <remarks>Has to be saved in a special way, see <see cref="GetXmlNode"/> for further information.</remarks>
     147    /// <param name="node">The <see cref="XmlNode"/> where the Linechart is saved.</param>
     148    /// <param name="restoredObjects">The dictionary of all already restored objects.
     149    /// (Needed to avoid cycles.)</param>
    91150    public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) {
    92151      base.Populate(node, restoredObjects);
  • trunk/sources/HeuristicLab.Logging/LinechartInjector.cs

    r77 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Injects a new Linechart into the current scope.
     32  /// </summary>
    3033  public class LinechartInjector : OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return @"TODO\r\nOperator description still missing ..."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="LinechartInjector"/> with three variable infos
     41    /// (<c>NumberOfLines</c>, <c>Values</c> and <c>Linechart</c>).
     42    /// </summary>
    3543    public LinechartInjector() {
    3644      VariableInfo numberOfLinesInfo = new VariableInfo("NumberOfLines", "Number of lines the linechart consists of", typeof(IntData), VariableKind.In);
     
    4250    }
    4351
     52    /// <summary>
     53    /// Injects a new Linechart variable into the given <paramref name="scope"/>.
     54    /// </summary>
     55    /// <param name="scope">The current scope where to inject the Linechart variable.</param>
     56    /// <returns><c>null</c>.</returns>
    4457    public override IOperation Apply(IScope scope) {
    4558      int numberOfLines = GetVariableValue<IntData>("NumberOfLines", scope, true).Data;
  • trunk/sources/HeuristicLab.Logging/LinechartView.cs

    r926 r1167  
    3333
    3434namespace HeuristicLab.Logging {
     35  /// <summary>
     36  /// The visual representation of a <see cref="Linechart"/>.
     37  /// </summary>
    3538  public partial class LinechartView : ViewBase {
    3639    private double maxY = double.MinValue, minY = double.MaxValue;
     
    5053    };
    5154
     55    /// <summary>
     56    /// Gets or sets the Linechart object to represent visually.
     57    /// </summary>
     58    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
     59    /// No own data storage present.</remarks>
    5260    public Linechart Linechart {
    5361      get { return (Linechart)base.Item; }
     
    5563    }
    5664
     65    /// <summary>
     66    /// Initializes a new instance of <see cref="LinechartView"/>.
     67    /// </summary>
    5768    public LinechartView() {
    5869      InitializeComponent();
    5970      Caption = "Linechart View";
    6071    }
     72    /// <summary>
     73    /// Initializes a new instance of <see cref="LinechartView"/> with the given <paramref name="linechart"/>.
     74    /// </summary>
     75    /// <param name="linechart">The linechart to represent visually.</param>
    6176    public LinechartView(Linechart linechart)
    6277      : this() {
     
    6479    }
    6580
     81    /// <summary>
     82    /// Removes the event handlers from the underlying <see cref="Linechart"/>.
     83    /// </summary>
     84    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
    6685    protected override void RemoveItemEvents() {
    6786      if(Linechart != null) {
     
    7190      base.RemoveItemEvents();
    7291    }
     92    /// <summary>
     93    /// Adds event handlers to the underlying <see cref="Linechart"/>.
     94    /// </summary>
     95    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
    7396    protected override void AddItemEvents() {
    7497      base.AddItemEvents();
     
    79102    }
    80103
     104    /// <summary>
     105    /// Updates all controls with the latest data of the model.
     106    /// </summary>
     107    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class <see cref="UpdateControls"/>.</remarks>
    81108    protected override void UpdateControls() {
    82109      base.UpdateControls();
  • trunk/sources/HeuristicLab.Logging/Log.cs

    r2 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Represents a log object where to store a specific value that should be logged.
     32  /// </summary>
    3033  public class Log : ItemBase, IVisualizationItem {
    3134    private ItemList myItems;
     35    /// <summary>
     36    /// Gets or sets the items of the current instance.
     37    /// </summary>
    3238    public ItemList Items {
    3339      get { return myItems; }
     
    3642
    3743
     44    /// <summary>
     45    /// Initializes a new instance of <see cref="Log"/>.
     46    /// </summary>
    3847    public Log() { }
     48    /// <summary>
     49    /// Initializes a new instance of <see cref="Log"/> with the given items.
     50    /// </summary>
     51    /// <param name="items">The list of items with which to initialize the current instance.</param>
    3952    public Log(ItemList items) {
    4053      myItems = items;
    4154    }
    4255
    43 
     56    /// <summary>
     57    /// Clones the current instance (deep clone).
     58    /// </summary>
     59    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class
     60    /// <see cref="Auxiliary"/>.</remarks>
     61    /// <param name="clonedObjects">Dictionary of all already clone objects. (Needed to avoid cycles.)</param>
     62    /// <returns>The cloned object as <see cref="Log"/>.</returns>
    4463    public override object Clone(IDictionary<Guid, object> clonedObjects) {
    4564      Log clone = (Log)base.Clone(clonedObjects);
     
    4867    }
    4968
     69    /// <summary>
     70    /// Creates an instance of <see cref="LogView"/> to represent the current instance visually.
     71    /// </summary>
     72    /// <returns>The created view as <see cref="LogView"/>.</returns>
    5073    public override IView CreateView() {
    5174      return new LogView(this);
    5275    }
    5376
     77    /// <summary>
     78    /// Occurs when the items have been changed.
     79    /// </summary>
    5480    public event EventHandler ItemsChanged;
     81    /// <summary>
     82    /// Fires a new <c>ItemsChanged</c> event.
     83    /// </summary>
    5584    protected virtual void OnItemsChanged() {
    5685      if (ItemsChanged != null)
     
    5988
    6089    #region Persistence Methods
     90    /// <summary>
     91    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
     92    /// </summary>
     93    /// <remarks>The items of the current instance are saved as a child node with the tag name
     94    /// <c>Items</c>.</remarks>
     95    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
     96    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
     97    /// <param name="persistedObjects">The dictionary of all already persisted objects.
     98    /// (Needed to avoid cycles.)</param>
     99    /// <returns>The saved <see cref="XmlNode"/>.</returns>
    61100    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) {
    62101      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
     
    64103      return node;
    65104    }
     105    /// <summary>
     106    /// Loads the persisted item from the specified <paramref name="node"/>.
     107    /// </summary>
     108    /// <remarks>Has to be saved in a special way, see <see cref="GetXmlNode"/> for further information.</remarks>
     109    /// <param name="node">The <see cref="XmlNode"/> where the Log is saved.</param>
     110    /// <param name="restoredObjects">The dictionary of all already restored objects.
     111    /// (Needed to avoid cycles.)</param>
    66112    public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) {
    67113      base.Populate(node, restoredObjects);
  • trunk/sources/HeuristicLab.Logging/LogView.cs

    r283 r1167  
    3131
    3232namespace HeuristicLab.Logging {
     33  /// <summary>
     34  /// Visual representation of the <see cref="Log"/> class.
     35  /// </summary>
    3336  public partial class LogView : ViewBase {
     37    /// <summary>
     38    /// Gets or sets the Log item to represent visually.
     39    /// </summary>
     40    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
     41    /// No own data storage present.</remarks>
    3442    public Log Log {
    3543      get { return (Log)base.Item; }
     
    3745    }
    3846
     47    /// <summary>
     48    /// Initializes a new instance of <see cref="LogView"/>.
     49    /// </summary>
    3950    public LogView() {
    4051      InitializeComponent();
    4152      Caption = "Log View";
    4253    }
     54    /// <summary>
     55    /// Initializes a new instance of <see cref="LogView"/> with the given <paramref name="log"/>.
     56    /// </summary>
     57    /// <param name="log">The log object to represent visually.</param>
    4358    public LogView(Log log)
    4459      : this() {
     
    4661    }
    4762
     63    /// <summary>
     64    /// Removes the event handlers from the underlying <see cref="Log"/>.
     65    /// </summary>
     66    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
    4867    protected override void RemoveItemEvents() {
    4968      if (Log != null) {
     
    5372      base.RemoveItemEvents();
    5473    }
     74    /// <summary>
     75    /// Adds event handlers to the underlying <see cref="Log"/>.
     76    /// </summary>
     77    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
    5578    protected override void AddItemEvents() {
    5679      base.AddItemEvents();
     
    6184    }
    6285
     86    /// <summary>
     87    /// Updates all controls with the latest data of the model.
     88    /// </summary>
     89    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class
     90    /// <see cref="UpdateControls"/>.</remarks>
    6391    protected override void UpdateControls() {
    6492      base.UpdateControls();
  • trunk/sources/HeuristicLab.Logging/Logger.cs

    r1117 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Logs a specified value into a specified log object.
     32  /// </summary>
    3033  public class Logger : OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return @"TODO\r\nOperator description still missing ..."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="Logger"/> with two variable infos
     41    /// (<c>Value</c> and <c>Log</c>).
     42    /// </summary>
    3543    public Logger()
    3644      : base() {
     
    3947    }
    4048
     49    /// <summary>
     50    /// Logs a specified value into a specified log object.
     51    /// </summary>
     52    /// <param name="scope">The current scope.</param>
     53    /// <returns><c>null</c>.</returns>
    4154    public override IOperation Apply(IScope scope) {
    4255      ObjectData[] values = new ObjectData[scope.SubScopes.Count];
  • trunk/sources/HeuristicLab.Logging/PointXYChart.cs

    r677 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Class for point xy charts.
     32  /// </summary>
    3033  public class PointXYChart : ItemBase, IVisualizationItem {
    3134    private ItemList myValues;
     35    /// <summary>
     36    /// Gets or sets the values of the current instance.
     37    /// </summary>
     38    /// <remarks>Calls <see cref="OnValuesChanged"/> in the setter.</remarks>
    3239    public ItemList Values {
    3340      get { return myValues; }
     
    4148
    4249    private BoolData myConnectDots;
     50    /// <summary>
     51    /// Gets or sets the flag whether the dots should be connected or not.
     52    /// </summary>
     53    /// <remarks>Calls <see cref="OnConnectDotsChanged"/> in the setter.</remarks>
    4354    public BoolData ConnectDots {
    4455      get { return myConnectDots; }
     
    5263 
    5364         
    54    
     65    /// <summary>
     66    /// Initializes a new instance of <see cref="PointXYChart"/> with the <c>ConnectDots</c> flag set to
     67    /// <c>true</c>.
     68    /// </summary>
    5569    public PointXYChart() {
    5670      myConnectDots = new BoolData(true);
    5771    }
     72    /// <summary>
     73    /// Initializes a new instance of <see cref="PointXYChart"/> with the given <paramref name="connectDots"/>
     74    /// flag and the specified <paramref name="values"/>.
     75    /// </summary>
     76    /// <param name="connectDots">The flag whether the dots should be connected or not.</param>
     77    /// <param name="values">The values with which the current instance should be initialized.</param>
    5878    public PointXYChart(bool connectDots,ItemList values) {
    5979      myConnectDots = new BoolData(connectDots);
     
    6181    }
    6282
     83    /// <summary>
     84    /// Clones the current instance (deep clone).
     85    /// </summary>
     86    /// <remarks>Deep clone through <see cref="Auxiliary.Clone"/> method of helper class
     87    /// <see cref="Auxiliary"/>.</remarks>
     88    /// <param name="clonedObjects">Dictionary of all already clone objects. (Needed to avoid cycles.)</param>
     89    /// <returns>The cloned object as <see cref="PointXYChart"/>.</returns>
    6390    public override object Clone(IDictionary<Guid, object> clonedObjects) {
    6491      PointXYChart clone = (PointXYChart)base.Clone(clonedObjects);
     
    6794    }
    6895
     96    /// <summary>
     97    /// Creates a new instance of <see cref="PointXYChartView"/> to represent the current instance visually.
     98    /// </summary>
     99    /// <returns>The created view as <see cref="PointXYChartView"/>.</returns>
    69100    public override IView CreateView() {
    70101      return new PointXYChartView(this);
    71102    }
    72103
     104    /// <summary>
     105    /// Occurs when the values of the current instance have been changed.
     106    /// </summary>
    73107    public event EventHandler ValuesChanged;
     108    /// <summary>
     109    /// Fires a <c>ValuesChanged</c> event.
     110    /// </summary>
    74111    protected virtual void OnValuesChanged() {
    75112      if (ValuesChanged != null)
    76113        ValuesChanged(this, new EventArgs());
    77114    }
     115    /// <summary>
     116    /// Occurs when the boolean flag has been changed.
     117    /// </summary>
    78118    public event EventHandler ConnectDotsChanged;
     119    /// <summary>
     120    /// Fires a <c>ConnectDotsChanged</c> event.
     121    /// </summary>
    79122    protected virtual void OnConnectDotsChanged() {
    80123      if (ConnectDotsChanged != null)
     
    83126
    84127    #region Persistence Methods
     128    /// <summary>
     129    /// Saves the current instance as <see cref="XmlNode"/> in the specified <paramref name="document"/>.
     130    /// </summary>
     131    /// <remarks>The ConnectDots flag and the values of the current instance are saved as child nodes
     132    /// with tag names <c>ConnectDots</c> and <c>Values</c> respectively.</remarks>
     133    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
     134    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
     135    /// <param name="persistedObjects">The dictionary of all already persisted objects.
     136    /// (Needed to avoid cycles.)</param>
     137    /// <returns>The saved <see cref="XmlNode"/>.</returns>
    85138    public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) {
    86139      XmlNode node = base.GetXmlNode(name, document, persistedObjects);
     
    89142      return node;
    90143    }
     144    /// <summary>
     145    /// Loads the persisted item from the specified <paramref name="node"/>.
     146    /// </summary>
     147    /// <remarks>Has to be saved in a special way, see <see cref="GetXmlNode"/> for further information.</remarks>
     148    /// <param name="node">The <see cref="XmlNode"/> where the PointXYChart is saved.</param>
     149    /// <param name="restoredObjects">The dictionary of all already restored objects.
     150    /// (Needed to avoid cycles.)</param>
    91151    public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) {
    92152      base.Populate(node, restoredObjects);
  • trunk/sources/HeuristicLab.Logging/PointXYChartInjector.cs

    r677 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Injects a new PointXYChart variable into the given scope.
     32  /// </summary>
    3033  class PointXYChartInjector : OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return @"TODO\r\nOperator description still missing ..."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="PointXYChartInjector"/> with three variable infos
     41    /// (<c>ConnectDots</c>, <c>Values</c> and <c>PointXYChart</c>).
     42    /// </summary>
    3543    public PointXYChartInjector() {
    3644      VariableInfo connectDotsInfo = new VariableInfo("ConnectDots", "Number of lines the linechart consists of", typeof(BoolData), VariableKind.In);
     
    4250    }
    4351
     52    /// <summary>
     53    /// Injects a new PointXYChart variable into the given <paramref name="scope"/>.
     54    /// </summary>
     55    /// <param name="scope">The current scope where to inject the variable.</param>
     56    /// <returns><c>null</c>.</returns>
    4457    public override IOperation Apply(IScope scope) {
    4558      bool connectDots = GetVariableValue<BoolData>("ConnectDots", scope, true).Data;
  • trunk/sources/HeuristicLab.Logging/PointXYChartView.cs

    r677 r1167  
    3333
    3434namespace HeuristicLab.Logging {
     35  /// <summary>
     36  /// Visual representation of a <see cref="PointXYChart"/>.
     37  /// </summary>
    3538  public partial class PointXYChartView : ViewBase {
    3639    private static int[] colors = new int[] {
     
    4952    };
    5053
     54    /// <summary>
     55    /// Gets or sets the chart to represent visually.
     56    /// </summary>
     57    /// <remarks>Uses property <see cref="ViewBase.Item"/> of base class <see cref="ViewBase"/>.
     58    /// No own data storage present.</remarks>
    5159    public PointXYChart PointXYChart {
    5260      get { return (PointXYChart)base.Item; }
     
    5462    }
    5563
     64    /// <summary>
     65    /// Initializes a new instance of <see cref="PointXYChartView"/>.
     66    /// </summary>
    5667    public PointXYChartView() {
    5768      InitializeComponent();
    5869      Caption = "PointXYChart View";
    5970    }
     71    /// <summary>
     72    /// Initializes a new instance of <see cref="PointXYChartView"/> with the given
     73    /// <paramref name="pointXYChart"/>.
     74    /// </summary>
     75    /// <param name="pointXYChart">The chart to represent visually.</param>
    6076    public PointXYChartView(PointXYChart pointXYChart)
    6177      : this() {
     
    6379    }
    6480
     81    /// <summary>
     82    /// Removes the eventhandlers from the underlying <see cref="PointXYChart"/>.
     83    /// </summary>
     84    /// <remarks>Calls <see cref="ViewBase.RemoveItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
    6585    protected override void RemoveItemEvents() {
    6686      if (PointXYChart != null) {
     
    7090      base.RemoveItemEvents();
    7191    }
     92    /// <summary>
     93    /// Adds eventhandlers to the underlying <see cref="IOperatorGraph"/>.
     94    /// </summary>
     95    /// <remarks>Calls <see cref="ViewBase.AddItemEvents"/> of base class <see cref="ViewBase"/>.</remarks>
    7296    protected override void AddItemEvents() {
    7397      base.AddItemEvents();
     
    78102    }
    79103
     104    /// <summary>
     105    /// Updates all controls with the latest data of the model.
     106    /// </summary>
     107    /// <remarks>Calls <see cref="ViewBase.UpdateControls"/> of base class <see cref="ViewBase"/>.</remarks>
    80108    protected override void UpdateControls() {
    81109      base.UpdateControls();
  • trunk/sources/HeuristicLab.Logging/QualityLogger.cs

    r77 r1167  
    2828
    2929namespace HeuristicLab.Logging {
     30  /// <summary>
     31  /// Logs the quality (best, average, worst) of a solution.
     32  /// </summary>
    3033  public class QualityLogger : OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return @"TODO\r\nOperator description still missing ..."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="QualityLogger"/> with two variable infos
     41    /// (<c>Quality</c> and <c>QualityLog</c>).
     42    /// </summary>
    3543    public QualityLogger()
    3644      : base() {
     
    3947    }
    4048
     49    /// <summary>
     50    /// Logs the quality (best, average and worst) of a solution.
     51    /// </summary>
     52    /// <param name="scope">The current scope where to log the quality.</param>
     53    /// <returns><c>null</c>.</returns>
    4154    public override IOperation Apply(IScope scope) {
    4255      double[] qualities = new double[scope.SubScopes.Count];
  • trunk/sources/HeuristicLab.Operators.Metaprogramming/DoubleRangeVariableInjector.cs

    r466 r1167  
    2828
    2929namespace HeuristicLab.Operators.Metaprogramming {
     30  /// <summary>
     31  /// Injects a double variable into the current scope being in a specified range.
     32  /// </summary>
    3033  public class DoubleRangeVariableInjector: OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return "TASK."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="DoubleRangeVariableInjector"/> with five variable infos
     41    /// (<c>VariableInjectos</c>, <c>VariableName</c>, <c>Min</c>, <c>Max</c> and <c>StepSize</c>).
     42    /// </summary>
    3543    public DoubleRangeVariableInjector()
    3644      : base() {
     
    4250    }
    4351
     52    /// <summary>
     53    /// Injects a new double variable in the given <paramref name="scope"/>.
     54    /// </summary>
     55    /// <param name="scope">The current scope where to inject the variable.</param>
     56    /// <returns><c>null</c>.</returns>
    4457    public override IOperation Apply(IScope scope) {
    4558      double min = GetVariableValue<DoubleData>("Min", scope, true).Data;
  • trunk/sources/HeuristicLab.Operators.Metaprogramming/HeuristicLab.Operators.Metaprogramming.csproj

    r852 r1167  
    44    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
    55    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
    6     <ProductVersion>9.0.30729</ProductVersion>
     6    <ProductVersion>9.0.21022</ProductVersion>
    77    <SchemaVersion>2.0</SchemaVersion>
    88    <ProjectGuid>{F18FD554-19B9-460C-9A49-4AA8D7245727}</ProjectGuid>
     
    3232    <ErrorReport>prompt</ErrorReport>
    3333    <WarningLevel>4</WarningLevel>
     34    <DocumentationFile>bin\Release\HeuristicLab.Operators.Metaprogramming-3.2.XML</DocumentationFile>
    3435  </PropertyGroup>
    3536  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
  • trunk/sources/HeuristicLab.Operators.Metaprogramming/HeuristicLabOperatorsMetaprogrammingPlugin.cs

    r582 r1167  
    2626
    2727namespace HeuristicLab.Operators.Metaprogramming {
     28  /// <summary>
     29  /// Plugin class for HeuristicLab.Operators.Metaprogramming plugin.
     30  /// </summary>
    2831  [ClassInfo(Name = "HeuristicLab.Operators.Metaprogramming-3.2")]
    2932  [PluginFile(Filename = "HeuristicLab.Operators.Metaprogramming-3.2.dll", Filetype = PluginFileType.Assembly)]
  • trunk/sources/HeuristicLab.Operators.Metaprogramming/IntRangeVariableInjector.cs

    r489 r1167  
    2828
    2929namespace HeuristicLab.Operators.Metaprogramming {
     30  /// <summary>
     31  /// Injects a new integer variable into the current scope being in a specified range.
     32  /// </summary>
    3033  public class IntRangeVariableInjector: OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return "TASK."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="IntRangeVariableInjector"/> with four variable infos
     41    /// (<c>VariableInjector</c>, <c>VariableName</c>, <c>Min</c> and <c>Max</c>).
     42    /// </summary>
    3543    public IntRangeVariableInjector()
    3644      : base() {
     
    4149    }
    4250
     51    /// <summary>
     52    /// Injects a new integer variable in the given <paramref name="scope"/>.
     53    /// </summary>
     54    /// <param name="scope">The current scope where to inject the variable.</param>
     55    /// <returns><c>null</c>.</returns>
    4356    public override IOperation Apply(IScope scope) {
    4457      int min = GetVariableValue<IntData>("Min", scope, true).Data;
  • trunk/sources/HeuristicLab.Operators.Metaprogramming/PermutationInjector.cs

    r486 r1167  
    2828
    2929namespace HeuristicLab.Operators.Metaprogramming {
     30  /// <summary>
     31  /// Injects a new permutation variable in the given scope. The number of items contained
     32  /// are in a predifined range.
     33  /// </summary>
    3034  public class PermutationInjector : OperatorBase {
     35    /// <inheritdoc select="summary"/>
    3136    public override string Description {
    3237      get { return "TASK."; }
    3338    }
    3439
     40    /// <summary>
     41    /// Initializes a new instance of <see cref="PermutationInjector"/> with five variable infos
     42    /// (<c>VariableInjector</c>, <c>VariableName</c>, <c>Items</c>, <c>Min</c> and <c>Max</c>).
     43    /// </summary>
    3544    public PermutationInjector()
    3645      : base() {
     
    4251    }
    4352
     53    /// <summary>
     54    /// Injects a new permutation variable into the given <paramref name="scope"/>.
     55    /// </summary>
     56    /// <param name="scope">The current scope where to inject the permutation list.</param>
     57    /// <returns><c>null</c>.</returns>
    4458    public override IOperation Apply(IScope scope) {
    4559      int min = GetVariableValue<IntData>("Min", scope, true).Data;
  • trunk/sources/HeuristicLab.Operators.Metaprogramming/SequentialComposer.cs

    r509 r1167  
    2828
    2929namespace HeuristicLab.Operators.Metaprogramming {
     30  /// <summary>
     31  /// Composes a sequence of <see cref="IOperatorGraph"/>s and injects it into the given scope.
     32  /// </summary>
    3033  public class SequentialComposer: OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get { return "TASK."; }
    3337    }
    3438
     39    /// <summary>
     40    /// Initializes a new instance of <see cref="SequentialComposer"/> with two variable infos
     41    /// (<c>CombineOperator</c> and <c>OperatorNames</c>).
     42    /// </summary>
    3543    public SequentialComposer()
    3644      : base() {
     
    3947    }
    4048
     49    /// <summary>
     50    /// Composes a sequence <see cref="IOperatorGraph"/>s and injects it into the given <paramref name="scope"/>.
     51    /// </summary>
     52    /// <param name="scope">The current scope where to inject the created sequence of operators.</param>
     53    /// <returns><c>null</c>.</returns>
    4154    public override IOperation Apply(IScope scope) {
    4255      ItemList<StringData> parts = GetVariableValue<ItemList<StringData>>("OperatorNames", scope, true);
Note: See TracChangeset for help on using the changeset viewer.