Changeset 1167 for trunk/sources
- Timestamp:
- 01/22/09 12:06:29 (16 years ago)
- Location:
- trunk/sources
- Files:
-
- 20 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/sources/HeuristicLab.Core/ConstrainedItemBase.cs
r776 r1167 115 115 /// to represent the current instance visually. 116 116 /// </summary> 117 /// <returns>The created view as <see cref="ConstrainedItemBase "/>.</returns>117 /// <returns>The created view as <see cref="ConstrainedItemBaseView"/>.</returns> 118 118 public override IView CreateView() { 119 119 return new ConstrainedItemBaseView(this); … … 168 168 } 169 169 /// <summary> 170 /// 170 /// Loads the persisted item from the specified <paramref name="node"/>. 171 171 /// </summary> 172 172 /// <remarks>See <see cref="GetXmlNode"/> to get information about how the constrained item must -
trunk/sources/HeuristicLab.Logging/BestAverageWorstQualityCalculator.cs
r77 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Captures the best, the average and the worst quality of the current population. 32 /// </summary> 30 33 public class BestAverageWorstQualityCalculator : OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return @"TODO\r\nOperator description still missing ..."; } 33 37 } 34 38 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> 35 44 public BestAverageWorstQualityCalculator() 36 45 : base() { … … 42 51 } 43 52 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> 44 58 public override IOperation Apply(IScope scope) { 45 59 double[] qualities = new double[scope.SubScopes.Count]; -
trunk/sources/HeuristicLab.Logging/BestSolutionStorer.cs
r368 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Keeps a variable in the global scope that contains the scope representing the best solution. 32 /// </summary> 30 33 public class BestSolutionStorer : DelegatingOperator { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return @"Keeps a variable in the global scope that contains the scope representing the best of run solution."; } 33 37 } 34 38 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> 35 43 public BestSolutionStorer() 36 44 : base() { … … 40 48 } 41 49 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> 42 55 public override IOperation Apply(IScope scope) { 43 56 if(scope.GetVariable(Guid.ToString() + "-Active") == null) { -
trunk/sources/HeuristicLab.Logging/HeuristicLabLoggingPlugin.cs
r582 r1167 26 26 27 27 namespace HeuristicLab.Logging { 28 /// <summary> 29 /// Plugin class for HeuristicLab.Logging plugin. 30 /// </summary> 28 31 [ClassInfo(Name = "HeuristicLab.Logging-3.2")] 29 32 [PluginFile(Filename = "HeuristicLab.Logging-3.2.dll", Filetype = PluginFileType.Assembly)] -
trunk/sources/HeuristicLab.Logging/Linechart.cs
r2 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Class to represent a Linechart. 32 /// </summary> 30 33 public class Linechart : ItemBase, IVisualizationItem { 31 34 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> 32 39 public int NumberOfLines { 33 40 get { return myNumberOfLines.Data; } … … 40 47 } 41 48 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> 42 53 public ItemList Values { 43 54 get { return myValues; } … … 51 62 52 63 64 /// <summary> 65 /// Initializes a new instance of <see cref="Linechart"/>. 66 /// </summary> 53 67 public Linechart() { 54 68 myNumberOfLines = new IntData(0); 55 69 } 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> 56 76 public Linechart(int numberOfLines, ItemList values) { 57 77 myNumberOfLines = new IntData(numberOfLines); … … 59 79 } 60 80 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> 62 88 public override object Clone(IDictionary<Guid, object> clonedObjects) { 63 89 Linechart clone = (Linechart)base.Clone(clonedObjects); … … 67 93 } 68 94 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> 69 99 public override IView CreateView() { 70 100 return new LinechartView(this); 71 101 } 72 102 103 /// <summary> 104 /// Occurs when the number of lines has been changed. 105 /// </summary> 73 106 public event EventHandler NumberOfLinesChanged; 107 /// <summary> 108 /// Fires a new <c>NumberOfLinesChanged</c> event. 109 /// </summary> 74 110 protected virtual void OnNumberOfLinesChanged() { 75 111 if (NumberOfLinesChanged != null) 76 112 NumberOfLinesChanged(this, new EventArgs()); 77 113 } 114 /// <summary> 115 /// Occurs when the values have been changed. 116 /// </summary> 78 117 public event EventHandler ValuesChanged; 118 /// <summary> 119 /// Fires a new <c>ValuesChanged</c> event. 120 /// </summary> 79 121 protected virtual void OnValuesChanged() { 80 122 if (ValuesChanged != null) … … 83 125 84 126 #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> 85 137 public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) { 86 138 XmlNode node = base.GetXmlNode(name, document, persistedObjects); … … 89 141 return node; 90 142 } 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> 91 150 public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) { 92 151 base.Populate(node, restoredObjects); -
trunk/sources/HeuristicLab.Logging/LinechartInjector.cs
r77 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Injects a new Linechart into the current scope. 32 /// </summary> 30 33 public class LinechartInjector : OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return @"TODO\r\nOperator description still missing ..."; } 33 37 } 34 38 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> 35 43 public LinechartInjector() { 36 44 VariableInfo numberOfLinesInfo = new VariableInfo("NumberOfLines", "Number of lines the linechart consists of", typeof(IntData), VariableKind.In); … … 42 50 } 43 51 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> 44 57 public override IOperation Apply(IScope scope) { 45 58 int numberOfLines = GetVariableValue<IntData>("NumberOfLines", scope, true).Data; -
trunk/sources/HeuristicLab.Logging/LinechartView.cs
r926 r1167 33 33 34 34 namespace HeuristicLab.Logging { 35 /// <summary> 36 /// The visual representation of a <see cref="Linechart"/>. 37 /// </summary> 35 38 public partial class LinechartView : ViewBase { 36 39 private double maxY = double.MinValue, minY = double.MaxValue; … … 50 53 }; 51 54 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> 52 60 public Linechart Linechart { 53 61 get { return (Linechart)base.Item; } … … 55 63 } 56 64 65 /// <summary> 66 /// Initializes a new instance of <see cref="LinechartView"/>. 67 /// </summary> 57 68 public LinechartView() { 58 69 InitializeComponent(); 59 70 Caption = "Linechart View"; 60 71 } 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> 61 76 public LinechartView(Linechart linechart) 62 77 : this() { … … 64 79 } 65 80 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> 66 85 protected override void RemoveItemEvents() { 67 86 if(Linechart != null) { … … 71 90 base.RemoveItemEvents(); 72 91 } 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> 73 96 protected override void AddItemEvents() { 74 97 base.AddItemEvents(); … … 79 102 } 80 103 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> 81 108 protected override void UpdateControls() { 82 109 base.UpdateControls(); -
trunk/sources/HeuristicLab.Logging/Log.cs
r2 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Represents a log object where to store a specific value that should be logged. 32 /// </summary> 30 33 public class Log : ItemBase, IVisualizationItem { 31 34 private ItemList myItems; 35 /// <summary> 36 /// Gets or sets the items of the current instance. 37 /// </summary> 32 38 public ItemList Items { 33 39 get { return myItems; } … … 36 42 37 43 44 /// <summary> 45 /// Initializes a new instance of <see cref="Log"/>. 46 /// </summary> 38 47 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> 39 52 public Log(ItemList items) { 40 53 myItems = items; 41 54 } 42 55 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> 44 63 public override object Clone(IDictionary<Guid, object> clonedObjects) { 45 64 Log clone = (Log)base.Clone(clonedObjects); … … 48 67 } 49 68 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> 50 73 public override IView CreateView() { 51 74 return new LogView(this); 52 75 } 53 76 77 /// <summary> 78 /// Occurs when the items have been changed. 79 /// </summary> 54 80 public event EventHandler ItemsChanged; 81 /// <summary> 82 /// Fires a new <c>ItemsChanged</c> event. 83 /// </summary> 55 84 protected virtual void OnItemsChanged() { 56 85 if (ItemsChanged != null) … … 59 88 60 89 #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> 61 100 public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) { 62 101 XmlNode node = base.GetXmlNode(name, document, persistedObjects); … … 64 103 return node; 65 104 } 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> 66 112 public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) { 67 113 base.Populate(node, restoredObjects); -
trunk/sources/HeuristicLab.Logging/LogView.cs
r283 r1167 31 31 32 32 namespace HeuristicLab.Logging { 33 /// <summary> 34 /// Visual representation of the <see cref="Log"/> class. 35 /// </summary> 33 36 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> 34 42 public Log Log { 35 43 get { return (Log)base.Item; } … … 37 45 } 38 46 47 /// <summary> 48 /// Initializes a new instance of <see cref="LogView"/>. 49 /// </summary> 39 50 public LogView() { 40 51 InitializeComponent(); 41 52 Caption = "Log View"; 42 53 } 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> 43 58 public LogView(Log log) 44 59 : this() { … … 46 61 } 47 62 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> 48 67 protected override void RemoveItemEvents() { 49 68 if (Log != null) { … … 53 72 base.RemoveItemEvents(); 54 73 } 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> 55 78 protected override void AddItemEvents() { 56 79 base.AddItemEvents(); … … 61 84 } 62 85 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> 63 91 protected override void UpdateControls() { 64 92 base.UpdateControls(); -
trunk/sources/HeuristicLab.Logging/Logger.cs
r1117 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Logs a specified value into a specified log object. 32 /// </summary> 30 33 public class Logger : OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return @"TODO\r\nOperator description still missing ..."; } 33 37 } 34 38 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> 35 43 public Logger() 36 44 : base() { … … 39 47 } 40 48 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> 41 54 public override IOperation Apply(IScope scope) { 42 55 ObjectData[] values = new ObjectData[scope.SubScopes.Count]; -
trunk/sources/HeuristicLab.Logging/PointXYChart.cs
r677 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Class for point xy charts. 32 /// </summary> 30 33 public class PointXYChart : ItemBase, IVisualizationItem { 31 34 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> 32 39 public ItemList Values { 33 40 get { return myValues; } … … 41 48 42 49 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> 43 54 public BoolData ConnectDots { 44 55 get { return myConnectDots; } … … 52 63 53 64 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> 55 69 public PointXYChart() { 56 70 myConnectDots = new BoolData(true); 57 71 } 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> 58 78 public PointXYChart(bool connectDots,ItemList values) { 59 79 myConnectDots = new BoolData(connectDots); … … 61 81 } 62 82 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> 63 90 public override object Clone(IDictionary<Guid, object> clonedObjects) { 64 91 PointXYChart clone = (PointXYChart)base.Clone(clonedObjects); … … 67 94 } 68 95 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> 69 100 public override IView CreateView() { 70 101 return new PointXYChartView(this); 71 102 } 72 103 104 /// <summary> 105 /// Occurs when the values of the current instance have been changed. 106 /// </summary> 73 107 public event EventHandler ValuesChanged; 108 /// <summary> 109 /// Fires a <c>ValuesChanged</c> event. 110 /// </summary> 74 111 protected virtual void OnValuesChanged() { 75 112 if (ValuesChanged != null) 76 113 ValuesChanged(this, new EventArgs()); 77 114 } 115 /// <summary> 116 /// Occurs when the boolean flag has been changed. 117 /// </summary> 78 118 public event EventHandler ConnectDotsChanged; 119 /// <summary> 120 /// Fires a <c>ConnectDotsChanged</c> event. 121 /// </summary> 79 122 protected virtual void OnConnectDotsChanged() { 80 123 if (ConnectDotsChanged != null) … … 83 126 84 127 #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> 85 138 public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects) { 86 139 XmlNode node = base.GetXmlNode(name, document, persistedObjects); … … 89 142 return node; 90 143 } 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> 91 151 public override void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects) { 92 152 base.Populate(node, restoredObjects); -
trunk/sources/HeuristicLab.Logging/PointXYChartInjector.cs
r677 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Injects a new PointXYChart variable into the given scope. 32 /// </summary> 30 33 class PointXYChartInjector : OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return @"TODO\r\nOperator description still missing ..."; } 33 37 } 34 38 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> 35 43 public PointXYChartInjector() { 36 44 VariableInfo connectDotsInfo = new VariableInfo("ConnectDots", "Number of lines the linechart consists of", typeof(BoolData), VariableKind.In); … … 42 50 } 43 51 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> 44 57 public override IOperation Apply(IScope scope) { 45 58 bool connectDots = GetVariableValue<BoolData>("ConnectDots", scope, true).Data; -
trunk/sources/HeuristicLab.Logging/PointXYChartView.cs
r677 r1167 33 33 34 34 namespace HeuristicLab.Logging { 35 /// <summary> 36 /// Visual representation of a <see cref="PointXYChart"/>. 37 /// </summary> 35 38 public partial class PointXYChartView : ViewBase { 36 39 private static int[] colors = new int[] { … … 49 52 }; 50 53 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> 51 59 public PointXYChart PointXYChart { 52 60 get { return (PointXYChart)base.Item; } … … 54 62 } 55 63 64 /// <summary> 65 /// Initializes a new instance of <see cref="PointXYChartView"/>. 66 /// </summary> 56 67 public PointXYChartView() { 57 68 InitializeComponent(); 58 69 Caption = "PointXYChart View"; 59 70 } 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> 60 76 public PointXYChartView(PointXYChart pointXYChart) 61 77 : this() { … … 63 79 } 64 80 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> 65 85 protected override void RemoveItemEvents() { 66 86 if (PointXYChart != null) { … … 70 90 base.RemoveItemEvents(); 71 91 } 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> 72 96 protected override void AddItemEvents() { 73 97 base.AddItemEvents(); … … 78 102 } 79 103 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> 80 108 protected override void UpdateControls() { 81 109 base.UpdateControls(); -
trunk/sources/HeuristicLab.Logging/QualityLogger.cs
r77 r1167 28 28 29 29 namespace HeuristicLab.Logging { 30 /// <summary> 31 /// Logs the quality (best, average, worst) of a solution. 32 /// </summary> 30 33 public class QualityLogger : OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return @"TODO\r\nOperator description still missing ..."; } 33 37 } 34 38 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> 35 43 public QualityLogger() 36 44 : base() { … … 39 47 } 40 48 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> 41 54 public override IOperation Apply(IScope scope) { 42 55 double[] qualities = new double[scope.SubScopes.Count]; -
trunk/sources/HeuristicLab.Operators.Metaprogramming/DoubleRangeVariableInjector.cs
r466 r1167 28 28 29 29 namespace HeuristicLab.Operators.Metaprogramming { 30 /// <summary> 31 /// Injects a double variable into the current scope being in a specified range. 32 /// </summary> 30 33 public class DoubleRangeVariableInjector: OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return "TASK."; } 33 37 } 34 38 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> 35 43 public DoubleRangeVariableInjector() 36 44 : base() { … … 42 50 } 43 51 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> 44 57 public override IOperation Apply(IScope scope) { 45 58 double min = GetVariableValue<DoubleData>("Min", scope, true).Data; -
trunk/sources/HeuristicLab.Operators.Metaprogramming/HeuristicLab.Operators.Metaprogramming.csproj
r852 r1167 4 4 <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration> 5 5 <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform> 6 <ProductVersion>9.0. 30729</ProductVersion>6 <ProductVersion>9.0.21022</ProductVersion> 7 7 <SchemaVersion>2.0</SchemaVersion> 8 8 <ProjectGuid>{F18FD554-19B9-460C-9A49-4AA8D7245727}</ProjectGuid> … … 32 32 <ErrorReport>prompt</ErrorReport> 33 33 <WarningLevel>4</WarningLevel> 34 <DocumentationFile>bin\Release\HeuristicLab.Operators.Metaprogramming-3.2.XML</DocumentationFile> 34 35 </PropertyGroup> 35 36 <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' "> -
trunk/sources/HeuristicLab.Operators.Metaprogramming/HeuristicLabOperatorsMetaprogrammingPlugin.cs
r582 r1167 26 26 27 27 namespace HeuristicLab.Operators.Metaprogramming { 28 /// <summary> 29 /// Plugin class for HeuristicLab.Operators.Metaprogramming plugin. 30 /// </summary> 28 31 [ClassInfo(Name = "HeuristicLab.Operators.Metaprogramming-3.2")] 29 32 [PluginFile(Filename = "HeuristicLab.Operators.Metaprogramming-3.2.dll", Filetype = PluginFileType.Assembly)] -
trunk/sources/HeuristicLab.Operators.Metaprogramming/IntRangeVariableInjector.cs
r489 r1167 28 28 29 29 namespace HeuristicLab.Operators.Metaprogramming { 30 /// <summary> 31 /// Injects a new integer variable into the current scope being in a specified range. 32 /// </summary> 30 33 public class IntRangeVariableInjector: OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return "TASK."; } 33 37 } 34 38 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> 35 43 public IntRangeVariableInjector() 36 44 : base() { … … 41 49 } 42 50 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> 43 56 public override IOperation Apply(IScope scope) { 44 57 int min = GetVariableValue<IntData>("Min", scope, true).Data; -
trunk/sources/HeuristicLab.Operators.Metaprogramming/PermutationInjector.cs
r486 r1167 28 28 29 29 namespace 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> 30 34 public class PermutationInjector : OperatorBase { 35 /// <inheritdoc select="summary"/> 31 36 public override string Description { 32 37 get { return "TASK."; } 33 38 } 34 39 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> 35 44 public PermutationInjector() 36 45 : base() { … … 42 51 } 43 52 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> 44 58 public override IOperation Apply(IScope scope) { 45 59 int min = GetVariableValue<IntData>("Min", scope, true).Data; -
trunk/sources/HeuristicLab.Operators.Metaprogramming/SequentialComposer.cs
r509 r1167 28 28 29 29 namespace HeuristicLab.Operators.Metaprogramming { 30 /// <summary> 31 /// Composes a sequence of <see cref="IOperatorGraph"/>s and injects it into the given scope. 32 /// </summary> 30 33 public class SequentialComposer: OperatorBase { 34 /// <inheritdoc select="summary"/> 31 35 public override string Description { 32 36 get { return "TASK."; } 33 37 } 34 38 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> 35 43 public SequentialComposer() 36 44 : base() { … … 39 47 } 40 48 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> 41 54 public override IOperation Apply(IScope scope) { 42 55 ItemList<StringData> parts = GetVariableValue<ItemList<StringData>>("OperatorNames", scope, true);
Note: See TracChangeset
for help on using the changeset viewer.