ListOfMembers (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.ListOf
  - - org.sbml.libsbml.ListOfMembers

public class ListOfMembers
extends ListOf

Constructor Summary

Constructors
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.

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class org.sbml.libsbml.ListOf
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, insert, insertAndOwn, removeFromParentAndDelete, size

Methods inherited from class org.sbml.libsbml.SBase
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

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

- Constructor Detail
  - ListOfMembers
```
public ListOfMembers(long level,
                     long version,
                     long pkgVersion)
              throws SBMLConstructorException
```
    Creates a new ListOfMembers with the given level, version, and package version.
    
    Parameters:
    
    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 ListOfMembers
    
    Throws:
    
    SBMLConstructorException
  - ListOfMembers
```
public ListOfMembers(long level,
                     long version)
              throws SBMLConstructorException
```
    Creates a new ListOfMembers with the given level, version, and package version.
    
    Parameters:
    
    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 ListOfMembers
    
    Throws:
    
    SBMLConstructorException
  - ListOfMembers
```
public ListOfMembers(long level)
              throws SBMLConstructorException
```
    Creates a new ListOfMembers with the given level, version, and package version.
    
    Parameters:
    
    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 ListOfMembers
    
    Throws:
    
    SBMLConstructorException
  - ListOfMembers
```
public ListOfMembers()
              throws SBMLConstructorException
```
    Creates a new ListOfMembers with the given level, version, and package version.
    
    Parameters:
    
    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 ListOfMembers
    
    Throws:
    
    SBMLConstructorException
  - ListOfMembers
```
public ListOfMembers(GroupsPkgNamespaces groupsns)
              throws SBMLConstructorException
```
    Creates a new ListOfMembers with the given GroupsPkgNamespaces object.
    
    Parameters:
    
    groupsns - the GroupsPkgNamespaces object
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - 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 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.
    
    Overrides:
    
    delete in class ListOf
  - cloneObject
```
public ListOfMembers cloneObject()
```
    Creates and returns a deep copy of this ListOfMembers object.
    
    Overrides:
    
    cloneObject in class ListOf
    
    Returns:
    
    a (deep) copy of this ListOfMembers object.
  - get
```
public Member get(long n)
```
    Get a Member from the ListOfMembers.
    
    Overrides:
    
    get in class ListOf
    
    Parameters:
    
    n - the index number of the Member to get.
    
    Returns:
    
    the nth Member in this ListOfMembers.
    
    See Also:
    
    ListOf.size()
  - get
```
public Member get(java.lang.String sid)
```
    Get a Member from the ListOfMembers based on its identifier.
    
    Parameters:
    
    sid - a string representing the identifier of the Member to get.
    
    Returns:
    
    Member in this ListOfMembers with the given id or null if no such Member exists.
    
    See Also:
    
    *, ListOf.size()
  - remove
```
public Member remove(long n)
```
    Removes the nth Member from this ListOfMembers and returns a pointer to it.
    The caller owns the returned item and is responsible for deleting it.
    
    Overrides:
    
    remove in class ListOf
    
    Parameters:
    
    n - the index of the Member to remove.
    
    See Also:
    
    ListOf.size()
  - remove
```
public Member remove(java.lang.String sid)
```
    Removes the Member from this ListOfMembers with the given identifier and returns a pointer to it.
    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.
    
    Parameters:
    
    sid - the identifier of the Member to remove.
    
    Returns:
    
    the Member removed. As mentioned above, the caller owns the returned item.
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object, which for ListOfMembers, is always 'listOfMembers'.
    
    Overrides:
    
    getElementName in class ListOf
    
    Returns:
    
    the name of this element, i.e. 'listOfMembers'.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this SBML 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_.
    
    Overrides:
    
    getTypeCode in class ListOf
    
    Returns:
    
    the SBML type code for this object, or SBML_UNKNOWN (default).
    
    See Also:
    
    ListOfMembers.getElementName()
  - getItemTypeCode
```
public int getItemTypeCode()
```
    Returns the libSBML type code for the SBML objects contained in this 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_.
    
    Overrides:
    
    getItemTypeCode in class ListOf
    
    Returns:
    
    the SBML type code for the objects in this ListOf instance, or SBML_UNKNOWN (default).
    
    See Also:
    
    ListOfMembers.getElementName()

Class ListOfMembers

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.ListOf

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

ListOfMembers

ListOfMembers

ListOfMembers

ListOfMembers

ListOfMembers

Method Detail

delete

cloneObject

get

get

remove

remove

getElementName

getTypeCode

getItemTypeCode