#region License Information
/* HeuristicLab
* Copyright (C) 2002-2008 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 .
*/
#endregion
using System;
using System.Collections.Generic;
using System.Text;
using HeuristicLab.Core;
using HeuristicLab.Data;
using System.Xml;
using System.Diagnostics;
namespace HeuristicLab.Constraints {
///
/// Constraint where all sub-operators have to be elements of a pre-defined group.
///
public class AllSubOperatorsTypeConstraint : ConstraintBase {
private SubOperatorTypeConstraint groupConstraint;
///
/// Gets all allowed sub-operators.
///
public IList AllowedSubOperators {
get {
return groupConstraint.AllowedSubOperators;
}
}
///
public override string Description {
get { return "All sub-operators have to be elements of a pre-defined group."; }
}
///
/// Initializes a new instance of .
///
public AllSubOperatorsTypeConstraint()
: base() {
groupConstraint = new SubOperatorTypeConstraint();
}
///
/// Adds the given operator to the constraint.
///
/// Calls of base class
/// .
/// The operator to add.
public void AddOperator(IOperator op) {
groupConstraint.AddOperator(op);
FireChanged();
}
///
/// Removes the given operator from the contraint.
///
/// Calls of base class
/// .
/// The operator to remove.
public void RemoveOperator(IOperator op) {
groupConstraint.RemoveOperator(op);
FireChanged();
}
///
/// Checks whether the given element fulfills the current constraint.
///
/// The item to check.
/// true if the constraint could be fulfilled, false otherwise.
public override bool Check(IItem data) {
IOperator op = data as IOperator;
if(data == null) return false;
for(int i = 0; i < op.SubOperators.Count; i++) {
groupConstraint.SubOperatorIndex.Data = i;
if(groupConstraint.Check(data) == false) {
return false;
}
}
return true;
}
///
/// Empties the current instance.
///
public void Clear() {
groupConstraint.Clear();
}
///
/// Clones the current instance (deep clone).
///
/// Deep clone through method of helper class
/// .
/// Dictionary of all already clone objects. (Needed to avoid cycles.)
/// The cloned object as .
public override object Clone(IDictionary clonedObjects) {
AllSubOperatorsTypeConstraint clone = new AllSubOperatorsTypeConstraint();
clonedObjects.Add(Guid, clone);
clone.groupConstraint = (SubOperatorTypeConstraint)Auxiliary.Clone(groupConstraint, clonedObjects);
return clone;
}
///
/// Creates a new instance of to represent the current
/// instance visually.
///
/// The created view as .
public override IView CreateView() {
return new AllSubOperatorsTypeConstraintView(groupConstraint);
}
#region persistence
///
/// Saves the current instance as in the specified .
///
/// The sub-operators are saved as a child node with tag name
/// SubOperatorsGroupConstraint.
/// The (tag)name of the .
/// The where the data is saved.
/// The dictionary of all already persisted objects.
/// (Needed to avoid cycles.)
/// The saved .
public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary persistedObjects) {
XmlNode node = base.GetXmlNode(name, document, persistedObjects);
XmlNode subOperatorsNode = PersistenceManager.Persist("SubOperatorsGroupConstraint", groupConstraint, document, persistedObjects);
node.AppendChild(subOperatorsNode);
return node;
}
///
/// Loads the persisted constraint from the specified .
///
/// The constraint must be saved in a specific way, see for
/// more information.
/// The where the instance is saved.
/// The dictionary of all already restored objects.
/// (Needed to avoid cycles.)
public override void Populate(XmlNode node, IDictionary restoredObjects) {
base.Populate(node, restoredObjects);
groupConstraint = (SubOperatorTypeConstraint)PersistenceManager.Restore(node.SelectSingleNode("SubOperatorsGroupConstraint"), restoredObjects);
}
#endregion persistence
}
}