public class ListOfObjectives extends ListOf
Constructor and Description |
---|
ListOfObjectives()   |
ListOfObjectives(FbcPkgNamespaces fbcns)   |
ListOfObjectives(long level)   |
ListOfObjectives(long level,
long version)   |
ListOfObjectives(long level,
long version,
long pkgVersion)   |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFbc(SWIGTYPE_p_FbcVisitor v)   |
ListOfObjectives |
cloneObject()
Creates and returns a deep copy of this
ListOf . |
void |
delete()
Explicitly deletes the underlying native object.
|
Objective |
get(long n)
Get an item from the list.
|
Objective |
get(String sid)
Get an item from the list based on its identifier.
|
String |
getActiveObjective()   |
String |
getElementName()
Returns the XML element name of this object, which for
ListOf , is
always 'listOf'. |
int |
getItemTypeCode()
Get the type code of the objects contained in this
ListOf . |
boolean |
isSetActiveObjective()   |
Objective |
remove(long n)
Removes the nth item from this
ListOf items and returns a
pointer to it. |
Objective |
remove(String sid)
Removes item in this
ListOf items with the given identifier. |
int |
setActiveObjective(String activeObjective)   |
int |
unsetActiveObjective()   |
append, appendAndOwn, appendFrom, clear, clear, getElementByMetaId, getElementBySId, getTypeCode, insert, insertAndOwn, removeFromParentAndDelete, size
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getLevel, getLine, getListOfAllElements, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, unsetAnnotation, unsetCVTerms, unsetId, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm
public ListOfObjectives() throws SBMLConstructorException
SBMLConstructorException
public ListOfObjectives(FbcPkgNamespaces fbcns) throws SBMLConstructorException
SBMLConstructorException
public ListOfObjectives(long level) throws SBMLConstructorException
SBMLConstructorException
public ListOfObjectives(long level, long version) throws SBMLConstructorException
SBMLConstructorException
public ListOfObjectives(long level, long version, long pkgVersion) throws SBMLConstructorException
SBMLConstructorException
public boolean acceptFbc(SWIGTYPE_p_FbcVisitor v)
public ListOfObjectives cloneObject()
ListOf
.
cloneObject
 in class ListOf
ListOf
.public void delete()
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 ListOfObjectives.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 ListOfObjectives.delete()
themselves.
public Objective get(long n)
get
 in class ListOf
n
- the index number of the item to get.
ListOf
items.
ListOf.size()
public Objective get(String sid)
sid
- a string representing the the identifier of the item to get.
ListOf
items with the given sid
or null
if no such
item exists.
ListOfObjectives.get(long n)
,
ListOf.size()
public String getActiveObjective()
public String getElementName()
ListOf
, is
always 'listOf'.
getElementName
 in class ListOf
public int getItemTypeCode()
ListOf
.
LibSBML attaches an identifying code to every
kind of SBML object. These are known as SBML type codes. In
other languages, the set of type codes is stored in an enumeration in
the Java language interface for libSBML, the type codes are defined as
static integer constants in the interface class libsbmlConstants
. The names of the type codes all begin with the
characters SBML_.
getItemTypeCode
 in class ListOf
ListOf
instance, or SBML_UNKNOWN
(default).public boolean isSetActiveObjective()
public Objective remove(long n)
ListOf
items and returns a
pointer to it.
The caller owns the returned item and is responsible for deleting it.
remove
 in class ListOf
n
- the index of the item to remove
ListOf.size()
public Objective remove(String sid)
ListOf
items with the given identifier.
The caller owns the returned item and is responsible for deleting it.
If none of the items in this list have the identifier sid
, then
null
is returned.
sid
- the identifier of the item to remove
public int setActiveObjective(String activeObjective)
public int unsetActiveObjective()