From 8189116ea4b5db4675e31dfd04a5687d55e29262 Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Tue, 6 May 2014 14:29:37 +0100 Subject: Added javadocs, made minor changes to the comments --- doc/jcgp/backend/modules/Module.html | 288 +++++++++++++++++++++++++++++++++++ 1 file changed, 288 insertions(+) create mode 100644 doc/jcgp/backend/modules/Module.html (limited to 'doc/jcgp/backend/modules/Module.html') diff --git a/doc/jcgp/backend/modules/Module.html b/doc/jcgp/backend/modules/Module.html new file mode 100644 index 0000000..b194964 --- /dev/null +++ b/doc/jcgp/backend/modules/Module.html @@ -0,0 +1,288 @@ + + + + + +Module + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
jcgp.backend.modules
+

Class Module

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    EvolutionaryStrategy, Mutator, Problem
    +
    +
    +
    +
    public abstract class Module
+extends java.lang.Object
    +
    This class defines the expected behaviour of a module. Generally, modules + are entities which contain parameters; these can be retrieved using + getLocalParameters(). GUIs should make use of this getter + to display visual parameter controls to users. Subclasses don't have direct + access to the list; instead they must use registerParameter() (ideally + in the constructor) to make sure the parameters are returned. +
    + In addition, implementations of Module should specify a module name + in their constructor using setName(). If a name is not provided, + the simple name of the class will be used. +
    + All modules, by definition, contain a reference to the experiment's resources, which + must be passed at construction. The resources should be accessed with getResources().
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    See Also:
    +
    Parameter
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.ArrayList<Parameter<?>>getLocalParameters() +
      This method is used by the GUI in order to build visual + representations of all parameters used by the module.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLocalParameters

        +
        public final java.util.ArrayList<Parameter<?>> getLocalParameters()
        +
        This method is used by the GUI in order to build visual + representations of all parameters used by the module. + Therefore, any parameters returned here will be displayed + visually.
        +
        +
        Returns:
        +
        a list of generic parameters exposed by the module.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + -- cgit v1.2.3