From 4f26361eb08aa09334d1eea0a124110c20d809ce Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Sat, 18 Oct 2014 15:21:45 +0200 Subject: Moved javadocs to a different repository for hosting, updated README --- doc/jcgp/backend/parameters/BooleanParameter.html | 394 ----------------- doc/jcgp/backend/parameters/DoubleParameter.html | 394 ----------------- doc/jcgp/backend/parameters/IntegerParameter.html | 394 ----------------- doc/jcgp/backend/parameters/Parameter.html | 466 --------------------- doc/jcgp/backend/parameters/ParameterStatus.html | 432 ------------------- .../parameters/class-use/BooleanParameter.html | 167 -------- .../parameters/class-use/DoubleParameter.html | 167 -------- .../parameters/class-use/IntegerParameter.html | 237 ----------- .../backend/parameters/class-use/Parameter.html | 267 ------------ .../parameters/class-use/ParameterStatus.html | 177 -------- .../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 ------ doc/jcgp/backend/parameters/package-frame.html | 27 -- doc/jcgp/backend/parameters/package-summary.html | 179 -------- doc/jcgp/backend/parameters/package-tree.html | 155 ------- doc/jcgp/backend/parameters/package-use.html | 263 ------------ 24 files changed, 5655 deletions(-) delete mode 100644 doc/jcgp/backend/parameters/BooleanParameter.html delete mode 100644 doc/jcgp/backend/parameters/DoubleParameter.html delete mode 100644 doc/jcgp/backend/parameters/IntegerParameter.html delete mode 100644 doc/jcgp/backend/parameters/Parameter.html delete mode 100644 doc/jcgp/backend/parameters/ParameterStatus.html delete mode 100644 doc/jcgp/backend/parameters/class-use/BooleanParameter.html delete mode 100644 doc/jcgp/backend/parameters/class-use/DoubleParameter.html delete mode 100644 doc/jcgp/backend/parameters/class-use/IntegerParameter.html delete mode 100644 doc/jcgp/backend/parameters/class-use/Parameter.html delete mode 100644 doc/jcgp/backend/parameters/class-use/ParameterStatus.html delete mode 100644 doc/jcgp/backend/parameters/monitors/BooleanMonitor.html delete mode 100644 doc/jcgp/backend/parameters/monitors/DoubleMonitor.html delete mode 100644 doc/jcgp/backend/parameters/monitors/IntegerMonitor.html delete mode 100644 doc/jcgp/backend/parameters/monitors/class-use/BooleanMonitor.html delete mode 100644 doc/jcgp/backend/parameters/monitors/class-use/DoubleMonitor.html delete mode 100644 doc/jcgp/backend/parameters/monitors/class-use/IntegerMonitor.html delete mode 100644 doc/jcgp/backend/parameters/monitors/package-frame.html delete mode 100644 doc/jcgp/backend/parameters/monitors/package-summary.html delete mode 100644 doc/jcgp/backend/parameters/monitors/package-tree.html delete mode 100644 doc/jcgp/backend/parameters/monitors/package-use.html delete mode 100644 doc/jcgp/backend/parameters/package-frame.html delete mode 100644 doc/jcgp/backend/parameters/package-summary.html delete mode 100644 doc/jcgp/backend/parameters/package-tree.html delete mode 100644 doc/jcgp/backend/parameters/package-use.html (limited to 'doc/jcgp/backend/parameters') diff --git a/doc/jcgp/backend/parameters/BooleanParameter.html b/doc/jcgp/backend/parameters/BooleanParameter.html deleted file mode 100644 index 01f89aa..0000000 --- a/doc/jcgp/backend/parameters/BooleanParameter.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - -BooleanParameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
jcgp.backend.parameters
-

Class BooleanParameter

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    BooleanMonitor
    -
    -
    -
    -
    public class BooleanParameter
