sbrt.kernel.fba
Class SinkRxn

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

public final class SinkRxn
extends AbstractExchangeRxn

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

Instances of this class are immutable.

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

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

Constructor Detail

SinkRxn

public SinkRxn(java.lang.String chemSpecies)
Constructs a new sink reaction for the provided chemical species.

Parameters:
chemSpecies - the chemical species this sink consumes.
Method Detail

getReactants

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

Specified by:
getReactants in interface ChemRxn
Overrides:
getReactants in class AbstractExchangeRxn
Returns:
a single-term linear combination. The variable of this term is the consumed 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 sink reaction.

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