1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
<style type='text/css'>
/*/*/ /*<![CDATA[*/
@import "../style.css";
/*]]>*/ /* */
</style>
<h3>MATLAB_SBML_STRUCTURE_FUNCTIONS\COMPARTMENTVOLUMERULE</h3>
<p>The functions allow users to create and work with the SBML CompartmentVolumeRule structure.</p>
<p>Function are:</p>
<hr>
<h4>CompartmentVolumeRule = CompartmentVolumeRule_create(level(optional), version(optional) )</h4>
<p>Takes</p>
<ol>
<li>level, an integer representing an SBML level (optional)</li>
<li>version, an integer representing an SBML version (optional)</li>
</ol>
<p>Returns</p>
<ol>
<li>a MATLAB_SBML CompartmentVolumeRule structure of the appropriate level and version</li>
</ol>
<p><em>NOTE:</em> the optional level and version preserve backwards compatibility
a missing version argument will default to L1V2; L2V4 or L3V1
missing both arguments will default to L3V1</p>
<hr>
<h4>compartment = CompartmentVolumeRule_getCompartment(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>the value of the compartment attribute</li>
</ol>
<hr>
<h4>formula = CompartmentVolumeRule_getFormula(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>the value of the formula attribute</li>
</ol>
<hr>
<h4>type = CompartmentVolumeRule_getType(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>the value of the type attribute</li>
</ol>
<hr>
<h4>value = CompartmentVolumeRule_isSetCompartment(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>value =
<ul>
<li>1 if the compartment attribute is set</li>
<li>0 otherwise</li>
</ul></li>
</ol>
<hr>
<h4>value = CompartmentVolumeRule_isSetFormula(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>value =
<ul>
<li>1 if the formula attribute is set</li>
<li>0 otherwise</li>
</ul></li>
</ol>
<hr>
<h4>value = CompartmentVolumeRule_isSetType(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>value =
<ul>
<li>1 if the type attribute is set</li>
<li>0 otherwise</li>
</ul></li>
</ol>
<hr>
<h4>SBMLCompartmentVolumeRule = CompartmentVolumeRule_setCompartment(SBMLCompartmentVolumeRule, compartment)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
<li>compartment; a string representing the compartment to be set</li>
</ol>
<p>Returns</p>
<ol>
<li>the SBML CompartmentVolumeRule structure with the new value for the compartment attribute</li>
</ol>
<hr>
<h4>SBMLCompartmentVolumeRule = CompartmentVolumeRule_setFormula(SBMLCompartmentVolumeRule, formula)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
<li>formula; a string representing the formula to be set</li>
</ol>
<p>Returns</p>
<ol>
<li>the SBML CompartmentVolumeRule structure with the new value for the formula attribute</li>
</ol>
<hr>
<h4>SBMLCompartmentVolumeRule = CompartmentVolumeRule_setType(SBMLCompartmentVolumeRule, type)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
<li>type; a string representing the type to be set</li>
</ol>
<p>Returns</p>
<ol>
<li>the SBML CompartmentVolumeRule structure with the new value for the type attribute</li>
</ol>
<hr>
<h4>SBMLCompartmentVolumeRule = CompartmentVolumeRule_unsetCompartment(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>the SBML CompartmentVolumeRule structure with the compartment attribute unset</li>
</ol>
<hr>
<h4>SBMLCompartmentVolumeRule = CompartmentVolumeRule_unsetFormula(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>the SBML CompartmentVolumeRule structure with the formula attribute unset</li>
</ol>
<hr>
<h4>SBMLCompartmentVolumeRule = CompartmentVolumeRule_unsetType(SBMLCompartmentVolumeRule)</h4>
<p>Takes</p>
<ol>
<li>SBMLCompartmentVolumeRule, an SBML CompartmentVolumeRule structure</li>
</ol>
<p>Returns</p>
<ol>
<li>the SBML CompartmentVolumeRule structure with the type attribute unset</li>
</ol>
<hr>
|