-extends Parameter<java.lang.Boolean>
    -
    Parameter subclass for the boolean type. Most of the - functionality is already implemented in Parameter, - leaving only construction and type definition to the - subclasses. -

    - This class contains three constructors, two of which are public. - One assumes the parameter is not critical and only takes a name - and initial value, while the other allows the critical flag - to be set as well. The third constructor is protected and allows - the monitor flag to be set as well, allowing subclasses of this class - to be used as monitors. See BooleanMonitor for an example - of this usage. -

    - The validate method is overridden here and left blank since not all - parameters actually require validation, but where validation is - required this method can be anonymously overridden on an instance-to-instance - basis.
    -
    -
    Author:
    -
    Eduardo Pedroni
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

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

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Booleanget() 
      voidvalidate(java.lang.Boolean newValue) -
      This is a callback method which gets called whenever changes - to parameters (not only its own instance) are made.
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        BooleanParameter

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

        BooleanParameter

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

      Method Detail

      - - - -
        -
      • -

        get

        -
        public java.lang.Boolean get()
        -
        -
        Overrides:
        -
        get in class Parameter<java.lang.Boolean>
        -
        Returns:
        -
        the parameter's current value.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        Specified by:
        -
        validate in class Parameter<java.lang.Boolean>
        -
        Parameters:
        -
        newValue - the new value.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/DoubleParameter.html b/doc/jcgp/backend/parameters/DoubleParameter.html deleted file mode 100644 index a70dda0..0000000 --- a/doc/jcgp/backend/parameters/DoubleParameter.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - -DoubleParameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
jcgp.backend.parameters
-

Class DoubleParameter

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    DoubleMonitor
    -
    -
    -
    -
    public class DoubleParameter
-extends Parameter<java.lang.Number>
    -
    Parameter subclass for the double type. Most of the - functionality is already implemented in Parameter, - leaving only construction and type definition to the - subclasses. -

    - This class contains three constructors, two of which are public. - One assumes the parameter is not critical and only takes a name - and initial value, while the other allows the critical flag - to be set as well. The third constructor is protected and allows - the monitor flag to be set as well, allowing subclasses of this class - to be used as monitors. See DoubleMonitor for an example - of this usage. -

    - The validate method is overridden here and left blank since not all - parameters actually require validation, but where validation is - required this method can be anonymously overridden on an instance-to-instance - basis.
    -
    -
    Author:
    -
    Eduardo Pedroni
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

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

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Doubleget() 
      voidvalidate(java.lang.Number newValue) -
      This is a callback method which gets called whenever changes - to parameters (not only its own instance) are made.
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        DoubleParameter

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

        DoubleParameter

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

      Method Detail

      - - - -
        -
      • -

        get

        -
        public java.lang.Double get()
        -
        -
        Overrides:
        -
        get in class Parameter<java.lang.Number>
        -
        Returns:
        -
        the parameter's current value.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        Specified by:
        -
        validate in class Parameter<java.lang.Number>
        -
        Parameters:
        -
        newValue - the new value.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/IntegerParameter.html b/doc/jcgp/backend/parameters/IntegerParameter.html deleted file mode 100644 index 90dad47..0000000 --- a/doc/jcgp/backend/parameters/IntegerParameter.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - -IntegerParameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
jcgp.backend.parameters
-

Class IntegerParameter

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    IntegerMonitor
    -
    -
    -
    -
    public class IntegerParameter
