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's ListOfParameters 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 2 Version 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 ListOfParameters extends ListOf { 051 private long swigCPtr; 052 053 protected ListOfParameters(long cPtr, boolean cMemoryOwn) 054 { 055 super(libsbmlJNI.ListOfParameters_SWIGUpcast(cPtr), cMemoryOwn); 056 swigCPtr = cPtr; 057 } 058 059 protected static long getCPtr(ListOfParameters obj) 060 { 061 return (obj == null) ? 0 : obj.swigCPtr; 062 } 063 064 protected static long getCPtrAndDisown (ListOfParameters 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_ListOfParameters(swigCPtr); 086 } 087 swigCPtr = 0; 088 } 089 super.delete(); 090 } 091 092 093/** 094 * Creates a new {@link ListOfParameters} 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 ListOfParameters(long level, long version) throws org.sbml.libsbml.SBMLConstructorException { 104 this(libsbmlJNI.new_ListOfParameters__SWIG_0(level, version), true); 105 } 106 107 108/** 109 * Creates a new {@link ListOfParameters} 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 ListOfParameters} object to be created. 117 */ public 118 ListOfParameters(SBMLNamespaces sbmlns) throws org.sbml.libsbml.SBMLConstructorException { 119 this(libsbmlJNI.new_ListOfParameters__SWIG_1(SBMLNamespaces.getCPtr(sbmlns), sbmlns), true); 120 } 121 122 123/** 124 * Creates and returns a deep copy of this {@link ListOfParameters} instance. 125 * <p> 126 * @return a (deep) copy of this {@link ListOfParameters}. 127 */ public 128 ListOfParameters cloneObject() { 129 long cPtr = libsbmlJNI.ListOfParameters_cloneObject(swigCPtr, this); 130 return (cPtr == 0) ? null : new ListOfParameters(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 146 * libsbmlConstants#SBML_UNKNOWN SBML_UNKNOWN} (default). 147 * <p> 148 * @see #getElementName() 149 */ public 150 int getTypeCode() { 151 return libsbmlJNI.ListOfParameters_getTypeCode(swigCPtr, this); 152 } 153 154 155/** 156 * Returns the libSBML type code for the objects contained in this {@link ListOf} 157 * (i.e., {@link Parameter} objects, if the list is non-empty). 158 * <p> 159 * LibSBML attaches an identifying code to every 160 * kind of SBML object. These are known as <em>SBML type codes</em>. In 161 * other languages, the set of type codes is stored in an enumeration; in 162 * the Java language interface for libSBML, the type codes are defined as 163 * static integer constants in the interface class {@link 164 * libsbmlConstants}. The names of the type codes all begin with the 165 * characters <code>SBML_.</code> 166 * <p> 167 * @return the SBML type code for the objects contained in this {@link ListOf} 168 * instance, or {@link libsbmlConstants#SBML_UNKNOWN SBML_UNKNOWN} 169 * (default). 170 * <p> 171 * @see #getElementName() 172 */ public 173 int getItemTypeCode() { 174 return libsbmlJNI.ListOfParameters_getItemTypeCode(swigCPtr, this); 175 } 176 177 178/** 179 * Returns the XML element name of this object. 180 * <p> 181 * For {@link ListOfParameters}, the XML element name is <code>'listOfParameters'.</code> 182 * <p> 183 * @return the name of this element, i.e., <code>'listOfParameters'.</code> 184 */ public 185 String getElementName() { 186 return libsbmlJNI.ListOfParameters_getElementName(swigCPtr, this); 187 } 188 189 190/** 191 * Returns the {@link Parameter} object located at position <code>n</code> within this 192 * {@link ListOfParameters} instance. 193 * <p> 194 * @param n the index number of the {@link Parameter} to get. 195 * <p> 196 * @return the nth {@link Parameter} in this {@link ListOfParameters}. If the index <code>n</code> 197 * is out of bounds for the length of the list, then <code>null</code> is returned. 198 * <p> 199 * @see #size() 200 * @see #get(String sid) 201 */ public 202 Parameter get(long n) { 203 long cPtr = libsbmlJNI.ListOfParameters_get__SWIG_0(swigCPtr, this, n); 204 return (cPtr == 0) ? null : new Parameter(cPtr, false); 205 } 206 207 208/** 209 * Returns the first {@link Parameter} object matching the given identifier. 210 * <p> 211 * @param sid a string, the identifier of the {@link Parameter} to get. 212 * <p> 213 * @return the {@link Parameter} object found. The caller owns the returned 214 * object and is responsible for deleting it. If none of the items have 215 * an identifier matching <code>sid</code>, then <code>null</code> is returned. 216 * <p> 217 * @see #get(long n) 218 * @see #size() 219 */ public 220 Parameter get(String sid) { 221 long cPtr = libsbmlJNI.ListOfParameters_get__SWIG_2(swigCPtr, this, sid); 222 return (cPtr == 0) ? null : new Parameter(cPtr, false); 223 } 224 225 226/** 227 * Removes the nth item from this {@link ListOfParameters}, and returns a pointer 228 * to it. 229 * <p> 230 * @param n the index of the item to remove 231 * <p> 232 * @return the item removed. The caller owns the returned object and is 233 * responsible for deleting it. If the index number <code>n</code> is out of 234 * bounds for the length of the list, then <code>null</code> is returned. 235 * <p> 236 * @see #size() 237 */ public 238 Parameter remove(long n) { 239 long cPtr = libsbmlJNI.ListOfParameters_remove__SWIG_0(swigCPtr, this, n); 240 return (cPtr == 0) ? null : new Parameter(cPtr, true); 241 } 242 243 244/** 245 * Removes the first {@link Parameter} object in this {@link ListOfParameters} 246 * matching the given identifier, and returns a pointer to it. 247 * <p> 248 * @param sid the identifier of the item to remove. 249 * <p> 250 * @return the item removed. The caller owns the returned object and is 251 * responsible for deleting it. If none of the items have an identifier 252 * matching <code>sid</code>, then <code>null</code> is returned. 253 */ public 254 Parameter remove(String sid) { 255 long cPtr = libsbmlJNI.ListOfParameters_remove__SWIG_1(swigCPtr, this, sid); 256 return (cPtr == 0) ? null : new Parameter(cPtr, true); 257 } 258 259}