Changes between Version 1 and Version 2 of Documentation/DevelopmentCenter/DeveloperGuidelinesSourceExample

Timestamp:

08/10/10 02:36:37 (14 years ago)

Author:

swagner

Comment:

--

Documentation/DevelopmentCenter/DeveloperGuidelinesSourceExample

@@ -1 @@
-= Source Code Example =
+= HeuristicLab Development Guidelines - Source Example =
 
 {{{
-#!cpp
-/* A multiline comment
- * describing something ...
+#!text/x-csharp
+#region License Information
+/* HeuristicLab
+ * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
+ *
+ * This file is part of HeuristicLab.
+ *
+ * HeuristicLab is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * HeuristicLab is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
  */
+#endregion
+
 using System;
-using System.Collections.Generic;
-using System.Text;
+using System.Drawing;
+using HeuristicLab.Common;
+using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 
 namespace HeuristicLab.Core {
-  public class Sheep : Mammal, IAnimal {
-    private double myWeight;
-    public double Weight {  // a comment
-      get { return myWeight; }
+  /// <summary>
+  /// Represents the base class for all basic item types.
+  /// </summary>
+  [StorableClass]
+  [Item("Item", "Base class for all HeuristicLab items.")]
+  public abstract class Item : IItem {
+    private string filename;
+    public string Filename {
+      get { return filename; }
       set {
-        if (value > 0)
-          myWeight = value;
+        if (value == null) throw new ArgumentNullException();
+        if ((filename == null) || !filename.Equals(value)) {
+          filename = value;
+          OnFilenameChanged();
+        }
       }
     }
 
-
-    public Sheep() {
-      myWeight = 666;
+    public virtual string ItemName {
+      get { return ItemAttribute.GetName(this.GetType()); }
     }
-    public Sheep(double weight) {
-      myWeight = weight;
+    public virtual string ItemDescription {
+      get { return ItemAttribute.GetDescription(this.GetType()); }
+    }
+    public Version ItemVersion {
+      get { return ItemAttribute.GetVersion(this.GetType()); }
+    }
+    public virtual Image ItemImage {
+      get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Class; }
     }
 
+    protected Item() {
+      filename = string.Empty;
+    }
+    [StorableConstructor]
+    protected Item(bool deserializing) {
+      filename = string.Empty;
+    }
 
-    // a comment describing a method
-    public string LookABitSilly() {
-      return "Oo";
+    public object Clone() {
+      return Clone(new Cloner());
+    }
+    public virtual IDeepCloneable Clone(Cloner cloner) {
+      Item clone = (Item)Activator.CreateInstance(this.GetType(), true);
+      cloner.RegisterClonedObject(this, clone);
+      return clone;
     }
 
     public override string ToString() {
-      return "Sheep (" + Weight.ToString() + " tons)";
+      return ItemName;
     }
 
-    public event EventHandler Baa;
-    protected virtual void OnBaa() {
-      if (Baa != null)
-        Baa(this, new EventArgs());
+    public event EventHandler FilenameChanged;
+    protected virtual void OnFilenameChanged() {
+      EventHandler handler = FilenameChanged;
+      if (handler != null) handler(this, EventArgs.Empty);
+    }
+    public event EventHandler ItemImageChanged;
+    protected virtual void OnItemImageChanged() {
+      EventHandler handler = ItemImageChanged;
+      if (handler != null) handler(this, EventArgs.Empty);
+    }
+    public event EventHandler ToStringChanged;
+    protected virtual void OnToStringChanged() {
+      EventHandler handler = ToStringChanged;
+      if (handler != null) handler(this, EventArgs.Empty);
     }
   }