Changeset 2664 for trunk/sources/HeuristicLab.Core

Timestamp:

01/21/10 02:04:44 (15 years ago)

Author:

swagner

Message:

Abandoned policy that the names of all abstract base classes have to end in "Base" (#95)

Location:

trunk/sources/HeuristicLab.Core/3.3

Files:

• DeepCloneable.cs (moved) (moved from trunk/sources/HeuristicLab.Core/3.3/DeepCloneableBase.cs) (2 diffs)
• Engine.cs (moved) (moved from trunk/sources/HeuristicLab.Core/3.3/EngineBase.cs) (3 diffs)
• ExecutionContext.cs (modified) (1 diff)
• ExecutionContextCollection.cs (modified) (1 diff)
• HeuristicLab.Core-3.3.csproj (modified) (3 diffs)
• Item.cs (moved) (moved from trunk/sources/HeuristicLab.Core/3.3/ItemBase.cs) (1 diff)
• ItemParameter.cs (copied) (copied from trunk/sources/HeuristicLab.Core/3.3/Parameter.cs) (5 diffs)
• NamedItem.cs (moved) (moved from trunk/sources/HeuristicLab.Core/3.3/NamedItemBase.cs) (4 diffs)
• NamedItemCollection.cs (modified) (1 diff)
• OperatorGraph.cs (modified) (1 diff)
• OperatorParameter.cs (modified) (1 diff)
• Parameter.cs (moved) (moved from trunk/sources/HeuristicLab.Core/3.3/ParameterBase.cs) (3 diffs)
• Scope.cs (modified) (1 diff)
• Variable.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Core/3.3/DeepCloneable.cs

@@ -31 +31 @@
   /// </summary>
   [EmptyStorableClass]
-  public abstract class DeepCloneableBase : IDeepCloneable {
+  public abstract class DeepCloneable : IDeepCloneable {
     /// <summary>
     /// Creates a deep clone of this instance.
@@ -52 +52 @@
     /// <returns>A clone of this instance.</returns>
     public virtual IDeepCloneable Clone(Cloner cloner) {
-      DeepCloneableBase clone = (DeepCloneableBase)Activator.CreateInstance(this.GetType());
+      DeepCloneable clone = (DeepCloneable)Activator.CreateInstance(this.GetType());
       cloner.RegisterClonedObject(this, clone);
       return clone;

trunk/sources/HeuristicLab.Core/3.3/Engine.cs

@@ -35 +35 @@
   /// one execution and can handle parallel executions.
   /// </summary>
-  [Item("EngineBase", "A base class for engines.")]
-  public abstract class EngineBase : ItemBase, IEngine {
+  [Item("Engine", "A base class for engines.")]
+  public abstract class Engine : Item, IEngine {
     public override Image ItemImage {
       get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Event; }
@@ -133 +133 @@
     /// </summary>
     /// <remarks>Calls <see cref="Reset"/>.</remarks>
-    protected EngineBase() {
+    protected Engine() {
       globalScope = new Scope("Global");
       executionStack = new Stack<ExecutionContext>();
@@ -147 +147 @@
     /// <returns>The cloned object as <see cref="EngineBase"/>.</returns>
     public override IDeepCloneable Clone(Cloner cloner) {
-      EngineBase clone = (EngineBase)base.Clone(cloner);
+      Engine clone = (Engine)base.Clone(cloner);
       clone.OperatorGraph = (OperatorGraph)cloner.Clone(operatorGraph);
       clone.globalScope = (Scope)cloner.Clone(globalScope);

trunk/sources/HeuristicLab.Core/3.3/ExecutionContext.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.Core {
-  public class ExecutionContext : DeepCloneableBase {
+  public class ExecutionContext : DeepCloneable {
     [Storable]
     private ExecutionContext parent;

trunk/sources/HeuristicLab.Core/3.3/ExecutionContextCollection.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Core {
-  public class ExecutionContextCollection : DeepCloneableBase, IList<ExecutionContext> {
+  public class ExecutionContextCollection : DeepCloneable, IList<ExecutionContext> {
     [Storable]
     private IList<ExecutionContext> contexts;

trunk/sources/HeuristicLab.Core/3.3/HeuristicLab.Core-3.3.csproj

@@ -103 +103 @@
     <Compile Include="Attributes\CreatableAttribute.cs" />
     <Compile Include="ChangedEventArgs.cs" />
+    <Compile Include="DeepCloneable.cs" />
+    <Compile Include="Engine.cs" />
     <Compile Include="Interfaces\IOperatorParameter.cs" />
+    <Compile Include="Item.cs" />
+    <Compile Include="ItemParameter.cs" />
+    <Compile Include="NamedItem.cs" />
     <Compile Include="OperatorGraph.cs" />
     <Compile Include="OperatorParameter.cs" />
-    <Compile Include="ParameterBase.cs" />
     <Compile Include="Interfaces\IParameter.cs" />
     <Compile Include="OperatorCollection.cs" />
@@ -113 +117 @@
     <Compile Include="ItemSet.cs" />
     <Compile Include="ItemList.cs" />
-    <Compile Include="EngineBase.cs">
-      <SubType>Code</SubType>
-    </Compile>
     <Compile Include="Interfaces\IEngine.cs">
       <SubType>Code</SubType>
@@ -126 +127 @@
     <Compile Include="Parameter.cs" />
     <Compile Include="ScopeList.cs" />
-    <Compile Include="DeepCloneableBase.cs" />
     <Compile Include="Interfaces\IDeepCloneable.cs" />
     <Compile Include="NamedItemCollection.cs" />
     <Compile Include="Interfaces\INamedItem.cs" />
-    <Compile Include="NamedItemBase.cs" />
     <Compile Include="Interfaces\IItem.cs" />
-    <Compile Include="ItemBase.cs" />
     <Compile Include="Interfaces\IRandom.cs" />
     <Compile Include="Scope.cs" />

trunk/sources/HeuristicLab.Core/3.3/Item.cs

@@ -35 +35 @@
   /// </summary>
   [EmptyStorableClass]
-  [Item("ItemBase", "Base class for all HeuristicLab items.")]
-  public abstract class ItemBase : DeepCloneableBase, IItem {
+  [Item("Item", "Base class for all HeuristicLab items.")]
+  public abstract class Item : DeepCloneable, IItem {
     public virtual string ItemName {
       get { return ItemAttribute.GetName(this.GetType()); }

trunk/sources/HeuristicLab.Core/3.3/ItemParameter.cs

@@ -31 +31 @@
   /// Represents a parameter.
   /// </summary>
-  [Item("Parameter", "A parameter which represents an IItem.")]
+  [Item("Item Parameter", "A parameter which represents an IItem.")]
   [Creatable("Test")]
-  public class Parameter : ParameterBase {
+  public class ItemParameter : Parameter {
     [Storable]
     private string actualName;
@@ -62 +62 @@
     }
 
-    public Parameter()
+    public ItemParameter()
       : base("Anonymous", null, typeof(IItem)) {
       actualName = Name;
       Value = null;
     }
-    protected Parameter(string name, string description, Type dataType)
+    protected ItemParameter(string name, string description, Type dataType)
       : base(name, description, dataType) {
       this.actualName = Name;
       this.Value = null;
     }
-    public Parameter(string name, string description)
+    public ItemParameter(string name, string description)
       : base(name, description, typeof(IItem)) {
       this.actualName = Name;
       this.Value = null;
     }
-    public Parameter(string name, string description, IItem value)
+    public ItemParameter(string name, string description, IItem value)
       : base(name, description, typeof(IItem)) {
       this.actualName = Name;
@@ -98 +98 @@
 
     public override IDeepCloneable Clone(Cloner cloner) {
-      Parameter clone = (Parameter)base.Clone(cloner);
+      ItemParameter clone = (ItemParameter)base.Clone(cloner);
       clone.actualName = actualName;
       clone.Value = (IItem)cloner.Clone(value);
@@ -128 +128 @@
   [Item("Parameter<T>", "A generic parameter which represents an instance of type T.")]
   [EmptyStorableClass]
-  public class Parameter<T> : Parameter where T : class, IItem {
+  public class ItemParameter<T> : ItemParameter where T : class, IItem {
     public new T Value {
       get { return (T)base.Value; }
@@ -134 +134 @@
     }
 
-    public Parameter()
+    public ItemParameter()
       : base("Anonymous", null, typeof(T)) {
       Value = null;
     }
-    public Parameter(string name, string description)
+    public ItemParameter(string name, string description)
       : base(name, description, typeof(T)) {
       this.Value = null;
     }
-    public Parameter(string name, string description, T value)
+    public ItemParameter(string name, string description, T value)
       : base(name, description, typeof(T)) {
       this.Value = value;

trunk/sources/HeuristicLab.Core/3.3/NamedItem.cs

@@ -28 +28 @@
 
 namespace HeuristicLab.Core {
-  [Item("NamedItemBase", "Base class for items which have a name and an optional description.")]
-  public abstract class NamedItemBase : ItemBase, INamedItem {
+  [Item("NamedItem", "Base class for items which have a name and an optional description.")]
+  public abstract class NamedItem : Item, INamedItem {
     [Storable]
     protected string name;
@@ -73 +73 @@
     /// and value <c>null</c>.
     /// </summary>
-    protected NamedItemBase() {
+    protected NamedItem() {
       name = ItemName;
       description = ItemDescription;
@@ -83 +83 @@
     /// <param name="name">The name of the current instance.</param>
     /// <param name="value">The value of the current instance.</param>
-    protected NamedItemBase(string name)
+    protected NamedItem(string name)
       : this() {
       if (name == null) throw new ArgumentNullException();
       this.name = name;
     }
-    protected NamedItemBase(string name, string description)
+    protected NamedItem(string name, string description)
       : this(name) {
       this.description = description;
@@ -99 +99 @@
     /// <returns>The cloned object as <see cref="Variable"/>.</returns>
     public override IDeepCloneable Clone(Cloner cloner) {
-      NamedItemBase clone = (NamedItemBase)base.Clone(cloner);
+      NamedItem clone = (NamedItem)base.Clone(cloner);
       clone.name = name;
       clone.description = description;

trunk/sources/HeuristicLab.Core/3.3/NamedItemCollection.cs

@@ -30 +30 @@
 
 namespace HeuristicLab.Core {
-  public class NamedItemCollection<T> : ObservableKeyedCollectionBase<string, T>, IDeepCloneable where T : class, INamedItem {
+  public class NamedItemCollection<T> : ObservableKeyedCollection<string, T>, IDeepCloneable where T : class, INamedItem {
     [Storable(Name = "RestoreEvents")]
     private object RestoreEvents {

trunk/sources/HeuristicLab.Core/3.3/OperatorGraph.cs

@@ -35 +35 @@
   [Item("OperatorGraph", "Represents a graph of operators.")]
   [Creatable("Test")]
-  public class OperatorGraph : ItemBase {
+  public class OperatorGraph : Item {
     private OperatorSet operators;
     /// <summary>

trunk/sources/HeuristicLab.Core/3.3/OperatorParameter.cs

@@ -34 +34 @@
   [EmptyStorableClass]
   [Creatable("Test")]
-  public class OperatorParameter : Parameter<IOperator>, IOperatorParameter {
+  public class OperatorParameter : ItemParameter<IOperator>, IOperatorParameter {
     public OperatorParameter()
       : base("Anonymous", null) {

trunk/sources/HeuristicLab.Core/3.3/Parameter.cs

@@ -31 +31 @@
   /// Represents a parameter.
   /// </summary>
-  [Item("ParameterBase", "A base class for parameters.")]
-  public abstract class ParameterBase : NamedItemBase, IParameter {
+  [Item("Parameter", "A base class for parameters.")]
+  public abstract class Parameter : NamedItem, IParameter {
     public override bool CanChangeName {
       get { return false; }
@@ -46 +46 @@
     }
 
-    protected ParameterBase()
+    protected Parameter()
       : base("Anonymous") {
       dataType = typeof(IItem);
     }
-    protected ParameterBase(string name, string description, Type dataType)
+    protected Parameter(string name, string description, Type dataType)
       : base(name, description) {
       if (dataType == null) throw new ArgumentNullException();
@@ -59 +59 @@
 
     public override IDeepCloneable Clone(Cloner cloner) {
-      ParameterBase clone = (ParameterBase)base.Clone(cloner);
+      Parameter clone = (Parameter)base.Clone(cloner);
       clone.dataType = dataType;
       return clone;

trunk/sources/HeuristicLab.Core/3.3/Scope.cs

@@ -33 +33 @@
   [Item("Scope", "A scope which contains variables and sub-scopes.")]
   [Creatable("Test")]
-  public class Scope : NamedItemBase {
+  public class Scope : NamedItem {
     [Storable]
     private Scope parent;

trunk/sources/HeuristicLab.Core/3.3/Variable.cs

@@ -33 +33 @@
   [Item("Variable", "A variable which has a name and holds an IItem.")]
   [Creatable("Test")]
-  public sealed class Variable : NamedItemBase {
+  public sealed class Variable : NamedItem {
     private IItem value;
     /// <inheritdoc/>