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 --- .../parameters/monitors/BooleanMonitor.html | 368 +++++++++++++++++++++ .../backend/parameters/monitors/DoubleMonitor.html | 368 +++++++++++++++++++++ .../parameters/monitors/IntegerMonitor.html | 368 +++++++++++++++++++++ .../monitors/class-use/BooleanMonitor.html | 124 +++++++ .../monitors/class-use/DoubleMonitor.html | 124 +++++++ .../monitors/class-use/IntegerMonitor.html | 124 +++++++ .../backend/parameters/monitors/package-frame.html | 22 ++ .../parameters/monitors/package-summary.html | 159 +++++++++ .../backend/parameters/monitors/package-tree.html | 155 +++++++++ .../backend/parameters/monitors/package-use.html | 124 +++++++ 10 files changed, 1936 insertions(+) create mode 100644 doc/jcgp/backend/parameters/monitors/BooleanMonitor.html create mode 100644 doc/jcgp/backend/parameters/monitors/DoubleMonitor.html create mode 100644 doc/jcgp/backend/parameters/monitors/IntegerMonitor.html create mode 100644 doc/jcgp/backend/parameters/monitors/class-use/BooleanMonitor.html create mode 100644 doc/jcgp/backend/parameters/monitors/class-use/DoubleMonitor.html create mode 100644 doc/jcgp/backend/parameters/monitors/class-use/IntegerMonitor.html create mode 100644 doc/jcgp/backend/parameters/monitors/package-frame.html create mode 100644 doc/jcgp/backend/parameters/monitors/package-summary.html create mode 100644 doc/jcgp/backend/parameters/monitors/package-tree.html create mode 100644 doc/jcgp/backend/parameters/monitors/package-use.html (limited to 'doc/jcgp/backend/parameters/monitors') diff --git a/doc/jcgp/backend/parameters/monitors/BooleanMonitor.html b/doc/jcgp/backend/parameters/monitors/BooleanMonitor.html new file mode 100644 index 0000000..7b20189 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/BooleanMonitor.html @@ -0,0 +1,368 @@ + + + + + +BooleanMonitor + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parameters.monitors
+

Class BooleanMonitor

+
+
+ +
+
    +
  • +
    +
    +
    public class BooleanMonitor
+extends BooleanParameter
    +
    This is a special type of BooleanParameter which + cannot be modified in the GUI (if the GUI is in use).
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      BooleanMonitor(boolean value, + java.lang.String name) +
      Creates a new instance of this class, assuming the monitor + is not critical.
      +
      BooleanMonitor(boolean value, + java.lang.String name, + boolean critical) +
      Creates a new instance of this class.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BooleanMonitor

        +
        public BooleanMonitor(boolean value,
+                      java.lang.String name)
        +
        Creates a new instance of this class, assuming the monitor + is not critical.
        +
        +
        Parameters:
        +
        value - the initial value for this monitor.
        +
        name - the name of this monitor, for GUI display.
        +
        +
        • +
      + + + +
        +
      • +

        BooleanMonitor

        +
        public BooleanMonitor(boolean value,
+                      java.lang.String name,
+                      boolean critical)
        +
        Creates a new instance of this class.
        +
        +
        Parameters:
        +
        value - the initial value for this monitor.
        +
        name - the name of this monitor, for GUI display.
        +
        critical - true if the monitor is critical.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validate

        +
        public void validate(java.lang.Boolean newValue)
        +
        Description copied from class: Parameter
        +
        This is a callback method which gets called whenever changes + to parameters (not only its own instance) are made. This method + is intended to set the status field according to the + new value, so that the user can be informed if any parameters + are currently set to invalid values.
        +
        +
        Overrides:
        +
        validate in class BooleanParameter
        +
        Parameters:
        +
        newValue - the new value.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/DoubleMonitor.html b/doc/jcgp/backend/parameters/monitors/DoubleMonitor.html new file mode 100644 index 0000000..6c04a90 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/DoubleMonitor.html @@ -0,0 +1,368 @@ + + + + + +DoubleMonitor + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parameters.monitors
+

Class DoubleMonitor

+
+
+ +
+
    +
  • +
    +
    +
    public class DoubleMonitor
+extends DoubleParameter
    +
    This is a special type of DoubleParameter which + cannot be modified in the GUI (if the GUI is in use).
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      DoubleMonitor(double value, + java.lang.String name) +
      Creates a new instance of this class, assuming the monitor + is not critical.
      +
      DoubleMonitor(double value, + java.lang.String name, + boolean critical) +
      Creates a new instance of this class.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DoubleMonitor

        +
        public DoubleMonitor(double value,
+                     java.lang.String name)
        +
        Creates a new instance of this class, assuming the monitor + is not critical.
        +
        +
        Parameters:
        +
        value - the initial value for this monitor.
        +
        name - the name of this monitor, for GUI display.
        +
        +
        • +
      + + + +
        +
      • +

        DoubleMonitor

        +
        public DoubleMonitor(double value,
+                     java.lang.String name,
+                     boolean critical)
        +
        Creates a new instance of this class.
        +
        +
        Parameters:
        +
        value - the initial value for this monitor.
        +
        name - the name of this monitor, for GUI display.
        +
        critical - true if the monitor is critical.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validate

        +
        public void validate(java.lang.Number newValue)
        +
        Description copied from class: Parameter
        +
        This is a callback method which gets called whenever changes + to parameters (not only its own instance) are made. This method + is intended to set the status field according to the + new value, so that the user can be informed if any parameters + are currently set to invalid values.
        +
        +
        Overrides:
        +
        validate in class DoubleParameter
        +
        Parameters:
        +
        newValue - the new value.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/IntegerMonitor.html b/doc/jcgp/backend/parameters/monitors/IntegerMonitor.html new file mode 100644 index 0000000..9ebc2d8 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/IntegerMonitor.html @@ -0,0 +1,368 @@ + + + + + +IntegerMonitor + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