-extends Parameter<java.lang.Number>
    -
    Parameter subclass for the double type. Most of the - functionality is already implemented in Parameter, - leaving only construction and type definition to the - subclasses. -

    - This class contains three constructors, two of which are public. - One assumes the parameter is not critical and only takes a name - and initial value, while the other allows the critical flag - to be set as well. The third constructor is protected and allows - the monitor flag to be set as well, allowing subclasses of this class - to be used as monitors. See IntegerMonitor for an example - of this usage. -

    - The validate method is overridden here and left blank since not all - parameters actually require validation, but where validation is - required this method can be anonymously overridden on an instance-to-instance - basis.
    -
    -
    Author:
    -
    Eduardo Pedroni
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

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

      Method Summary

      - - - - - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Integerget() 
      voidvalidate(java.lang.Number newValue) -
      This is a callback method which gets called whenever changes - to parameters (not only its own instance) are made.
      -
      - -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        IntegerParameter

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

        IntegerParameter

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

      Method Detail

      - - - -
        -
      • -

        get

        -
        public java.lang.Integer get()
        -
        -
        Overrides:
        -
        get in class Parameter<java.lang.Number>
        -
        Returns:
        -
        the parameter's current value.
        -
        -
        • -
      - - - -
        -
      • -

        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.
        -
        -
        Specified by:
        -
        validate in class Parameter<java.lang.Number>
        -
        Parameters:
        -
        newValue - the new value.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/Parameter.html b/doc/jcgp/backend/parameters/Parameter.html deleted file mode 100644 index a8b21a1..0000000 --- a/doc/jcgp/backend/parameters/Parameter.html +++ /dev/null @@ -1,466 +0,0 @@ - - - - - -Parameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
jcgp.backend.parameters
-

Class Parameter<T>

-
-
- -
-
    -
  • -
    -
    Type Parameters:
    -
    T - the data type stored in the parameter.
    -
    -
    -
    Direct Known Subclasses:
    -
    BooleanParameter, DoubleParameter, IntegerParameter
    -
    -
    -
    -
    public abstract class Parameter<T>
-extends java.lang.Object
    -
    Specifies an abstract model of a module parameter. -

    - Parameters are values which control the operation of modules. - They can be freely modified and accessed by the module in which - they are declared. Additionally, the module may choose to expose - some of its parameters to a user interface, so that information - is displayed. If that is the case, the parameter can be made - read-only by setting the monitor flag (it becomes a parameter - monitor). In addition, settings the critical flag indicates to - the experiment that any changes to the parameter should result in - an experiment-wide reset. -

    - Parameter is abstract. A typical implementation defines - the data type T and initialises the valueProperty field - with a suitable type. For the sake of clarity, it may not be ideal - for a subclass constructor to expose an argument for the monitor - field. Instead, a different class should be created which constructs - the parameter as a monitor, so that the distinction between a regular - parameter and a parameter monitor is more apparent. The boolean, integer - and double implementations of parameter (and their associated monitors) - implement this pattern, refer to them for more details. -

    - The status field holds the current status of the parameter, - which should change whenever the parameter value changes. - In order for this to happen, validate() is called whenever - the parameter status should be updated. This being the case, it should - be overridden on an instance-to-instance basis, as each parameter - will likely have different validity criteria. The type of status is - ParameterStatus, an enum type defining all valid states.
    -
    -
    Author:
    -
    Eduardo Pedroni
    -
    See Also:
    -
    Module
    -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Property Summary

      - - - - - - - - - - -
      All Methods Instance Methods Concrete Methods 
      TypeProperty and Description
      javafx.beans.property.ReadOnlyProperty<T>value -
      This method is intended for bindings only.
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      Tget() 
      ParameterStatusgetStatus() 
      booleanisCritical() 
      booleanisMonitor() 
      voidset(T newValue) -
      Sets the parameter to the specified value, if the property - is not bound.
      -
      java.lang.StringtoString() 
      abstract voidvalidate(T newValue) -
      This is a callback method which gets called whenever changes - to parameters (not only its own instance) are made.
      -
      javafx.beans.property.ReadOnlyProperty<T>valueProperty() -
      This method is intended for bindings only.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Property Detail

      - - - -
        -
      • -

        value

        -
        public javafx.beans.property.ReadOnlyProperty<T> valueProperty
        -
        This method is intended for bindings only. Changes to the parameter - value should be made using set().
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isMonitor

        -
        public boolean isMonitor()
        -
        -
        Returns:
        -
        true if the parameter is a monitor.
        -
        -
        • -
      - - - -
        -
      • -

        isCritical

        -
        public boolean isCritical()
        -
        -
        Returns:
        -
        true if the parameter is critical.
        -
        -
        • -
      - - - -
        -
      • -

        getStatus

        -
        public ParameterStatus getStatus()
        -
        -
        Returns:
        -
        the current status of the parameter.
        -
        -
        • -
      - - - -
        -
      • -

        valueProperty

        -
        public javafx.beans.property.ReadOnlyProperty<T> valueProperty()
        -
        This method is intended for bindings only. Changes to the parameter - value should be made using set().
        -
        • -
      - - - -
        -
      • -

        get

        -
        public T get()
        -
        -
        Returns:
        -
        the parameter's current value.
        -
        -
        • -
      - - - - - -
        -
      • -

        set

        -
        public void set(T newValue)
        -
        Sets the parameter to the specified value, if the property - is not bound.
        -
        -
        Parameters:
        -
        newValue - the new value for the parameter.
        -
        -
        • -
      - - - - - -
        -
      • -

        validate

        -
        public abstract void validate(T newValue)
        -
        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.
        -
        -
        Parameters:
        -
        newValue - the new value.
        -
        -
        • -
      - - - -
        -
      • -

        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
    • -
