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 --- .../backend/parameters/monitors/DoubleMonitor.html | 368 +++++++++++++++++++++ 1 file changed, 368 insertions(+) create mode 100644 doc/jcgp/backend/parameters/monitors/DoubleMonitor.html (limited to 'doc/jcgp/backend/parameters/monitors/DoubleMonitor.html') 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
    • +
+ +
+ + +
+ + + -- cgit v1.2.3