ListOfLocalParameters (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.ListOf
  - - org.sbml.libsbml.ListOfParameters
    - - org.sbml.libsbml.ListOfLocalParameters

```
public class ListOfLocalParameters
extends ListOfParameters
```
A list of LocalParameter objects.

The various ListOf___ classes in SBML are merely containers used for organizing the main components of an SBML model. In libSBML's implementation, ListOf___ classes are derived from the intermediate utility class ListOf, which is not defined by the SBML specifications but serves as a useful programmatic construct. ListOf is itself is in turn derived from SBase, which provides all of the various ListOf___ classes with common features defined by the SBML specification, such as 'metaid' attributes and annotations.
The relationship between the lists and the rest of an SBML model is illustrated by the following (for SBML Level 2 Version 4):

Readers may wonder about the motivations for using the ListOf___ containers in SBML. A simpler approach in XML might be to place the components all directly at the top level of the model definition. The choice made in SBML is to group them within XML elements named after ListOfClassname, in part because it helps organize the components. More importantly, the fact that the container classes are derived from SBase means that software tools can add information about the lists themselves into each list container's 'annotation'.

See Also:

ListOfFunctionDefinitions, ListOfUnitDefinitions, ListOfCompartmentTypes, ListOfSpeciesTypes, ListOfCompartments, ListOfSpecies, ListOfParameters, ListOfInitialAssignments, ListOfRules, ListOfConstraints, ListOfReactions, ListOfEvents

Constructor Summary

Constructors
Constructor and Description
`ListOfLocalParameters(long level, long version)` Creates a new `ListOfLocalParameters` object.
`ListOfLocalParameters(SBMLNamespaces sbmlns)` Creates a new `ListOfLocalParameters` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListOfLocalParameters`	`cloneObject()` Creates and returns a deep copy of this `ListOfLocalParameters` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`LocalParameter`	`get(long n)` Returns the `LocalParameter` object located at position `n` within this `ListOfLocalParameters` instance.
`LocalParameter`	`get(java.lang.String sid)` Returns the first `LocalParameter` object matching the given identifier.
`SBase`	`getElementBySId(java.lang.String id)` Returns the first child element found that has the given `id` in the model-wide SId namespace, or `null` if no such object is found.
`java.lang.String`	`getElementName()` Returns the XML element name of this object.
`int`	`getItemTypeCode()` Returns the libSBML type code for the objects contained in this `ListOf` (i.e., `LocalParameter` objects, if the list is non-empty).
`LocalParameter`	`remove(long n)` Removes the nth item from this `ListOfLocalParameters`, and returns a pointer to it.
`LocalParameter`	`remove(java.lang.String sid)` Removes the first `LocalParameter` object in this `ListOfLocalParameters` matching the given identifier, and returns a pointer to it.

Methods inherited from class org.sbml.libsbml.ListOf
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getTypeCode, 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
  - ListOfLocalParameters
```
public ListOfLocalParameters(long level,
                             long version)
                      throws SBMLConstructorException
```
    Creates a new ListOfLocalParameters object.
    The object is constructed such that it is valid for the given SBML Level and Version combination.
    
    Parameters:
    
    level - the SBML Level
    
    version - the Version within the SBML Level
    
    Throws:
    
    SBMLConstructorException - Thrown if the given level and version combination are invalid or if this object is incompatible with the given level and version.
    
    "Note:"
    
    Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute.
  - ListOfLocalParameters
```
public ListOfLocalParameters(SBMLNamespaces sbmlns)
                      throws SBMLConstructorException
```
    Creates a new ListOfLocalParameters object.
    The object is constructed such that it is valid for the SBML Level and Version combination determined by the SBMLNamespaces object in sbmlns.
    
    Parameters:
    
    sbmlns - an SBMLNamespaces object that is used to determine the characteristics of the ListOfLocalParameters object to be created.
    
    Throws:
    
    SBMLConstructorException - Thrown if the given sbmlns is inconsistent or incompatible with this object.
    
    "Note:"
    
    Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute.
- 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 ListOfLocalParameters.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 ListOfLocalParameters.delete() themselves.
    
    Overrides:
    
    delete in class ListOfParameters
  - cloneObject
```
public ListOfLocalParameters cloneObject()
```
    Creates and returns a deep copy of this ListOfLocalParameters object.
    
    Overrides:
    
    cloneObject in class ListOfParameters
    
    Returns:
    
    the (deep) copy of this ListOfLocalParameters object.
  - getItemTypeCode
```
public int getItemTypeCode()
```
    Returns the libSBML type code for the objects contained in this ListOf (i.e., LocalParameter objects, if the list is non-empty).
    
    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 SBML_. 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:
    
    getItemTypeCode in class ListOfParameters
    
    Returns:
    
    the SBML type code for the objects contained in this ListOf: SBML_LOCAL_PARAMETER (default).
    
    See Also:
    
    ListOfLocalParameters.getElementName(), SBase.getPackageName()
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object.
    For ListOfLocalParameters, the XML element name is 'listOfLocalParameters'.
    
    Overrides:
    
    getElementName in class ListOfParameters
    
    Returns:
    
    the name of this element, i.e., 'listOfLocalParameters'.
  - get
```
public LocalParameter get(long n)
```
    Returns the LocalParameter object located at position n within this ListOfLocalParameters instance.
    
    Overrides:
    
    get in class ListOfParameters
    
    Parameters:
    
    n - the index number of the LocalParameter to get.
    
    Returns:
    
    the nth LocalParameter in this ListOfLocalParameters. If the index n is out of bounds for the length of the list, then null is returned.
    
    See Also:
    
    ListOf.size(), ListOfLocalParameters.get(String sid)
  - get
```
public LocalParameter get(java.lang.String sid)
```
    Returns the first LocalParameter object matching the given identifier.
    
    Overrides:
    
    get in class ListOfParameters
    
    Parameters:
    
    sid - a string, the identifier of the LocalParameter to get.
    
    Returns:
    
    the LocalParameter object found. The caller owns the returned object and is responsible for deleting it. If none of the items have an identifier matching sid, then null is returned.
    
    See Also:
    
    ListOfLocalParameters.get(long n), ListOf.size()
  - getElementBySId
```
public SBase getElementBySId(java.lang.String id)
```
    Returns the first child element found that has the given id in the model-wide SId namespace, or null if no such object is found.
    Note that LocalParameters, while they use the SId namespace, are not in the model-wide SId namespace, so no LocalParameter object will be returned from this function (and is the reason we override the base ListOf.getElementBySId function here).
    
    Overrides:
    
    getElementBySId in class ListOf
    
    Parameters:
    
    id - string representing the id of objects to find
    
    Returns:
    
    pointer to the first element found with the given id.
  - remove
```
public LocalParameter remove(long n)
```
    Removes the nth item from this ListOfLocalParameters, and returns a pointer to it.
    
    Overrides:
    
    remove in class ListOfParameters
    
    Parameters:
    
    n - the index of the item to remove.
    
    Returns:
    
    the item removed. The caller owns the returned object and is responsible for deleting it. If the index number n is out of bounds for the length of the list, then null is returned.
    
    See Also:
    
    ListOf.size(), ListOfLocalParameters.remove(String sid)
  - remove
```
public LocalParameter remove(java.lang.String sid)
```
    Removes the first LocalParameter object in this ListOfLocalParameters matching the given identifier, and returns a pointer to it.
    
    Overrides:
    
    remove in class ListOfParameters
    
    Parameters:
    
    sid - the identifier of the item to remove.
    
    Returns:
    
    the item removed. The caller owns the returned object and is responsible for deleting it. If none of the items have an identifier matching sid, then null is returned.

Class ListOfLocalParameters

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

ListOfLocalParameters

ListOfLocalParameters

Method Detail

delete

cloneObject

getItemTypeCode

getElementName

get

get

getElementBySId

remove

remove