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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
% toolbox\MATLAB_SBML_Structure_Functions\Compartment
%
% The functions allow users to create and work with the SBML Compartment structure.
%
%=======================================================================
% Compartment = Compartment_create(level(optional), version(optional) )
%=======================================================================
% Takes
% 1. level, an integer representing an SBML level (optional)
% 2. version, an integer representing an SBML version (optional)
% Returns
% 1. a MATLAB_SBML Compartment structure of the appropriate level and version
%
%===================================================================
% compartmentType = Compartment_getCompartmentType(SBMLCompartment)
%===================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the compartmentType attribute
%
%=====================================================
% constant = Compartment_getConstant(SBMLCompartment)
%=====================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the constant attribute
%
%=========================================
% id = Compartment_getId(SBMLCompartment)
%=========================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the id attribute
%
%=================================================
% metaid = Compartment_getMetaid(SBMLCompartment)
%=================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the metaid attribute
%
%=============================================
% name = Compartment_getName(SBMLCompartment)
%=============================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the name attribute
%
%===================================================
% outside = Compartment_getOutside(SBMLCompartment)
%===================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the outside attribute
%
%===================================================
% sboTerm = Compartment_getSBOTerm(SBMLCompartment)
%===================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the sboTerm attribute
%
%=============================================
% size = Compartment_getSize(SBMLCompartment)
%=============================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the size attribute
%
%=======================================================================
% spatialDimensions = Compartment_getSpatialDimensions(SBMLCompartment)
%=======================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the spatialDimensions attribute
%
%===============================================
% units = Compartment_getUnits(SBMLCompartment)
%===============================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the units attribute
%
%=================================================
% volume = Compartment_getVolume(SBMLCompartment)
%=================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the value of the volume attribute
%
%==================================================================
% y = Compartment_isAssignedByRateRule(SBMLCompartment, SBMLRules)
%==================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. SBMLRules; the array of rules from an SBML Model structure
% Returns
% y =
% - the index of the rateRule used to assigned value to the Compartment
% - 0 if the Compartment is not assigned by rateRule
%<!---------------------------------------------------------------------------
% This file is part of SBMLToolbox. Please visit http://sbml.org for more
% information about SBML, and the latest version of SBMLToolbox.
% Copyright (C) 2009-2012 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
% Copyright (C) 2006-2008 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. University of Hertfordshire, Hatfield, UK
% Copyright (C) 2003-2005 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. Japan Science and Technology Agency, Japan
% 3. University of Hertfordshire, Hatfield, UK
% SBMLToolbox is free software; you can redistribute it and/or modify it
% under the terms of the GNU Lesser General Public License as published by
% the Free Software Foundation. A copy of the license agreement is provided
% in the file named "LICENSE.txt" included with this software distribution.
%----------------------------------------------------------------------- -->
%
%==============================================================
% y = Compartment_isAssignedByRule(SBMLCompartment, SBMLRules)
%==============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. SBMLRules; the array of rules from an SBML Model structure
% Returns
% y =
% - the index of the assignmentRule used to assigned value to the Compartment
% - 0 if the Compartment is not assigned by assignmentRule
%<!---------------------------------------------------------------------------
% This file is part of SBMLToolbox. Please visit http://sbml.org for more
% information about SBML, and the latest version of SBMLToolbox.
% Copyright (C) 2009-2012 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
% Copyright (C) 2006-2008 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. University of Hertfordshire, Hatfield, UK
% Copyright (C) 2003-2005 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. Japan Science and Technology Agency, Japan
% 3. University of Hertfordshire, Hatfield, UK
% SBMLToolbox is free software; you can redistribute it and/or modify it
% under the terms of the GNU Lesser General Public License as published by
% the Free Software Foundation. A copy of the license agreement is provided
% in the file named "LICENSE.txt" included with this software distribution.
%----------------------------------------------------------------------- -->
%
%===============================================================
% y = Compartment_isInAlgebraicRule(SBMLCompartment, SBMLRules)
%===============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. SBMLRules; the array of rules from an SBML Model structure
% Returns
% y =
% - an array of the indices of any algebraicRules the id of the Compartment appears in
% - 0 if the Compartment appears in no algebraicRules
%<!---------------------------------------------------------------------------
% This file is part of SBMLToolbox. Please visit http://sbml.org for more
% information about SBML, and the latest version of SBMLToolbox.
% Copyright (C) 2009-2012 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
% Copyright (C) 2006-2008 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. University of Hertfordshire, Hatfield, UK
% Copyright (C) 2003-2005 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. Japan Science and Technology Agency, Japan
% 3. University of Hertfordshire, Hatfield, UK
% SBMLToolbox is free software; you can redistribute it and/or modify it
% under the terms of the GNU Lesser General Public License as published by
% the Free Software Foundation. A copy of the license agreement is provided
% in the file named "LICENSE.txt" included with this software distribution.
%----------------------------------------------------------------------- -->
%
%===========================================================
% value = Compartment_isSetCompartmentType(SBMLCompartment)
%===========================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the compartmentType attribute is set
% - 0 otherwise
%
%==============================================
% value = Compartment_isSetId(SBMLCompartment)
%==============================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the id attribute is set
% - 0 otherwise
%
%==================================================
% value = Compartment_isSetMetaid(SBMLCompartment)
%==================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the metaid attribute is set
% - 0 otherwise
%
%================================================
% value = Compartment_isSetName(SBMLCompartment)
%================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the name attribute is set
% - 0 otherwise
%
%===================================================
% value = Compartment_isSetOutside(SBMLCompartment)
%===================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the outside attribute is set
% - 0 otherwise
%
%===================================================
% value = Compartment_isSetSBOTerm(SBMLCompartment)
%===================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the sboTerm attribute is set
% - 0 otherwise
%
%================================================
% value = Compartment_isSetSize(SBMLCompartment)
%================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the size attribute is set
% - 0 otherwise
%
%=============================================================
% value = Compartment_isSetSpatialDimensions(SBMLCompartment)
%=============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the spatialDimensions attribute is set
% - 0 otherwise
%
%=================================================
% value = Compartment_isSetUnits(SBMLCompartment)
%=================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the units attribute is set
% - 0 otherwise
%
%==================================================
% value = Compartment_isSetVolume(SBMLCompartment)
%==================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. value =
% - 1 if the volume attribute is set
% - 0 otherwise
%
%====================================================================================
% SBMLCompartment = Compartment_setCompartmentType(SBMLCompartment, compartmentType)
%====================================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. compartmentType; a string representing the compartmentType to be set
% Returns
% 1. the SBML Compartment structure with the new value for the compartmentType attribute
%
%======================================================================
% SBMLCompartment = Compartment_setConstant(SBMLCompartment, constant)
%======================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. constant, an integer (0/1) representing the value of constant to be set
% Returns
% 1. the SBML Compartment structure with the new value for the constant attribute
%
%==========================================================
% SBMLCompartment = Compartment_setId(SBMLCompartment, id)
%==========================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. id; a string representing the id to be set
% Returns
% 1. the SBML Compartment structure with the new value for the id attribute
%
%==================================================================
% SBMLCompartment = Compartment_setMetaid(SBMLCompartment, metaid)
%==================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. metaid; a string representing the metaid to be set
% Returns
% 1. the SBML Compartment structure with the new value for the metaid attribute
%
%==============================================================
% SBMLCompartment = Compartment_setName(SBMLCompartment, name)
%==============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. name; a string representing the name to be set
% Returns
% 1. the SBML Compartment structure with the new value for the name attribute
%
%====================================================================
% SBMLCompartment = Compartment_setOutside(SBMLCompartment, outside)
%====================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. outside; a string representing the outside to be set
% Returns
% 1. the SBML Compartment structure with the new value for the outside attribute
%
%====================================================================
% SBMLCompartment = Compartment_setSBOTerm(SBMLCompartment, sboTerm)
%====================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. sboTerm, an integer representing the sboTerm to be set
% Returns
% 1. the SBML Compartment structure with the new value for the sboTerm attribute
%
%==============================================================
% SBMLCompartment = Compartment_setSize(SBMLCompartment, size)
%==============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. size; number representing the value of size to be set
% Returns
% 1. the SBML Compartment structure with the new value for the size attribute
%
%========================================================================================
% SBMLCompartment = Compartment_setSpatialDimensions(SBMLCompartment, spatialDimensions)
%========================================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. spatialDimensions; number representing the value of spatialDimensions to be set
% Returns
% 1. the SBML Compartment structure with the new value for the spatialDimensions attribute
%
%================================================================
% SBMLCompartment = Compartment_setUnits(SBMLCompartment, units)
%================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. units; a string representing the units to be set
% Returns
% 1. the SBML Compartment structure with the new value for the units attribute
%
%==================================================================
% SBMLCompartment = Compartment_setVolume(SBMLCompartment, volume)
%==================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% 2. volume; number representing the value of volume to be set
% Returns
% 1. the SBML Compartment structure with the new value for the volume attribute
%
%=====================================================================
% SBMLCompartment = Compartment_unsetCompartmentType(SBMLCompartment)
%=====================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the compartmentType attribute unset
%
%========================================================
% SBMLCompartment = Compartment_unsetId(SBMLCompartment)
%========================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the id attribute unset
%
%============================================================
% SBMLCompartment = Compartment_unsetMetaid(SBMLCompartment)
%============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the metaid attribute unset
%
%==========================================================
% SBMLCompartment = Compartment_unsetName(SBMLCompartment)
%==========================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the name attribute unset
%
%=============================================================
% SBMLCompartment = Compartment_unsetOutside(SBMLCompartment)
%=============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the outside attribute unset
%
%=============================================================
% SBMLCompartment = Compartment_unsetSBOTerm(SBMLCompartment)
%=============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the sboTerm attribute unset
%
%==========================================================
% SBMLCompartment = Compartment_unsetSize(SBMLCompartment)
%==========================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the size attribute unset
%
%=======================================================================
% SBMLCompartment = Compartment_unsetSpatialDimensions(SBMLCompartment)
%=======================================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the spatialDimensions attribute unset
%
%===========================================================
% SBMLCompartment = Compartment_unsetUnits(SBMLCompartment)
%===========================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the units attribute unset
%
%============================================================
% SBMLCompartment = Compartment_unsetVolume(SBMLCompartment)
%============================================================
% Takes
% 1. SBMLCompartment, an SBML Compartment structure
% Returns
% 1. the SBML Compartment structure with the volume attribute unset
%
%<!---------------------------------------------------------------------------
% This file is part of SBMLToolbox. Please visit http://sbml.org for more
% information about SBML, and the latest version of SBMLToolbox.
%
% Copyright (C) 2009-2012 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
%
% Copyright (C) 2006-2008 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. University of Hertfordshire, Hatfield, UK
%
% Copyright (C) 2003-2005 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. Japan Science and Technology Agency, Japan
% 3. University of Hertfordshire, Hatfield, UK
%
% SBMLToolbox is free software; you can redistribute it and/or modify it
% under the terms of the GNU Lesser General Public License as published by
% the Free Software Foundation. A copy of the license agreement is provided
% in the file named "LICENSE.txt" included with this software distribution.
%----------------------------------------------------------------------- -->
|
