FluxObjective (LibSBML Java API)

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

```
public class FluxObjective
extends SBase
```
fbc Implementation of the 'fbc' package FluxObjective construct.
An integral component in a complete description of a steady-state model is the so-called 'objective function' which generally consists of a linear combination of model variables (fluxes) and a sense (direction). In the FBC package this concept is succinctly captured in the Objective class.

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`FluxObjective`	`cloneObject()` Creates and returns a deep copy of this `FluxObjective`.
`void`	`delete()` Explicitly deletes the underlying native object.
`double`	`getCoefficient()` Returns the value of the 'coefficient' attribute of this `FluxObjective`.
`java.lang.String`	`getElementName()` Returns the XML element name of this SBML object.
`java.lang.String`	`getId()` Returns the value of the 'id' attribute of this `FluxObjective`.
`java.lang.String`	`getName()` Returns the value of the 'name' attribute of this `FluxObjective`.
`java.lang.String`	`getReaction()` Returns the string of the 'reaction' attribute of this `FluxObjective`.
`int`	`getTypeCode()` Returns the libSBML type code of this object instance.
`boolean`	`isSetCoefficient()` Predicate returning `true` or `false` depending on whether this `FluxObjective`'s 'coefficient' attribute has been set.
`boolean`	`isSetId()` Predicate returning `true` or `false` depending on whether this `FluxObjective` 'id' attribute has been set.
`boolean`	`isSetName()` Predicate returning `true` or `false` depending on whether this `FluxObjective` 'name' attribute has been set.
`boolean`	`isSetReaction()` Predicate returning `true` or `false` depending on whether this `FluxObjective`'s 'reaction' 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`	`setCoefficient(double coefficient)` Sets the value of the 'coefficient' attribute of this `FluxObjective`.
`int`	`setId(java.lang.String id)` Sets the value of the 'id' attribute of this `FluxObjective`.
`int`	`setName(java.lang.String name)` Sets the value of the 'name' attribute of this `FluxObjective`.
`int`	`setReaction(java.lang.String reaction)` Sets the SIdRef string of the 'reaction' attribute of this `FluxObjective`.
`int`	`unsetCoefficient()` Unsets the value of the 'id' attribute of this `FluxObjective`.
`int`	`unsetId()` Unsets the value of the 'id' attribute of this `FluxObjective`.
`int`	`unsetName()` Unsets the value of the 'name' attribute of this `FluxObjective`.
`int`	`unsetReaction()` Unsets the value of the 'id' attribute of this `FluxObjective`.

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
  - FluxObjective
```
public FluxObjective()
              throws SBMLConstructorException
```
    Creates a new FluxObjective with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
  - FluxObjective
```
public FluxObjective(FbcPkgNamespaces fbcns)
              throws SBMLConstructorException
```
    Creates a new FluxObjective with the given FbcPkgNamespaces object.
    
    Throws:
    
    SBMLConstructorException
  - FluxObjective
```
public FluxObjective(FluxObjective source)
              throws SBMLConstructorException
```
    Copy constructor.
    
    Throws:
    
    SBMLConstructorException
  - FluxObjective
```
public FluxObjective(long level)
              throws SBMLConstructorException
```
    Creates a new FluxObjective with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
  - FluxObjective
```
public FluxObjective(long level,
             long version)
              throws SBMLConstructorException
```
    Creates a new FluxObjective with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
  - FluxObjective
```
public FluxObjective(long level,
             long version,
             long pkgVersion)
              throws SBMLConstructorException
```
    Creates a new FluxObjective with the given level, version, and package version.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - cloneObject
```
public FluxObjective cloneObject()
```
    Creates and returns a deep copy of this FluxObjective.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    a (deep) copy of this FluxObjective.
  - 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 FluxObjective.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 FluxObjective.delete() themselves.
    
    Overrides:
    
    delete in class SBase
  - getCoefficient
```
public double getCoefficient()
```
    Returns the value of the 'coefficient' attribute of this FluxObjective.
    
    Returns:
    the value of the 'coefficient' attribute of this FluxObjective.
  - 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.
  - getId
```
public java.lang.String getId()
```
    Returns the value of the 'id' attribute of this FluxObjective.
    
    Overrides:
    
    getId in class SBase
    
    Returns:
    the value of the 'id' attribute of this FluxObjective.
  - getName
```
public java.lang.String getName()
```
    Returns the value of the 'name' attribute of this FluxObjective.
    
    Overrides:
    
    getName in class SBase
    
    Returns:
    the value of the 'name' attribute of this FluxObjective.
  - getReaction
```
public java.lang.String getReaction()
```
    Returns the string of the 'reaction' attribute of this FluxObjective.
    
    Returns:
    the string of the 'reaction' attribute of this FluxObjective.
  - 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_FLUXOBJECTIVE
    
    See Also:
    FluxObjective.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().
  - isSetCoefficient
```
public boolean isSetCoefficient()
```
    Predicate returning true or false depending on whether this FluxObjective's 'coefficient' attribute has been set.
    
    Returns:
    true if this FluxObjective's 'coefficient' attribute has been set, otherwise false is returned.
  - isSetId
```
public boolean isSetId()
```
    Predicate returning true or false depending on whether this FluxObjective 'id' attribute has been set.
    
    Overrides:
    
    isSetId in class SBase
    
    Returns:
    true if this FluxObjective 'id' attribute has been set, otherwise false is returned.
  - isSetName
```
public boolean isSetName()
```
    Predicate returning true or false depending on whether this FluxObjective 'name' attribute has been set.
    
    Overrides:
    
    isSetName in class SBase
    
    Returns:
    true if this FluxObjective 'id' attribute has been set, otherwise false is returned.
  - isSetReaction
```
public boolean isSetReaction()
```
    Predicate returning true or false depending on whether this FluxObjective's 'reaction' attribute has been set.
    
    Returns:
    true if this FluxObjective's 'reaction' 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
  - setCoefficient
```
public int setCoefficient(double coefficient)
```
    Sets the value of the 'coefficient' attribute of this FluxObjective.
    Parameters:
    coefficient - a double coefficient to be set.
    
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - setId
```
public int setId(java.lang.String id)
```
    Sets the value of the 'id' attribute of this FluxObjective.
    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 FluxObjective.
    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
  - setReaction
```
public int setReaction(java.lang.String reaction)
```
    Sets the SIdRef string of the 'reaction' attribute of this FluxObjective.
    Parameters:
    reaction - a SIdRef string to be set.
    
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_INVALID_ATTRIBUTE_VALUE
  - unsetCoefficient
```
public int unsetCoefficient()
```
    Unsets the value of the 'id' attribute of this FluxObjective.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - unsetId
```
public int unsetId()
```
    Unsets the value of the 'id' attribute of this FluxObjective.
    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 FluxObjective.
    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
  - unsetReaction
```
public int unsetReaction()
```
    Unsets the value of the 'id' attribute of this FluxObjective.
    Returns:
    integer value indicating success/failure of the operation. The possible return values are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED

Class FluxObjective

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

FluxObjective

FluxObjective

FluxObjective

FluxObjective

FluxObjective

FluxObjective

Method Detail

cloneObject

delete

getCoefficient

getElementName

getId

getName

getReaction

getTypeCode

isSetCoefficient

isSetId

isSetName

isSetReaction

renameSIdRefs

setCoefficient

setId

setName

setReaction

unsetCoefficient

unsetId

unsetName

unsetReaction