|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsbrt.kernel.fba.AbstractRxn
sbrt.kernel.fba.ReversibleRxn
public class ReversibleRxn
This class is used to represent reversible chemical reactions.
Instances of this class are immutable.
Constructor Summary | |
---|---|
ReversibleRxn(LinearComb<java.lang.String> reactants,
LinearComb<java.lang.String> products)
Constructs a new reversible reaction from the provided reactants and products. |
Method Summary | |
---|---|
boolean |
isEquivalent(ChemRxn rxn)
Indicates if the provided chemical reaction is stoichiometrically equivalent to this reaction. |
boolean |
isReverse(ChemRxn rxn)
Returns false , since no reaction can be the "reverse" of a
reversible reaction. |
java.lang.String |
toString()
Returns an appropriate string representation of this reversible reaction. |
Methods inherited from class sbrt.kernel.fba.AbstractRxn |
---|
equals, getProducts, getRatio, getReactants, hashCode, main |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ReversibleRxn(LinearComb<java.lang.String> reactants, LinearComb<java.lang.String> products)
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.
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 |
---|
public boolean isEquivalent(ChemRxn rxn)
Indicates if the provided chemical reaction is stoichiometrically equivalent to this reaction.
rxn
- the reaction to test for equivalence.
true
if both reactions are equivalent; false
otherwise.public boolean isReverse(ChemRxn rxn)
false
, since no reaction can be the "reverse" of a
reversible reaction. The concept of a reverse reaction is not meaningful
for reversible reactions. When referring to the "forward" and "reverse"
reactions of a reversible reaction, the reaction has been implicity
decomposed into two irreversible reactions; and the labels "forward" and
"reverse" are relative to the way in which the reaction is written, which
is arbitrary.
isEquivalent(ChemRxn)
is a more meaningful comparison for
reversible reactions.
rxn
- the reaction to test.
false
IrrevRxn
public java.lang.String toString()
toString
in interface ChemRxn
toString
in class AbstractRxn
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |