File: rule.html

package info (click to toggle)
sbmltoolbox 4.1.0-5.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,032 kB
  • sloc: xml: 2,438; makefile: 8; sh: 7
file content (166 lines) | stat: -rw-r--r-- 2,594 bytes parent folder | download | duplicates (5)
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
<h3>MATLAB<em>SBML</em>STRUCTURE_FUNCTIONS\RULE</h3>

<p>The functions allow users to create and work with the SBML Rule structure.</p>

<p>Function are:</p>

<hr>

<h4>Rule = Rule_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 Rule 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>formula = Rule_getFormula(SBMLRule)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule structure</li>
</ol>

<p>Returns</p>

<ol>
<li>the value of the formula attribute</li>
</ol>

<hr>

<h4>sboTerm = Rule_getSBOTerm(SBMLRule)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule structure</li>
</ol>

<p>Returns</p>

<ol>
<li>the value of the sboTerm attribute</li>
</ol>

<hr>

<h4>value = Rule_isSetFormula(SBMLRule)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule 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 = Rule_isSetSBOTerm(SBMLRule)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule structure</li>
</ol>

<p>Returns</p>

<ol>
<li>value = 
<ul>
<li>1 if the sboTerm attribute is set</li>
<li>0 otherwise</li>
</ul></li>
</ol>

<hr>

<h4>SBMLRule = Rule_setFormula(SBMLRule, formula)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule structure</li>
<li>formula; a string representing the formula to be set</li>
</ol>

<p>Returns</p>

<ol>
<li>the SBML Rule structure with the new value for the formula attribute</li>
</ol>

<hr>

<h4>SBMLRule = Rule_setSBOTerm(SBMLRule, sboTerm)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule structure</li>
<li>sboTerm, an integer representing the sboTerm to be set</li>
</ol>

<p>Returns</p>

<ol>
<li>the SBML Rule structure with the new value for the sboTerm attribute</li>
</ol>

<hr>

<h4>SBMLRule = Rule_unsetFormula(SBMLRule)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule structure</li>
</ol>

<p>Returns</p>

<ol>
<li>the SBML Rule structure with the formula attribute unset</li>
</ol>

<hr>

<h4>SBMLRule = Rule_unsetSBOTerm(SBMLRule)</h4>

<p>Takes</p>

<ol>
<li>SBMLRule, an SBML Rule structure</li>
</ol>

<p>Returns</p>

<ol>
<li>the SBML Rule structure with the sboTerm attribute unset</li>
</ol>

<hr>