sbrt.kernel.fba
Class RevRxn

java.lang.Object
  extended by sbrt.kernel.fba.AbstractRxn
      extended by sbrt.kernel.fba.RevRxn
All Implemented Interfaces:
ChemRxn

public final class RevRxn
extends AbstractRxn

This class is used to represent reversible chemical reactions.

Instances of this class are immutable.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner Lab.

Constructor Summary
RevRxn(LinearComb<java.lang.String> reactants, LinearComb<java.lang.String> products)
          Constructs a new reversible reaction from the provided reactants and products.
 
Method Summary
 boolean isReversible()
          Returns true.
 java.lang.String toString()
          Returns an appropriate string representation of this reversible reaction.
 
Methods inherited from class sbrt.kernel.fba.AbstractRxn
equals, getProducts, getReactants, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RevRxn

public RevRxn(LinearComb<java.lang.String> reactants,
              LinearComb<java.lang.String> products)
Constructs a new reversible reaction from the provided reactants and products.

Parameters:
reactants - the linear combination of chemical species representing the "left-hand side" of the reaction.
products - the linear combination of chemical species representing the "right-hand side" of the reaction.
Throws:
java.lang.NullPointerException - if the reactants or products are null, or if any chemical species within them is null.
java.lang.IllegalArgumentException - if

• the reactants or products contain a common chemical species,

• either linear combination contains a non-zero constant,

• a stoichiometric coefficient is NaN, infinite, or ≤ 0.

Method Detail

isReversible

public boolean isReversible()
Returns true.

Returns:
true.

toString

public java.lang.String toString()
Returns an appropriate string representation of this reversible reaction.

Specified by:
toString in interface ChemRxn
Specified by:
toString in class AbstractRxn
Returns:
an appropriate string representation of this reversible reaction.