FluxBound (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.FluxBound

```
public class FluxBound
extends SBase
```
fbc Implementation of the 'fbc' package FluxBound construct.
The FluxBound object holds a single (in)equality that provides the maximum or minimum value that a reaction flux can obtain at steady state.

Constructor Summary

Constructors
Constructor and Description
`FluxBound()` Creates a new `FluxBound` with the given level, version, and package version.
`FluxBound(FbcPkgNamespaces fbcns)` Creates a new `FluxBound` with the given `FbcPkgNamespaces` object.
`FluxBound(FluxBound source)` Copy constructor.
`FluxBound(long level)` Creates a new `FluxBound` with the given level, version, and package version.
`FluxBound(long level, long version)` Creates a new `FluxBound` with the given level, version, and package version.
`FluxBound(long level, long version, long pkgVersion)` Creates a new `FluxBound` with the given level, version, and package version.

Method Summary

Methods
Modifier and Type	Method and Description
`FluxBound`	`cloneObject()` Creates and returns a deep copy of this `FluxBound`.
`void`	`delete()` Explicitly deletes the underlying native object.
`java.lang.String`	`getElementName()` Returns the XML element name of this SBML object.
`int`	`getFluxBoundOperation()` Returns the value of the 'operation' attribute of this `FluxBound`.
`java.lang.String`	`getId()` Returns the value of the 'id' attribute of this `FluxBound`.
`java.lang.String`	`getName()` Returns the value of the 'name' attribute of this `FluxBound`.
`java.lang.String`	`getOperation()` Returns the value of the 'operation' attribute of this `FluxBound`.
`java.lang.String`	`getReaction()` Returns the value of the 'reaction' attribute of this `FluxBound`.
`int`	`getTypeCode()` Returns the libSBML type code of this object instance.
`double`	`getValue()` Returns the value of the 'value' attribute of this `FluxBound`.
`boolean`	`isSetId()` Predicate returning `true` or `false` depending on whether this `FluxBound`'s 'id' attribute has been set.
`boolean`	`isSetName()` Predicate returning `true` or `false` depending on whether this `FluxBound`'s 'name' attribute has been set.
`boolean`	`isSetOperation()` Predicate returning `true` or `false` depending on whether this `FluxBound`'s 'operation' attribute has been set.
`boolean`	`isSetReaction()` Predicate returning `true` or `false` depending on whether this `FluxBound`'s 'reaction' attribute has been set.
`boolean`	`isSetValue()` Predicate returning `true` or `false` depending on whether this `FluxBound`'s 'value' attribute has been set.
`void`	`renameSIdRefs(java.lang.String oldid, java.lang.String newid)` Renames all the `SIdRef` attributes on this element, including any found in MathML content (if such exists).
`int`	`setId(java.lang.String id)` Sets the value of the 'id' attribute of this `FluxBound`.
`int`	`setName(java.lang.String name)` Sets the value of the 'name' attribute of this `FluxBound`.
`int`	`setOperation(int operation)` Sets the value of the 'operation' attribute of this `FluxBound`.
`int`	`setOperation(java.lang.String operation)` Sets the value of the 'operation' attribute of this `FluxBound`.
`int`	`setReaction(java.lang.String reaction)` Sets the value of the 'reaction' attribute of this `FluxBound`.
`int`	`setValue(double value)` Sets the value of the 'value' attribute of this `FluxBound`.
`int`	`unsetId()` Unsets the value of the 'id' attribute of this `FluxBound`.
`int`	`unsetName()` Unsets the value of the 'name' attribute of this `FluxBound`.
`int`	`unsetOperation()` Unsets the value of the 'operation' attribute of this `FluxBound`.
`int`	`unsetReaction()` Unsets the value of the 'reaction' attribute of this `FluxBound`.
`int`	`unsetValue()` Unsets the value of the 'value' attribute of this `FluxBound`.

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getElementByMetaId, getElementBySId, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FluxBound
```
public FluxBound()
          throws SBMLConstructorException
```
    Creates a new FluxBound with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
  - FluxBound
```
public FluxBound(FbcPkgNamespaces fbcns)
          throws SBMLConstructorException
```
    Creates a new FluxBound with the given FbcPkgNamespaces object.
    
    Throws:
    
    SBMLConstructorException
  - FluxBound
```
public FluxBound(FluxBound source)
          throws SBMLConstructorException
```
    Copy constructor.
    
    Throws:
    
    SBMLConstructorException
  - FluxBound
```
public FluxBound(long level)
          throws SBMLConstructorException
```
    Creates a new FluxBound with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
  - FluxBound
```
public FluxBound(long level,
         long version)
          throws SBMLConstructorException
```
    Creates a new FluxBound with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
  - FluxBound
```
public FluxBound(long level,
         long version,
         long pkgVersion)
          throws SBMLConstructorException
```
    Creates a new FluxBound with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - cloneObject
```
public FluxBound cloneObject()
```
    Creates and returns a deep copy of this FluxBound.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    a (deep) copy of this FluxBound.
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the FluxBound.delete() method on the libSBML object.
    This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke FluxBound.delete() themselves.
    
    Overrides:
    
    delete in class SBase
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this SBML object.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    the string of the name of this element.
  - getFluxBoundOperation
```
public int getFluxBoundOperation()
```
    Returns the value of the 'operation' attribute of this FluxBound.
    
    Returns:
    the value of the 'operation' attribute of this FluxBound.
  - getId
```
public java.lang.String getId()
```
    Returns the value of the 'id' attribute of this FluxBound.
    
    Overrides:
    
    getId in class SBase
    
    Returns:
    the value of the 'id' attribute of this FluxBound.
  - getName
```
public java.lang.String getName()
```
    Returns the value of the 'name' attribute of this FluxBound.
    
    Overrides:
    
    getName in class SBase
    
    Returns:
    the value of the 'name' attribute of this FluxBound.
  - getOperation
```
public java.lang.String getOperation()
```
    Returns the value of the 'operation' attribute of this FluxBound.
    
    Returns:
    the value of the 'operation' attribute of this FluxBound.
  - getReaction
```
public java.lang.String getReaction()
```
    Returns the value of the 'reaction' attribute of this FluxBound.
    
    Returns:
    the value of the 'reaction' attribute of this FluxBound.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code of this object instance.
    
    LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters &ldquoSBML_&rdquo. In the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. Note that different Level 3 package plug-ins may use overlapping type codes to identify the package to which a given object belongs, call the getPackageName() method on the object.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    the SBML type code for this object: SBML_FBC_FLUXBOUND
    
    See Also:
    FluxBound.getElementName(), SBase.getPackageName()
    "Warning:"
    
    The specific integer values of the possible type codes may be reused by different Level 3 package plug-ins. Thus, to identifiy the correct code, it is necessary to invoke both getTypeCode() and getPackageName().
  - getValue
```
public double getValue()
```
    Returns the value of the 'value' attribute of this FluxBound.
    
    Returns:
    the value of the 'value' attribute of this FluxBound.
  - isSetId
```
public boolean isSetId()
```
    Predicate returning true or false depending on whether this FluxBound's 'id' attribute has been set.
    
    Overrides:
    
    isSetId in class SBase
    
    Returns:
    true if this FluxBound's 'id' attribute has been set, otherwise false is returned.
  - isSetName
```
public boolean isSetName()
```
    Predicate returning true or false depending on whether this FluxBound's 'name' attribute has been set.
    
    Overrides:
    
    isSetName in class SBase
    
    Returns:
    true if this FluxBound's 'id' attribute has been set, otherwise false is returned.
  - isSetOperation
```
public boolean isSetOperation()
```
    Predicate returning true or false depending on whether this FluxBound's 'operation' attribute has been set.
    
    Returns:
    true if this FluxBound's 'operation' attribute has been set, otherwise false is returned.
  - isSetReaction
```
public boolean isSetReaction()
```
    Predicate returning true or false depending on whether this FluxBound's 'reaction' attribute has been set.
    
    Returns:
    true if this FluxBound's 'reaction' attribute has been set, otherwise false is returned.
  - isSetValue
```
public boolean isSetValue()
```
    Predicate returning true or false depending on whether this FluxBound's 'value' attribute has been set.
    
    Returns:
    true if this FluxBound's 'value' attribute has been set, otherwise false is returned.
  - renameSIdRefs
```
public void renameSIdRefs(java.lang.String oldid,
                 java.lang.String newid)
```
    Renames all the SIdRef attributes on this element, including any found in MathML content (if such exists).
    This method works by looking at all attributes and (if appropriate) mathematical formulas, comparing the identifiers to the value of @p oldid. If any matches are found, the matching identifiers are replaced with newid. The method does not descend into child elements.
    
    Overrides:
    
    renameSIdRefs in class SBase
    
    Parameters:
    oldid - the old identifier
    newid - the new identifier
  - setId
```
public int setId(java.lang.String id)
```
    Sets the value of the 'id' attribute of this FluxBound.
    Overrides:
    
    setId in class SBase
    
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setName
```
public int setName(java.lang.String name)
```
    Sets the value of the 'name' attribute of this FluxBound.
    Overrides:
    
    setName in class SBase
    
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setOperation
```
public int setOperation(int operation)
```
    Sets the value of the 'operation' attribute of this FluxBound.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setOperation
```
public int setOperation(java.lang.String operation)
```
    Sets the value of the 'operation' attribute of this FluxBound.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setReaction
```
public int setReaction(java.lang.String reaction)
```
    Sets the value of the 'reaction' attribute of this FluxBound.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setValue
```
public int setValue(double value)
```
    Sets the value of the 'value' attribute of this FluxBound.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - unsetId
```
public int unsetId()
```
    Unsets the value of the 'id' attribute of this FluxBound.
    Overrides:
    
    unsetId in class SBase
    
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetName
```
public int unsetName()
```
    Unsets the value of the 'name' attribute of this FluxBound.
    Overrides:
    
    unsetName in class SBase
    
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetOperation
```
public int unsetOperation()
```
    Unsets the value of the 'operation' attribute of this FluxBound.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetReaction
```
public int unsetReaction()
```
    Unsets the value of the 'reaction' attribute of this FluxBound.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetValue
```
public int unsetValue()
```
    Unsets the value of the 'value' attribute of this FluxBound.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED

Class FluxBound

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

FluxBound

FluxBound

FluxBound

FluxBound

FluxBound

FluxBound

Method Detail

cloneObject

delete

getElementName

getFluxBoundOperation

getId

getName

getOperation

getReaction

getTypeCode

getValue

isSetId

isSetName

isSetOperation

isSetReaction

isSetValue

renameSIdRefs

setId

setName

setOperation

setOperation

setReaction

setValue

unsetId

unsetName

unsetOperation

unsetReaction

unsetValue