Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/Interfaces/IConstraint.cs @ 797

Last change on this file since 797 was 776, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Core namespace (#331)

File size: 1.5 KB
Line 
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;
25
26namespace HeuristicLab.Core {
27  /// <summary>
28  /// Interface to represent restrictions.
29  /// </summary>
30  public interface IConstraint : IItem {
31    /// <summary>
32    /// Gets the description of the current instance.
33    /// </summary>
34    string Description { get; }
35
36    /// <summary>
37    /// Checks whether the given <paramref name="data"/> fulfills the current constraint.
38    /// </summary>
39    /// <param name="data">The item to check.</param>
40    /// <returns><c>true</c> if the current instance could be fulfilled, <c>false</c> otherwise.</returns>
41    bool Check(IItem data);
42  }
43}
Note: See TracBrowser for help on using the repository browser.