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
|
% toolbox\MATLAB_SBML_Structure_Functions\Event
%
% The functions allow users to create and work with the SBML Event structure.
%
%======================================================================
% SBMLEvent = Event_addEventAssignment(SBMLEvent, SBMLEventAssignment)
%======================================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. SBMLEventAssignment, an SBML EventAssignment structure
% Returns
% 1. the SBML Event structure with the SBML EventAssignment structure added
%
%===========================================================
% Event = Event_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 Event structure of the appropriate level and version
%
%==========================================
% SBMLEvent = Event_createDelay(SBMLEvent)
%==========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with a new SBML Delay structure added
%
%=====================================================
% SBMLEvent = Event_acreateEventAssignment(SBMLEvent)
%=====================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with a new SBML EventAssignment structure added
%
%=============================================
% SBMLEvent = Event_createPriority(SBMLEvent)
%=============================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with a new SBML Priority structure added
%
%============================================
% SBMLEvent = Event_createTrigger(SBMLEvent)
%============================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with a new SBML Trigger structure added
%
%===================================
% delay = Event_getDelay(SBMLEvent)
%===================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Delay structure
%
%==============================================================
% eventAssignment = Event_getEventAssignment(SBMLEvent, index)
%==============================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. index, an integer representing the index of SBML EventAssignment structure
% Returns
% 1. the SBML EventAssignment structure at the indexed position
%
%=============================
% id = Event_getId(SBMLEvent)
%=============================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the value of the id attribute
%
%==============================================================
% eventAssignment = Event_getListOfEventAssignments(SBMLEvent)
%==============================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. an array of the eventAssignment structures
%
%=====================================
% metaid = Event_getMetaid(SBMLEvent)
%=====================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the value of the metaid attribute
%
%=================================
% name = Event_getName(SBMLEvent)
%=================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the value of the name attribute
%
%===============================================
% num = Event_getNumEventAssignments(SBMLEvent)
%===============================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the number of SBML EventAssignment structures present in the Event
%
%=========================================
% priority = Event_getPriority(SBMLEvent)
%=========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Priority structure
%
%=======================================
% sboTerm = Event_getSBOTerm(SBMLEvent)
%=======================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the value of the sboTerm attribute
%
%===========================================
% timeUnits = Event_getTimeUnits(SBMLEvent)
%===========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the value of the timeUnits attribute
%
%=======================================
% trigger = Event_getTrigger(SBMLEvent)
%=======================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Trigger structure
%
%=========================================================================
% useValuesFromTriggerTime = Event_getUseValuesFromTriggerTime(SBMLEvent)
%=========================================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the value of the useValuesFromTriggerTime attribute
%
%=====================================
% value = Event_isSetDelay(SBMLEvent)
%=====================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the delay structure is set
% - 0 otherwise
%
%==================================
% value = Event_isSetId(SBMLEvent)
%==================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the id attribute is set
% - 0 otherwise
%
%======================================
% value = Event_isSetMetaid(SBMLEvent)
%======================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the metaid attribute is set
% - 0 otherwise
%
%====================================
% value = Event_isSetName(SBMLEvent)
%====================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the name attribute is set
% - 0 otherwise
%
%========================================
% value = Event_isSetPriority(SBMLEvent)
%========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the priority structure is set
% - 0 otherwise
%
%=======================================
% value = Event_isSetSBOTerm(SBMLEvent)
%=======================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the sboTerm attribute is set
% - 0 otherwise
%
%=========================================
% value = Event_isSetTimeUnits(SBMLEvent)
%=========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the timeUnits attribute is set
% - 0 otherwise
%
%=======================================
% value = Event_isSetTrigger(SBMLEvent)
%=======================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. value =
% - 1 if the trigger structure is set
% - 0 otherwise
%
%==================================================
% SBMLEvent = Event_setDelay(SBMLEvent, SBMLDelay)
%==================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. SBMLDelay, an SBML Delay structure
% Returns
% 1. the SBML Event structure with the new value for the delay field
%
%========================================
% SBMLEvent = Event_setId(SBMLEvent, id)
%========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. id; a string representing the id to be set
% Returns
% 1. the SBML Event structure with the new value for the id attribute
%
%================================================
% SBMLEvent = Event_setMetaid(SBMLEvent, metaid)
%================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. metaid; a string representing the metaid to be set
% Returns
% 1. the SBML Event structure with the new value for the metaid attribute
%
%============================================
% SBMLEvent = Event_setName(SBMLEvent, name)
%============================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. name; a string representing the name to be set
% Returns
% 1. the SBML Event structure with the new value for the name attribute
%
%========================================================
% SBMLEvent = Event_setPriority(SBMLEvent, SBMLPriority)
%========================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. SBMLPriority, an SBML Priority structure
% Returns
% 1. the SBML Event structure with the new value for the priority field
%
%==================================================
% SBMLEvent = Event_setSBOTerm(SBMLEvent, sboTerm)
%==================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. sboTerm, an integer representing the sboTerm to be set
% Returns
% 1. the SBML Event structure with the new value for the sboTerm attribute
%
%======================================================
% SBMLEvent = Event_setTimeUnits(SBMLEvent, timeUnits)
%======================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. timeUnits; a string representing the timeUnits to be set
% Returns
% 1. the SBML Event structure with the new value for the timeUnits attribute
%
%======================================================
% SBMLEvent = Event_setTrigger(SBMLEvent, SBMLTrigger)
%======================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. SBMLTrigger, an SBML Trigger structure
% Returns
% 1. the SBML Event structure with the new value for the trigger field
%
%====================================================================================
% SBMLEvent = Event_setUseValuesFromTriggerTime(SBMLEvent, useValuesFromTriggerTime)
%====================================================================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% 2. useValuesFromTriggerTime, an integer (0/1) representing the value of useValuesFromTriggerTime to be set
% Returns
% 1. the SBML Event structure with the new value for the useValuesFromTriggerTime attribute
%
%=========================================
% SBMLEvent = Event_unsetDelay(SBMLEvent)
%=========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the delay field unset
%
%======================================
% SBMLEvent = Event_unsetId(SBMLEvent)
%======================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the id attribute unset
%
%==========================================
% SBMLEvent = Event_unsetMetaid(SBMLEvent)
%==========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the metaid attribute unset
%
%========================================
% SBMLEvent = Event_unsetName(SBMLEvent)
%========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the name attribute unset
%
%============================================
% SBMLEvent = Event_unsetPriority(SBMLEvent)
%============================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the priority field unset
%
%===========================================
% SBMLEvent = Event_unsetSBOTerm(SBMLEvent)
%===========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the sboTerm attribute unset
%
%=============================================
% SBMLEvent = Event_unsetTimeUnits(SBMLEvent)
%=============================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the timeUnits attribute unset
%
%===========================================
% SBMLEvent = Event_unsetTrigger(SBMLEvent)
%===========================================
% Takes
% 1. SBMLEvent, an SBML Event structure
% Returns
% 1. the SBML Event structure with the trigger field 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.
%----------------------------------------------------------------------- -->
|
