sbrt.kernel.fba.comp
Class FbaOptException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by sbrt.kernel.fba.comp.FbaOptException
All Implemented Interfaces:
java.io.Serializable

public class FbaOptException
extends java.lang.RuntimeException

This class is used to indicate that an optimal solution could not be found or does not exist.

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

Constructor Summary
FbaOptException(MathExpr<?> objectiveFunction, OptSense sense, ProgramSolverStatus status)
          Constructs a new FBA optimization exception.
FbaOptException(MathExpr<?> objectiveFunction, OptSense sense, ProgramSolverStatus status, java.lang.String message)
          Constructs a new FBA optimization exception.
 
Method Summary
 MathExpr<?> getObjFunction()
          Returns the objective function whose optimal value could not be found.
 OptSense getSense()
          Returns the sense, or direction, of the attempted optimization.
 ProgramSolverStatus getStatus()
          Returns the status of the attempted optimization.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FbaOptException

public FbaOptException(MathExpr<?> objectiveFunction,
                       OptSense sense,
                       ProgramSolverStatus status)
Constructs a new FBA optimization exception.

Parameters:
objectiveFunction - the objective function whose optimal value could not be found.
sense - the sense, or direction, of the attempted optimization.
status - the status of the attempted optimization.

FbaOptException

public FbaOptException(MathExpr<?> objectiveFunction,
                       OptSense sense,
                       ProgramSolverStatus status,
                       java.lang.String message)
Constructs a new FBA optimization exception.

Parameters:
objectiveFunction - the objective function whose optimal value could not be found.
sense - the sense, or direction, of the attempted optimization.
status - the status of the attempted optimization.
message - a message useful for debugging.
Method Detail

getObjFunction

public MathExpr<?> getObjFunction()
Returns the objective function whose optimal value could not be found.

Returns:
the objective function whose optimal value could not be found.

getSense

public OptSense getSense()
Returns the sense, or direction, of the attempted optimization.

Returns:
the sense, or direction, of the attempted optimization.

getStatus

public ProgramSolverStatus getStatus()
Returns the status of the attempted optimization.

Returns:
the status of the attempted optimization.