ReactantRole (singa-simulation 0.7.0 API)

java.lang.Object
- java.lang.Enum<ReactantRole>
- - bio.singa.simulation.model.modules.concentration.imlementations.reactions.behaviors.reactants.ReactantRole

All Implemented Interfaces:

Serializable, Comparable<ReactantRole>
```
public enum ReactantRole
extends Enum<ReactantRole>
```
The role of the reactant: Increasing, for products and accelerating reactants and decreasing for substrates and inhibiting reactants.

Author:

cl

Enum Constant Summary

Enum Constants
Enum Constant Description

CATALYTIC

PRODUCT

SUBSTRATE

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static ReactantRole`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ReactantRole[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

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
  - PRODUCT
```
public static final ReactantRole PRODUCT
```
  - SUBSTRATE
```
public static final ReactantRole SUBSTRATE
```
  - CATALYTIC
```
public static final ReactantRole CATALYTIC
```
- Method Detail
  - values
```
public static ReactantRole[] 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 (ReactantRole c : ReactantRole.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ReactantRole 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