org.ginsim.service.tool.composition

Enum IntegrationFunction

java.lang.Object

java.lang.Enum<IntegrationFunction>

org.ginsim.service.tool.composition.IntegrationFunction

All Implemented Interfaces:

Serializable, Comparable<IntegrationFunction>

public enum IntegrationFunction
extends Enum<IntegrationFunction>

The enumeration of all prototypical Integration functions

Author:

Nuno D. Mendes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntegrationFunction.IntegrationFunctionReification

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND
MAX
MAX_LEFT
MAX_RIGHT
MIN
OR
THRESHOLD2

Method Summary

Modifier and Type	Method and Description
static IntegrationFunction.IntegrationFunctionReification	getIntegrationFunctionComputer(IntegrationFunction integrationFunction)
static boolean	isImplemented(IntegrationFunction integrationFunction)
static IntegrationFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntegrationFunction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static Collection<IntegrationFunction>	whichCanApply(RegulatoryNode input)
static Collection<IntegrationFunction>	whichCanApply(RegulatoryNode input, Collection<RegulatoryNode> properComponents)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAX

public static final IntegrationFunction MAX

MIN

public static final IntegrationFunction MIN

AND

public static final IntegrationFunction AND

OR

public static final IntegrationFunction OR

THRESHOLD2

public static final IntegrationFunction THRESHOLD2

MAX_LEFT

public static final IntegrationFunction MAX_LEFT

MAX_RIGHT

public static final IntegrationFunction MAX_RIGHT

Method Detail

values

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

Returns:

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

valueOf

public static IntegrationFunction 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

isImplemented

public static boolean isImplemented(IntegrationFunction integrationFunction)

Parameters:

integrationFunction - an integration function

whichCanApply

public static Collection<IntegrationFunction> whichCanApply(RegulatoryNode input,
                                                            Collection<RegulatoryNode> properComponents)

Parameters:

input - an input component

properComponents - a list of proper components

Returns:

a list of integration functions that can be applied to the type of input/proper components given

whichCanApply

public static Collection<IntegrationFunction> whichCanApply(RegulatoryNode input)

Parameters:

input - an input component

Returns:

a list of integration functions that can be applied to this input components, assuming adequate proper components

getIntegrationFunctionComputer

public static IntegrationFunction.IntegrationFunctionReification getIntegrationFunctionComputer(IntegrationFunction integrationFunction)

Parameters:

integrationFunction -

Returns:

an instance of IntegrationFunctionReification able to implement the specified integrationFunction