source: branches/2994-AutoDiffForIntervals/HeuristicLab.Core/3.3/Attributes/CreatableAttribute.cs @ 17209

Last change on this file since 17209 was 17209, checked in by gkronber, 5 weeks ago

#2994: merged r17132:17198 from trunk to branch

File size: 4.8 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 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.Linq;
25
26namespace HeuristicLab.Core {
27  [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
28  public sealed class CreatableAttribute : Attribute {
29    #region Predefined Categories
30    public static class Categories {
31      public const string SplitToken = "###";
32      public const string OrderToken = "$$$";
33
34      public const string Algorithms = "1" + OrderToken + "Algorithms";
35      public const string PopulationBasedAlgorithms = Algorithms + SplitToken + "1" + OrderToken + "Population Based";
36      public const string SingleSolutionAlgorithms = Algorithms + SplitToken + "2" + OrderToken + "Single Solution";
37      public const string ExactAlgorithms = Algorithms + SplitToken + "3" + OrderToken + "Exact";
38
39      public const string Problems = "2" + OrderToken + "Problems";
40      public const string CombinatorialProblems = Problems + SplitToken + "1" + OrderToken + "Combinatorial";
41      public const string GeneticProgrammingProblems = Problems + SplitToken + "2" + OrderToken + "Genetic Programming";
42      public const string ExternalEvaluationProblems = Problems + SplitToken + "3" + OrderToken + "External Evaluation";
43
44      public const string DataAnalysis = "3" + OrderToken + "Data Analysis";
45      public const string DataAnalysisRegression = DataAnalysis + SplitToken + "1" + OrderToken + "Regression";
46      public const string DataAnalysisClassification = DataAnalysis + SplitToken + "2" + OrderToken + "Classification";
47      public const string DataAnalysisEnsembles = DataAnalysis + SplitToken + "3" + OrderToken + "Ensembles";
48
49      public const string TestingAndAnalysis = "4" + OrderToken + "Testing & Analysis";
50      public const string TestingAndAnalysisOKB = TestingAndAnalysis + SplitToken + "1" + OrderToken + "OKB";
51
52      public const string Scripts = "5" + OrderToken + "Scripts";
53
54      public static string GetFullName(string rawName) {
55        return string.Join(SplitToken, GetTokens(rawName));
56      }
57      public static string GetName(string rawName) {
58        return GetTokens(rawName).Last();
59      }
60      public static IEnumerable<string> GetParentRawNames(string rawName) {
61        var tokens = GetTokensWithOrdering(rawName).ToList();
62        return tokens.Take(tokens.Count - 1);
63      }
64      private static IEnumerable<string> GetTokensWithOrdering(string rawName) {
65        return rawName.Split(new[] { SplitToken }, StringSplitOptions.RemoveEmptyEntries);
66      }
67      private static IEnumerable<string> GetTokens(string rawName) {
68        return GetTokensWithOrdering(rawName)
69          .Select(t => t.Split(new[] { OrderToken }, StringSplitOptions.RemoveEmptyEntries).Last());
70      }
71    }
72    #endregion
73
74    private string category;
75    public string Category {
76      get {
77        return category;
78      }
79      set {
80        if (value == null) throw new ArgumentNullException("Category", "CreataleAttribute.Category must not be null");
81        category = value;
82      }
83    }
84
85    public int Priority { get; set; }
86
87    public CreatableAttribute() {
88      Category = "Other Items";
89      Priority = int.MaxValue;
90    }
91    public CreatableAttribute(string category)
92      : this() {
93      Category = category;
94    }
95
96    public static bool IsCreatable(Type type) {
97      object[] attribs = type.GetCustomAttributes(typeof(CreatableAttribute), false);
98      return attribs.Length > 0;
99    }
100    public static string GetCategory(Type type) {
101      object[] attribs = type.GetCustomAttributes(typeof(CreatableAttribute), false);
102      if (attribs.Length > 0) return ((CreatableAttribute)attribs[0]).Category;
103      else return null;
104    }
105    public static int GetPriority(Type type) {
106      var attribs = type.GetCustomAttributes(typeof(CreatableAttribute), false);
107      if (attribs.Length > 0) return ((CreatableAttribute)attribs[0]).Priority;
108      else return int.MaxValue;
109    }
110  }
111}
Note: See TracBrowser for help on using the repository browser.