sbrt.kernel.fba
Class RevExchRxn

java.lang.Object
  extended by sbrt.kernel.fba.AbstractExchangeRxn
      extended by sbrt.kernel.fba.RevExchRxn
All Implemented Interfaces:
ChemRxn, ExchangeRxn

public final class RevExchRxn
extends AbstractExchangeRxn

This class is used to represent reversible exchange reactions, that is, exchange reactions that can both supply and consume chemical species to and from a chemical system.

Instances of this class are immutable.

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

Constructor Summary
RevExchRxn(java.lang.String chemSpecies, boolean reactant)
          Constructs a new reversible exchange reaction for the provided chemical species.
 
Method Summary
 LinearComb<java.lang.String> getProducts()
          Returns a linear combination representing the products of this exchange reaction.
 LinearComb<java.lang.String> getReactants()
          Returns a linear combination representing the reactants of this exchange reaction.
 boolean isReversible()
          Returns true.
 java.lang.String toString()
          Returns a string representation of this exchange reaction.
 
Methods inherited from class sbrt.kernel.fba.AbstractExchangeRxn
equals, getSpecies, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RevExchRxn

public RevExchRxn(java.lang.String chemSpecies,
                  boolean reactant)
Constructs a new reversible exchange reaction for the provided chemical species.

Parameters:
chemSpecies - the chemical species associated with this exchange reaction.
reactant - indicates if the chemical species should be considered as a reactant or product, which affects the way in which an exchange reaction is written and the sign of its flux.
Method Detail

getReactants

public LinearComb<java.lang.String> getReactants()
Returns a linear combination representing the reactants of this exchange reaction. This linear combination will be either empty or have a single-term, depending on whether or not the chemical species is considered a reactant or product. If a single-term is present, the variable of that term is the chemical species and the coefficient is 1.0.

Specified by:
getReactants in interface ChemRxn
Overrides:
getReactants in class AbstractExchangeRxn
Returns:
a linear combination representing the reactants of this exchange reaction.

getProducts

public LinearComb<java.lang.String> getProducts()
Returns a linear combination representing the products of this exchange reaction. This linear combination will be either empty or have a single-term, depending on whether or not the chemical species is considered a reactant or product. If a single-term is present, the variable of that term is the chemical species and the coefficient is 1.0.

Specified by:
getProducts in interface ChemRxn
Overrides:
getProducts in class AbstractExchangeRxn
Returns:
a linear combination representing the products of this exchange reaction.

isReversible

public boolean isReversible()
Returns true.

Returns:
true.

toString

public java.lang.String toString()
Returns a string representation of this exchange reaction.

Specified by:
toString in interface ChemRxn
Overrides:
toString in class java.lang.Object
Returns:
a string representation of this exchange reaction.