-
- - -
- - - diff --git a/doc/jcgp/backend/parameters/ParameterStatus.html b/doc/jcgp/backend/parameters/ParameterStatus.html deleted file mode 100644 index 981df8e..0000000 --- a/doc/jcgp/backend/parameters/ParameterStatus.html +++ /dev/null @@ -1,432 +0,0 @@ - - - - - -ParameterStatus - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
jcgp.backend.parameters
-

Enum ParameterStatus

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, java.lang.Comparable<ParameterStatus>
    -
    -
    -
    -
    public enum ParameterStatus
-extends java.lang.Enum<ParameterStatus>
    -
    Enum type containing all possible states for parameters. -
    -
      -
    • INVALID: the new parameter value is not valid, - and the experiment will not be allowed to run.
      • -
    • WARNING: the new parameter value is technically valid, - though it might lead to undesirable behaviour.
      • -
    • WARNING_RESET: the new parameter value is technically valid - but will require a reset.
      • -
    • VALID: the new value is valid.
      • -
    -

    - The above definitions are final in the sense that they outline - how parameters are treated by the program depending on their - status (e.g. if any parameters are set to WARNING_RESET, a reset - will automatically be performed when the experiment is run). -
    - In addition to the status itself, this class includes a field - to contain details about the current status. If a GUI is in use, - the contents of the field should be displayed to the user, as well - as some visual indication of the status itself. Both the status - and the message should be updated by each parameter when validate() - is called.
    -
    -
    Author:
    -
    Eduardo Pedroni
    -
    See Also:
    -
    Parameter
    -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDetails() 
      voidsetDetails(java.lang.String details) -
      Sets a new string containing details about the current status.
      -
      static ParameterStatusvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static ParameterStatus[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static ParameterStatus[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (ParameterStatus c : ParameterStatus.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static ParameterStatus valueOf(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        -
        • -
      - - - -
        -
      • -

        setDetails

        -
        public void setDetails(java.lang.String details)
        -
        Sets a new string containing details about the current status. - This should be displayed by the GUI, if one is in use.
        -
        -
        Parameters:
        -
        details - an explanation of the current status.
        -
        -
        • -
      - - - -
        -
      • -

        getDetails

        -
        public java.lang.String getDetails()
        -
        -
        Returns:
        -
        the string containing details about the current status.
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/class-use/BooleanParameter.html b/doc/jcgp/backend/parameters/class-use/BooleanParameter.html deleted file mode 100644 index 386d503..0000000 --- a/doc/jcgp/backend/parameters/class-use/BooleanParameter.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - -Uses of Class jcgp.backend.parameters.BooleanParameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
jcgp.backend.parameters.BooleanParameter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/class-use/DoubleParameter.html b/doc/jcgp/backend/parameters/class-use/DoubleParameter.html deleted file mode 100644 index df857bf..0000000 --- a/doc/jcgp/backend/parameters/class-use/DoubleParameter.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - -Uses of Class jcgp.backend.parameters.DoubleParameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
jcgp.backend.parameters.DoubleParameter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/class-use/IntegerParameter.html b/doc/jcgp/backend/parameters/class-use/IntegerParameter.html deleted file mode 100644 index 5e94d72..0000000 --- a/doc/jcgp/backend/parameters/class-use/IntegerParameter.html +++ /dev/null @@ -1,237 +0,0 @@ - - - - - -Uses of Class jcgp.backend.parameters.IntegerParameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
jcgp.backend.parameters.IntegerParameter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/class-use/Parameter.html b/doc/jcgp/backend/parameters/class-use/Parameter.html deleted file mode 100644 index e0d0f71..0000000 --- a/doc/jcgp/backend/parameters/class-use/Parameter.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - -Uses of Class jcgp.backend.parameters.Parameter - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
jcgp.backend.parameters.Parameter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/class-use/ParameterStatus.html b/doc/jcgp/backend/parameters/class-use/ParameterStatus.html deleted file mode 100644 index 91a8173..0000000 --- a/doc/jcgp/backend/parameters/class-use/ParameterStatus.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - -Uses of Class jcgp.backend.parameters.ParameterStatus - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
jcgp.backend.parameters.ParameterStatus

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/monitors/BooleanMonitor.html b/doc/jcgp/backend/parameters/monitors/BooleanMonitor.html deleted file mode 100644 index 57f9d6d..0000000 --- a/doc/jcgp/backend/parameters/monitors/BooleanMonitor.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - -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 deleted file mode 100644 index e0927ab..0000000 --- a/doc/jcgp/backend/parameters/monitors/DoubleMonitor.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - -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 deleted file mode 100644 index 1c9586e..0000000 --- a/doc/jcgp/backend/parameters/monitors/IntegerMonitor.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - -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 deleted file mode 100644 index 59af8c2..0000000 --- a/doc/jcgp/backend/parameters/monitors/class-use/BooleanMonitor.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - -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 deleted file mode 100644 index e8d0745..0000000 --- a/doc/jcgp/backend/parameters/monitors/class-use/DoubleMonitor.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - -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 deleted file mode 100644 index 6398f39..0000000 --- a/doc/jcgp/backend/parameters/monitors/class-use/IntegerMonitor.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - -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 deleted file mode 100644 index 0ebd3fb..0000000 --- a/doc/jcgp/backend/parameters/monitors/package-frame.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - -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 deleted file mode 100644 index c036c87..0000000 --- a/doc/jcgp/backend/parameters/monitors/package-summary.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - -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 deleted file mode 100644 index 3f95210..0000000 --- a/doc/jcgp/backend/parameters/monitors/package-tree.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - -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 deleted file mode 100644 index 1b1cfcd..0000000 --- a/doc/jcgp/backend/parameters/monitors/package-use.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - -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
- - - - -
-
- - - -
- -
- - -
- - - diff --git a/doc/jcgp/backend/parameters/package-frame.html b/doc/jcgp/backend/parameters/package-frame.html deleted file mode 100644 index 0b3275e..0000000 --- a/doc/jcgp/backend/parameters/package-frame.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - -jcgp.backend.parameters - - - - - -

jcgp.backend.parameters

-
-

Classes

- -

Enums

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

Package jcgp.backend.parameters

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

Hierarchy For Package jcgp.backend.parameters

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

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

Uses of Package
jcgp.backend.parameters

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- - - -- cgit v1.2.3