sbrt.kernel.fba
Class SourceRxn

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

public final class SourceRxn
extends AbstractExchangeRxn

This class is used to represent exchange reactions that transport chemicals to a chemical system from its surroundings. Source reactions are unidirectional - they supply chemical species, but do not consume them.

Instances of this class are immutable.

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

Constructor Summary
SourceRxn(java.lang.String chemSpecies)
          Constructs a new source for the provided chemical species.
 
Method Summary
 LinearComb<java.lang.String> getProducts()
          Returns a single-term linear combination.
 boolean isReversible()
          Returns false.
 java.lang.String toString()
          Returns a string representation of this source reaction.
 
Methods inherited from class sbrt.kernel.fba.AbstractExchangeRxn
equals, getReactants, getSpecies, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SourceRxn

public SourceRxn(java.lang.String chemSpecies)
Constructs a new source for the provided chemical species.

Parameters:
chemSpecies - the chemical species this source supplies.
Method Detail

getProducts

public LinearComb<java.lang.String> getProducts()
Returns a single-term linear combination. The variable of this term is the supplied chemical species and the coefficient is 1.0.

Specified by:
getProducts in interface ChemRxn
Overrides:
getProducts in class AbstractExchangeRxn
Returns:
a single-term linear combination. The variable of this term is the supplied chemical species and the coefficient is 1.0.

isReversible

public boolean isReversible()
Returns false.

Returns:
false.

toString

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

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