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
|
% toolbox\fbc_package\MATLAB_SBML_Structures\Objective
%
% The functions allow users to create and work with the SBML FBC Objective structure.
%
%==============================================================================
% SBMLObjective = Objective_addFluxObjective(SBMLObjective, SBMLFluxObjective)
%==============================================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% 2. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the SBML Objective structure with the SBML FluxObjective structure added
%
%==========================================================
% Objective = Objective_create(level, version, pkgVersion)
%==========================================================
% Takes
% 1. level, an integer representing an SBML level
% 2. version, an integer representing an SBML version
% 3. pkgVersion, an integer representing an SBML package version
% Returns
% 1. a MATLAB_SBML FBC Objective structure of the appropriate level, version and pkgVersion
%
%==============================================================
% SBMLObjective = Objective_createFluxObjective(SBMLObjective)
%==============================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the SBML Objective structure with a new SBML FluxObjective structure added
%
%==================================================================
% fluxObjective = Objective_getFluxObjective(SBMLObjective, index)
%==================================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% 2. index, an integer representing the index of SBML FluxObjective structure
% Returns
% 1. the SBML FluxObjective structure at the indexed position
%
%=====================================
% id = Objective_getId(SBMLObjective)
%=====================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the value of the fbc_id attribute
%
%==================================================================
% fluxObjective = Objective_getListOfFluxObjectives(SBMLObjective)
%==================================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. an array of the fluxObjective structures
%
%=============================================
% metaid = Objective_getMetaid(SBMLObjective)
%=============================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the value of the metaid attribute
%
%=====================================================
% num = Objective_getNumFluxObjectives(SBMLObjective)
%=====================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the number of SBML FluxObjective structures present in the Objective
%
%===============================================
% sboTerm = Objective_getSBOTerm(SBMLObjective)
%===============================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the value of the sboTerm attribute
%
%=========================================
% type = Objective_getType(SBMLObjective)
%=========================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the value of the fbc_type attribute
%
%=======================================
% id = Objective_isSetId(SBMLObjective)
%=======================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. value =
% - 1 if the fbc_id attribute is set
% - 0 otherwise
%
%===============================================
% metaid = Objective_isSetMetaid(SBMLObjective)
%===============================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. value =
% - 1 if the metaid attribute is set
% - 0 otherwise
%
%=================================================
% sboTerm = Objective_isSetSBOTerm(SBMLObjective)
%=================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. value =
% - 1 if the sboTerm attribute is set
% - 0 otherwise
%
%===========================================
% type = Objective_isSetType(SBMLObjective)
%===========================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. value =
% - 1 if the fbc_type attribute is set
% - 0 otherwise
%
%====================================================
% SBMLObjective = Objective_setId(SBMLObjective, id)
%====================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% 2. id, a string representing the fbc_id to be set
% Returns
% 1. the SBML FBC Objective structure with the new value for the fbc_id attribute
%
%============================================================
% SBMLObjective = Objective_setMetaid(SBMLObjective, metaid)
%============================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% 2. metaid, a string representing the metaid to be set
% Returns
% 1. the SBML FBC Objective structure with the new value for the metaid attribute
%
%==============================================================
% SBMLObjective = Objective_setSBOTerm(SBMLObjective, sboTerm)
%==============================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% 2. sboTerm, a number representing the sboTerm to be set
% Returns
% 1. the SBML FBC Objective structure with the new value for the sboTerm attribute
%
%========================================================
% SBMLObjective = Objective_setType(SBMLObjective, type)
%========================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% 2. type, a string representing the fbc_type to be set
% Returns
% 1. the SBML FBC Objective structure with the new value for the fbc_type attribute
%
%==================================================
% SBMLObjective = Objective_unsetId(SBMLObjective)
%==================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the SBML FBC Objective structure with the fbc_id attribute unset
%
%======================================================
% SBMLObjective = Objective_unsetMetaid(SBMLObjective)
%======================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the SBML FBC Objective structure with the metaid attribute unset
%
%=======================================================
% SBMLObjective = Objective_unsetSBOTerm(SBMLObjective)
%=======================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the SBML FBC Objective structure with the sboTerm attribute unset
%
%====================================================
% SBMLObjective = Objective_unsetType(SBMLObjective)
%====================================================
% Takes
% 1. SBMLObjective, an SBML Objective structure
% Returns
% 1. the SBML FBC Objective structure with the fbc_type 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.
%----------------------------------------------------------------------- -->
|
