#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 HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
namespace HeuristicLab.Encodings.SymbolicExpressionTreeEncoding.Symbols {
  /// <summary>
  /// Symbol for invoking automatically defined functions
  /// </summary>
  [StorableClass]
  [Item(InvokeFunction.InvokeFunctionName, InvokeFunction.InvokeFunctionDescription)]
  public sealed class InvokeFunction : ReadOnlySymbol {
    public const string InvokeFunctionName = "InvokeFunction";
    public const string InvokeFunctionDescription = "Symbol that the invocation of another function.";
    public override bool CanChangeName {
      get {
        return false;
      }
    }
    [Storable]
    private string functionName;
    public string FunctionName {
      get { return functionName; }
      set {
        if (value == null) throw new ArgumentNullException();
        functionName = value;
      }
    }

    [StorableConstructor]
    private InvokeFunction(bool deserializing) : base(deserializing) { }
    public InvokeFunction(string functionName)
      : base("Invoke: " + functionName, InvokeFunction.InvokeFunctionDescription) {
      this.FunctionName = functionName;
    }

    public override SymbolicExpressionTreeNode CreateTreeNode() {
      return new InvokeFunctionTreeNode(this);
    }

    public override IDeepCloneable Clone(Cloner cloner) {
      InvokeFunction clone = (InvokeFunction)base.Clone(cloner);
      clone.functionName = functionName;
      clone.name = "Invoke: " + functionName;
      return clone;
    }
  }
}