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/parsers/FunctionParser.html | 301 +++++++++++++++++++++++++++ 1 file changed, 301 insertions(+) create mode 100644 doc/jcgp/backend/parsers/FunctionParser.html (limited to 'doc/jcgp/backend/parsers/FunctionParser.html') diff --git a/doc/jcgp/backend/parsers/FunctionParser.html b/doc/jcgp/backend/parsers/FunctionParser.html new file mode 100644 index 0000000..f7ef21c --- /dev/null +++ b/doc/jcgp/backend/parsers/FunctionParser.html @@ -0,0 +1,301 @@ + + + + + +FunctionParser + + + + + + + + +
+ + + + + + + +
+ + + +
+
jcgp.backend.parsers
+

Class FunctionParser

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class FunctionParser
    +extends java.lang.Object
    +
    Contains a static method for parsing functions from a + .par file.
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FunctionParser() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidparse(java.io.File file, + FunctionSet functionSet, + Resources resources) +
      Reads the specified file and attempts to enable + and disable the functions in the FunctionSet + accordingly.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        FunctionParser

        +
        public FunctionParser()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parse

        +
        public static void parse(java.io.File file,
        +                         FunctionSet functionSet,
        +                         Resources resources)
        +
        Reads the specified file and attempts to enable + and disable the functions in the FunctionSet + accordingly. +

        + Standard CGP .par files do not contain enough information + to determine if they match the currently selected function set. + For this reason, the parser assumes the function set is correct + and treats functions by their index rather than their name. Any + index outside the bounds of the function set is ignored and a + warning message is printed once parsing is complete.
        +
        +
        Parameters:
        +
        file - the .par file to parse.
        +
        functionSet - the function set whose functions should be modified.
        +
        resources - used for printing console messages.
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + -- cgit v1.2.3