jcgp.backend.parameters.monitors
+

Class IntegerMonitor

+
+
+ +
+
    +
  • +
    +
    +
    public class IntegerMonitor
+extends IntegerParameter
    +
    This is a special type of IntegerParameter which + cannot be modified in the GUI (if the GUI is in use).
    +
    +
    Author:
    +
    Eduardo Pedroni
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      IntegerMonitor(int value, + java.lang.String name) +
      Creates a new instance of this class, assuming the monitor + is not critical.
      +
      IntegerMonitor(int value, + java.lang.String name, + boolean critical) +
      Creates a new instance of this class.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IntegerMonitor

        +
        public IntegerMonitor(int value,
+                      java.lang.String name)
        +
        Creates a new instance of this class, assuming the monitor + is not critical.
        +
        +
        Parameters:
        +
        value - the initial value for this monitor.
        +
        name - the name of this monitor, for GUI display.
        +
        +
        • +
      + + + +
        +
      • +

        IntegerMonitor

        +
        public IntegerMonitor(int value,
+                      java.lang.String name,
+                      boolean critical)
        +
        Creates a new instance of this class.
        +
        +
        Parameters:
        +
        value - the initial value for this monitor.
        +
        name - the name of this monitor, for GUI display.
        +
        critical - true if the monitor is critical.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        validate

        +
        public void validate(java.lang.Number newValue)
        +
        Description copied from class: Parameter
        +
        This is a callback method which gets called whenever changes + to parameters (not only its own instance) are made. This method + is intended to set the status field according to the + new value, so that the user can be informed if any parameters + are currently set to invalid values.
        +
        +
        Overrides:
        +
        validate in class IntegerParameter
        +
        Parameters:
        +
        newValue - the new value.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/class-use/BooleanMonitor.html b/doc/jcgp/backend/parameters/monitors/class-use/BooleanMonitor.html new file mode 100644 index 0000000..abda05b --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/class-use/BooleanMonitor.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.parameters.monitors.BooleanMonitor + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.backend.parameters.monitors.BooleanMonitor

+
+
No usage of jcgp.backend.parameters.monitors.BooleanMonitor
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/class-use/DoubleMonitor.html b/doc/jcgp/backend/parameters/monitors/class-use/DoubleMonitor.html new file mode 100644 index 0000000..4b51550 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/class-use/DoubleMonitor.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.parameters.monitors.DoubleMonitor + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.backend.parameters.monitors.DoubleMonitor

+
+
No usage of jcgp.backend.parameters.monitors.DoubleMonitor
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/class-use/IntegerMonitor.html b/doc/jcgp/backend/parameters/monitors/class-use/IntegerMonitor.html new file mode 100644 index 0000000..a103997 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/class-use/IntegerMonitor.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class jcgp.backend.parameters.monitors.IntegerMonitor + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
jcgp.backend.parameters.monitors.IntegerMonitor

+
+
No usage of jcgp.backend.parameters.monitors.IntegerMonitor
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/package-frame.html b/doc/jcgp/backend/parameters/monitors/package-frame.html new file mode 100644 index 0000000..af63177 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/package-frame.html @@ -0,0 +1,22 @@ + + + + + +jcgp.backend.parameters.monitors + + + + + +

jcgp.backend.parameters.monitors

+
+

Classes

+ +
+ + diff --git a/doc/jcgp/backend/parameters/monitors/package-summary.html b/doc/jcgp/backend/parameters/monitors/package-summary.html new file mode 100644 index 0000000..d7b074c --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/package-summary.html @@ -0,0 +1,159 @@ + + + + + +jcgp.backend.parameters.monitors + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package jcgp.backend.parameters.monitors

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/package-tree.html b/doc/jcgp/backend/parameters/monitors/package-tree.html new file mode 100644 index 0000000..3b96ca8 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/package-tree.html @@ -0,0 +1,155 @@ + + + + + +jcgp.backend.parameters.monitors Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package jcgp.backend.parameters.monitors

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/jcgp/backend/parameters/monitors/package-use.html b/doc/jcgp/backend/parameters/monitors/package-use.html new file mode 100644 index 0000000..c6ae683 --- /dev/null +++ b/doc/jcgp/backend/parameters/monitors/package-use.html @@ -0,0 +1,124 @@ + + + + + +Uses of Package jcgp.backend.parameters.monitors + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
jcgp.backend.parameters.monitors

+
+
No usage of jcgp.backend.parameters.monitors
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3