001/* ----------------------------------------------------------------------------
002 * This file was automatically generated by SWIG (http://www.swig.org).
003 * Version 2.0.11
004 *
005 * Do not make changes to this file unless you know what you are doing--modify
006 * the SWIG interface file instead.
007 * ----------------------------------------------------------------------------- */
008
009package org.sbml.libsbml;
010
011/** 
012 * 
013 * Implementation of SBML Level 2's ListOfCompartments construct.
014 * <p>
015 * The various ListOf___ classes in SBML are merely containers used for
016 * organizing the main components of an SBML model.  All are derived from
017 * the abstract class {@link SBase}, and inherit the various attributes and
018 * subelements of {@link SBase}, such as 'metaid' as and 'annotation'.  The
019 * ListOf___ classes do not add any attributes of their own.
020 * <p>
021 * The relationship between the lists and the rest of an SBML model is
022 * illustrated by the following (for SBML Level&nbsp;2 Version&nbsp;4):
023 * <p>
024 * <center><img src='listof-illustration.jpg'></center><br>
025 * 
026 * <p>
027 * Readers may wonder about the motivations for using the ListOf___
028 * containers.  A simpler approach in XML might be to place the components
029 * all directly at the top level of the model definition.  The choice made
030 * in SBML is to group them within XML elements named after
031 * {@link ListOf}<em>Classname</em>, in part because it helps organize the
032 * components.  More importantly, the fact that the container classes are
033 * derived from {@link SBase} means that software tools can add information <em>about</em>
034 * the lists themselves into each list container's 'annotation'.
035 * <p>
036 * @see ListOfFunctionDefinitions
037 * @see ListOfUnitDefinitions
038 * @see ListOfCompartmentTypes
039 * @see ListOfSpeciesTypes
040 * @see ListOfCompartments
041 * @see ListOfSpecies
042 * @see ListOfParameters
043 * @see ListOfInitialAssignments
044 * @see ListOfRules
045 * @see ListOfConstraints
046 * @see ListOfReactions
047 * @see ListOfEvents
048 */
049
050public class ListOfCompartments extends ListOf {
051   private long swigCPtr;
052
053   protected ListOfCompartments(long cPtr, boolean cMemoryOwn)
054   {
055     super(libsbmlJNI.ListOfCompartments_SWIGUpcast(cPtr), cMemoryOwn);
056     swigCPtr = cPtr;
057   }
058
059   protected static long getCPtr(ListOfCompartments obj)
060   {
061     return (obj == null) ? 0 : obj.swigCPtr;
062   }
063
064   protected static long getCPtrAndDisown (ListOfCompartments obj)
065   {
066     long ptr = 0;
067
068     if (obj != null)
069     {
070       ptr             = obj.swigCPtr;
071       obj.swigCMemOwn = false;
072     }
073
074     return ptr;
075   }
076
077  protected void finalize() {
078    delete();
079  }
080
081  public synchronized void delete() {
082    if (swigCPtr != 0) {
083      if (swigCMemOwn) {
084        swigCMemOwn = false;
085        libsbmlJNI.delete_ListOfCompartments(swigCPtr);
086      }
087      swigCPtr = 0;
088    }
089    super.delete();
090  }
091
092  
093/**
094   * Creates a new {@link ListOfCompartments} object.
095   * <p>
096   * The object is constructed such that it is valid for the given SBML
097   * Level and Version combination.
098   * <p>
099   * @param level the SBML Level
100   * <p>
101   * @param version the Version within the SBML Level
102   */ public
103 ListOfCompartments(long level, long version) throws org.sbml.libsbml.SBMLConstructorException {
104    this(libsbmlJNI.new_ListOfCompartments__SWIG_0(level, version), true);
105  }
106
107  
108/**
109   * Creates a new {@link ListOfCompartments} object.
110   * <p>
111   * The object is constructed such that it is valid for the SBML Level and
112   * Version combination determined by the {@link SBMLNamespaces} object in 
113   * <code>sbmlns</code>.
114   * <p>
115   * @param sbmlns an {@link SBMLNamespaces} object that is used to determine the
116   * characteristics of the {@link ListOfCompartments} object to be created.
117   */ public
118 ListOfCompartments(SBMLNamespaces sbmlns) throws org.sbml.libsbml.SBMLConstructorException {
119    this(libsbmlJNI.new_ListOfCompartments__SWIG_1(SBMLNamespaces.getCPtr(sbmlns), sbmlns), true);
120  }
121
122  
123/**
124   * Creates and returns a deep copy of this {@link ListOfCompartments} instance.
125   * <p>
126   * @return a (deep) copy of this {@link ListOfCompartments}.
127   */ public
128 ListOfCompartments cloneObject() {
129    long cPtr = libsbmlJNI.ListOfCompartments_cloneObject(swigCPtr, this);
130    return (cPtr == 0) ? null : new ListOfCompartments(cPtr, true);
131  }
132
133  
134/**
135   * Returns the libSBML type code for this SBML object.
136   * <p>
137   * LibSBML attaches an identifying code to every
138   * kind of SBML object.  These are known as <em>SBML type codes</em>.  In
139   * other languages, the set of type codes is stored in an enumeration; in
140   * the Java language interface for libSBML, the type codes are defined as
141   * static integer constants in the interface class {@link
142   * libsbmlConstants}.  The names of the type codes all begin with the
143   * characters <code>SBML_.</code> 
144   * <p>
145   * @return the SBML type code for this object, or {@link  libsbmlConstants#SBML_UNKNOWN SBML_UNKNOWN} (default).
146   * <p>
147   * @see #getElementName()
148   */ public
149 int getTypeCode() {
150    return libsbmlJNI.ListOfCompartments_getTypeCode(swigCPtr, this);
151  }
152
153  
154/**
155   * Returns the libSBML type code for the objects contained in this {@link ListOf}
156   * (i.e., {@link Compartment} objects, if the list is non-empty).
157   * <p>
158   * LibSBML attaches an identifying code to every
159   * kind of SBML object.  These are known as <em>SBML type codes</em>.  In
160   * other languages, the set of type codes is stored in an enumeration; in
161   * the Java language interface for libSBML, the type codes are defined as
162   * static integer constants in the interface class {@link
163   * libsbmlConstants}.  The names of the type codes all begin with the
164   * characters <code>SBML_.</code> 
165   * <p>
166   * @return the SBML type code for the objects contained in this {@link ListOf}
167   * instance, or {@link  libsbmlConstants#SBML_UNKNOWN SBML_UNKNOWN} (default).
168   * <p>
169   * @see #getElementName()
170   */ public
171 int getItemTypeCode() {
172    return libsbmlJNI.ListOfCompartments_getItemTypeCode(swigCPtr, this);
173  }
174
175  
176/**
177   * Returns the XML element name of this object.
178   * <p>
179   * For {@link ListOfCompartments}, the XML element name is <code>'listOfCompartments'.</code>
180   * <p>
181   * @return the name of this element, i.e., <code>'listOfCompartments'.</code>
182   */ public
183 String getElementName() {
184    return libsbmlJNI.ListOfCompartments_getElementName(swigCPtr, this);
185  }
186
187  
188/**
189   * Get a {@link Compartment} from the {@link ListOfCompartments}.
190   * <p>
191   * @param n the index number of the {@link Compartment} to get.
192   * <p>
193   * @return the nth {@link Compartment} in this {@link ListOfCompartments}.
194   * <p>
195   * @see #size()
196   */ public
197 Compartment get(long n) {
198    long cPtr = libsbmlJNI.ListOfCompartments_get__SWIG_0(swigCPtr, this, n);
199    return (cPtr == 0) ? null : new Compartment(cPtr, false);
200  }
201
202  
203/**
204   * Get a {@link Compartment} from the {@link ListOfCompartments}
205   * based on its identifier.
206   * <p>
207   * @param sid a string representing the identifier 
208   * of the {@link Compartment} to get.
209   * <p>
210   * @return {@link Compartment} in this {@link ListOfCompartments}
211   * with the given <code>sid</code> or <code>null</code> if no such
212   * {@link Compartment} exists.
213   * <p>
214   * @see #get(long n)
215   * @see #size()
216   */ public
217 Compartment get(String sid) {
218    long cPtr = libsbmlJNI.ListOfCompartments_get__SWIG_2(swigCPtr, this, sid);
219    return (cPtr == 0) ? null : new Compartment(cPtr, false);
220  }
221
222  
223/**
224   * Removes the nth item from this {@link ListOfCompartments} items and returns a pointer to
225   * it.
226   * <p>
227   * The caller owns the returned item and is responsible for deleting it.
228   * <p>
229   * @param n the index of the item to remove
230   * <p>
231   * @see #size()
232   */ public
233 Compartment remove(long n) {
234    long cPtr = libsbmlJNI.ListOfCompartments_remove__SWIG_0(swigCPtr, this, n);
235    return (cPtr == 0) ? null : new Compartment(cPtr, true);
236  }
237
238  
239/**
240   * Removes item in this {@link ListOfCompartments} items with the given identifier.
241   * <p>
242   * The caller owns the returned item and is responsible for deleting it.
243   * If none of the items in this list have the identifier <code>sid</code>, then
244   * <code>null</code> is returned.
245   * <p>
246   * @param sid the identifier of the item to remove
247   * <p>
248   * @return the item removed.  As mentioned above, the caller owns the
249   * returned item.
250   */ public
251 Compartment remove(String sid) {
252    long cPtr = libsbmlJNI.ListOfCompartments_remove__SWIG_1(swigCPtr, this, sid);
253    return (cPtr == 0) ? null : new Compartment(cPtr, true);
254  }
255
256}