Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Constraints/ConstraintBase.cs @ 1181

Last change on this file since 1181 was 1176, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.BitVector and HeuristicLab.Constraints namespace and changed a comment in HeuristicLab.IntVector namespace(#331)

File size: 1.6 KB
RevLine 
[2]1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Text;
25using System.Xml;
26using HeuristicLab.Core;
27
28namespace HeuristicLab.Constraints {
[1176]29  /// <summary>
30  /// Base class for all constraints.
31  /// </summary>
[2]32  public abstract class ConstraintBase : ItemBase, IConstraint {
[1176]33    /// <inheritdoc select="summary"/>
[2]34    public virtual string Description {
35      get { return "No constraint description available."; }
36    }
37
[1176]38    /// <summary>
39    /// Checks whether the given data fulfills the current constraint.
40    /// </summary>
41    /// <param name="data">The item to check.</param>
42    /// <returns><c>true</c> if the constraint could be fulfilled, <c>false</c> otherwise.</returns>
[2]43    public abstract bool Check(IItem data);
44  }
45}
Note: See TracBrowser for help on using the repository browser.