com.azalient.api.uf
Enum UserDefinedFollowingParameter

java.lang.Object
  java.lang.Enum<UserDefinedFollowingParameter>
      com.azalient.api.uf.UserDefinedFollowingParameter

All Implemented Interfaces:

Serializable, Comparable<UserDefinedFollowingParameter>

public enum UserDefinedFollowingParameter
extends Enum<UserDefinedFollowingParameter>

An example of parameters for a user-defined following model.

 public enum UserDefinedFollowingParameter
{
        Name("Name", 0),  // Not used in model, but required for GUI to work correctly

        A("Parameter A", 1.25),
        B("Parameter B", 2.5),
        C("Parameter C", -123),
        D("Parameter D", 0.00001),

        ;

        private final String description;
        private double value; 
        private double stdValue; 
        private UserDefinedFollowingParameter(String d, double v)
        {
            description = d;
            value = v;
            stdValue = v;
        }


        public final String description() { return description; }
        public final double value() { return value; }
        public final void value(double v) { value = v; }

        public static final void reset() 
        {
            for (UserDefinedFollowingParameter wp: values()) wp.value = wp.stdValue;
        }


        // Return false to get rid of label at bottom of UI window
        public static boolean showLabel() { return true; }
}
  

Enum Constant Summary

A

B

C

D

Name

Method Summary

String	description()
static void	reset()
static boolean	showLabel()
double	value()
void	value(double v)
static UserDefinedFollowingParameter	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserDefinedFollowingParameter[]	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

Enum Constant Detail

Name

public static final UserDefinedFollowingParameter Name

A

public static final UserDefinedFollowingParameter A

B

public static final UserDefinedFollowingParameter B

C

public static final UserDefinedFollowingParameter C

D

public static final UserDefinedFollowingParameter D

Method Detail

values

public static UserDefinedFollowingParameter[] 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 (UserDefinedFollowingParameter c : UserDefinedFollowingParameter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static UserDefinedFollowingParameter valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

description

public final String description()

value

public final double value()

value

public final void value(double v)

reset

public static final void reset()

showLabel

public static boolean showLabel()