jcgp.backend.modules

Class Module

java.lang.Object

jcgp.backend.modules.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

Modifier and Type	Method 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.String	toString()

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