public class ListOfMembers extends ListOf
Constructor and Description |
---|
ListOfMembers()
Creates a new ListOfMembers with the given level, version, and package version.
|
ListOfMembers(GroupsPkgNamespaces groupsns)
Creates a new ListOfMembers with the given
GroupsPkgNamespaces object. |
ListOfMembers(long level)
Creates a new ListOfMembers with the given level, version, and package version.
|
ListOfMembers(long level,
long version)
Creates a new ListOfMembers with the given level, version, and package version.
|
ListOfMembers(long level,
long version,
long pkgVersion)
Creates a new ListOfMembers with the given level, version, and package version.
|
Modifier and Type | Method and Description |
---|---|
ListOfMembers |
cloneObject()
Creates and returns a deep copy of this ListOfMembers object.
|
void |
delete()
Explicitly deletes the underlying native object.
|
Member |
get(long n)
Get a Member from the ListOfMembers.
|
Member |
get(java.lang.String sid)
Get a Member from the ListOfMembers
based on its identifier.
|
java.lang.String |
getElementName()
Returns the XML element name of this object, which for ListOfMembers, is
always
'listOfMembers'. |
int |
getItemTypeCode()
Returns the libSBML type code for the SBML objects
contained in this
ListOf object |
int |
getTypeCode()
Returns the libSBML type code for this SBML object.
|
Member |
remove(long n)
Removes the nth Member from this ListOfMembers
and returns a pointer to it.
|
Member |
remove(java.lang.String sid)
Removes the Member from this ListOfMembers with the given identifier
and returns a pointer to it.
|
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, insert, insertAndOwn, removeFromParentAndDelete, size
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public ListOfMembers(long level, long version, long pkgVersion) throws SBMLConstructorException
level
- a long integer, the SBML Level to assign to this ListOfMembers
version
- a long integer, the SBML Version to assign to this ListOfMembers
pkgVersion
- a long integer, the SBML Groups Version to assign to this ListOfMembersSBMLConstructorException
public ListOfMembers(long level, long version) throws SBMLConstructorException
level
- a long integer, the SBML Level to assign to this ListOfMembers
version
- a long integer, the SBML Version to assign to this ListOfMembers
pkgVersion
- a long integer, the SBML Groups Version to assign to this ListOfMembersSBMLConstructorException
public ListOfMembers(long level) throws SBMLConstructorException
level
- a long integer, the SBML Level to assign to this ListOfMembers
version
- a long integer, the SBML Version to assign to this ListOfMembers
pkgVersion
- a long integer, the SBML Groups Version to assign to this ListOfMembersSBMLConstructorException
public ListOfMembers() throws SBMLConstructorException
level
- a long integer, the SBML Level to assign to this ListOfMembers
version
- a long integer, the SBML Version to assign to this ListOfMembers
pkgVersion
- a long integer, the SBML Groups Version to assign to this ListOfMembersSBMLConstructorException
public ListOfMembers(GroupsPkgNamespaces groupsns) throws SBMLConstructorException
GroupsPkgNamespaces
object.
groupsns
- the GroupsPkgNamespaces
objectSBMLConstructorException
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 ListOfMembers.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 ListOfMembers.delete()
themselves.
public ListOfMembers cloneObject()
cloneObject
 in class ListOf
public Member get(long n)
get
 in class ListOf
n
- the index number of the Member to get.
ListOf.size()
public Member get(java.lang.String sid)
sid
- a string representing the identifier
of the Member to get.
*
,
ListOf.size()
public Member remove(long n)
The caller owns the returned item and is responsible for deleting it.
remove
 in class ListOf
n
- the index of the Member to remove.
ListOf.size()
public Member remove(java.lang.String sid)
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 Member to remove.
public java.lang.String getElementName()
'listOfMembers'.
getElementName
 in class ListOf
'listOfMembers'.
public int getTypeCode()
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_.
getTypeCode
 in class ListOf
SBML_UNKNOWN
(default).
ListOfMembers.getElementName()
public int getItemTypeCode()
ListOf
object
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).
ListOfMembers.getElementName()