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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2K.1beta (1.48)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>The Available Tokens </TITLE>
<META NAME="description" CONTENT="The Available Tokens ">
<META NAME="keywords" CONTENT="rtic">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v2K.1beta">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="rtic.css">
<LINK REL="next" HREF="node36.html">
<LINK REL="previous" HREF="node20.html">
<LINK REL="up" HREF="node19.html">
<LINK REL="next" HREF="node22.html">
</HEAD>
<BODY bgcolor="white">
<!--Navigation Panel-->
<A NAME="tex2html357"
HREF="node22.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
SRC="/usr/share/latex2html/icons/next.png"></A>
<A NAME="tex2html355"
HREF="node19.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
SRC="/usr/share/latex2html/icons/up.png"></A>
<A NAME="tex2html349"
HREF="node20.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
SRC="/usr/share/latex2html/icons/prev.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html358"
HREF="node22.html">The label Token</A>
<B> Up:</B> <A NAME="tex2html356"
HREF="node19.html">The Lexical GUI builder</A>
<B> Previous:</B> <A NAME="tex2html350"
HREF="node20.html">Introduction</A>
<BR>
<BR>
<!--End of Navigation Panel-->
<H1><A NAME="SECTION00320000000000000000"></A><A NAME="TOKENS"></A>
<BR>
The Available Tokens
</H1>
The available tokens are broken down into two lists: the required and
optional tokens. The required tokens are necessary for every
project. They define some critical information about a particular
control problem. All <TT>user_GUI.par</TT> files must contain these tokens:
<P>
<UL>
<LI><TT>inputs</TT>: defines the number of inputs for the controller (e.g. number of A/D inputs). Its argument, an integer, denotes the number of inputs. This number can later be extracted in the user's controller file (<TT>user_controller.c</TT>) via the constant <TT>NUM_CONTROL_INPUTS</TT>.
<P>
</LI>
<LI><TT>outputs</TT>: like the above, but defines the number of outputs for the controller (e.g. the number of D/A outputs). Its argument, an integer, denotes the number of outputs. The value itself can be extracted via the <TT>NUM_CONTROL_OUTPUTS</TT> macro.
<P>
</LI>
<LI><TT>data_size</TT> or <TT>datasize</TT> or <TT>num_data_pts_per_set</TT>: defines the number of data points per cycle that will be transferred between the embedded tasks and the non-real time tasks via the <TT>RETURN_VAL</TT> macro (see chapter <A HREF="node42.html#user_controller.c">4</A>). This token takes one argument, an integer.
</LI>
</UL>
<P>
As of the latest revision, the <TT>user_GUI.par</TT> parser understands
the following optional tokens. The macro used to extract the numeric
value from the numerically oriented tokens is shown next to each of
the tokens below. Unless otherwise stated, all numerically oriented
tokens have a numerical resolution of <IMG
WIDTH="46" HEIGHT="36" ALIGN="MIDDLE" BORDER="0"
SRC="img40.png"
ALT="$\pm 0.1$">:
<P>
<UL>
<LI><TT>timeout</TT> or <TT>60_second_timeout</TT>: forces the embedded tasks
to stop their execution after sixty seconds. This is especially good
for debugging purposes. This token takes no arguments.
<P>
</LI>
<LI><TT>noIO</TT> or <TT>no_hardware_IO</TT>: forces the embedded tasks to not perform any physical reads and/or writes to the hardware. This is useful for debugging purposes. This token takes no arguments.
<P>
</LI>
<LI><TT>frequency</TT> or <TT>run_time_frequency</TT>: used to specify the default run-time frequency for a given controller. It takes one argument, and it should be specified in Hertz (Hz). The frequency can be extracted during run-time via the constant <TT>GET_RUN_FREQUENCY</TT>.
<P>
</LI>
<LI><TT>tx_rate</TT> or <TT>downsample</TT>: used to specify the downsampling rate between the number of times that the controller executes to the number of times that a data point is transmitted to the non-real time tasks. For example, a downsample ratio of 2 would imply that a data point will be transferred to the non-real time tasks during every other execution of the embedded controller. This token takes one argument, the which should be specified as an integer.
<P>
</LI>
<LI><TT>end_col</TT>: Ends the column. Please refer to section
<A HREF="node24.html#START_COL">3.2.3</A> for a description of its usage.
<P>
</LI>
<LI><TT>end_row</TT>: Ends the row. Please refer to section
<A HREF="node25.html#START_ROW">3.2.4</A> for a description of its usage.
<P>
</LI>
<LI><TT>h_separator</TT>: Introduces a horizontal line to separate
widgets. Please refer to Section <A HREF="node26.html#H_SEPARATOR">3.2.5</A> for a description
of its usage.
<P>
</LI>
<LI><TT>label</TT>: Puts a given piece of text on the window. Please
refer to Section <A HREF="node22.html#LABEL">3.2.1</A> for a full description of this widget.
<P>
</LI>
<LI><TT>matrix</TT>: Used to read in a full <IMG
WIDTH="45" HEIGHT="20" ALIGN="BOTTOM" BORDER="0"
SRC="img41.png"
ALT="$mxn$"> matrix. Please
refer to Section <A HREF="node28.html#MATRIX">3.2.7</A> for a full description of this
widget. The values for this token are extracted by the macro <TT>MATRIX_ELEMENT()</TT> from within the <TT>user_controller.c</TT> file. The
row and column dimensions are extracted with the macros <TT>MAT_DIM_M()</TT> and <TT>MAT_DIM_N()</TT>, respectively, from within the
<TT>user_controller.c</TT> file.
<P>
</LI>
<LI><TT>slider</TT>: Creates a horizontal slider. Please refer to
section <A HREF="node30.html#SLIDER">3.2.9</A> for a more thorough description of the slider
token. The value of this token is extracted from within <TT>user_controller.c</TT> using the <TT>GET_SCALAR_PARAMETER()</TT> macro.
<P>
</LI>
<LI><TT>slider_with_label</TT>: Same as above, but with a
label. Please refer to section <A HREF="node29.html#SLIDER_WITH_LABEL">3.2.8</A> for a more
thorough description of the slider token. The value of this token is
extracted from within <TT>user_controller.c</TT> using the <TT>GET_SCALAR_PARAMETER()</TT> macro.
<P>
</LI>
<LI><TT>spin</TT>: Creates a spin button. Please refer to section
<A HREF="node32.html#SPIN">3.2.11</A> for a more thorough description of the <TT>spin</TT>
token. The value of this token is extracted from within <TT>user_controller.c</TT> using the <TT>GET_SCALAR_PARAMETER()</TT> macro.
<P>
</LI>
<LI><TT>spin_with_label</TT>: Same as above, but with a
label. Please refer to section <A HREF="node31.html#SPIN_WITH_LABEL">3.2.10</A> for a more
thorough description of the <TT>spin_with_label</TT> token. The value
of this token is extracted from within <TT>user_controller.c</TT> using
the <TT>GET_SCALAR_PARAMETER()</TT> macro.
<P>
</LI>
<LI><TT>start_col</TT>: Begins a new column. Note that this
token takes an argument. Please refer to section <A HREF="node24.html#START_COL">3.2.3</A> for a
full description of this token.
<P>
</LI>
<LI><TT>start_row</TT>: Begins a new row. Note that this token takes
an argument. Please refer to section <A HREF="node25.html#START_ROW">3.2.4</A> for a full
description of this token.
<P>
</LI>
<LI><TT>title</TT>: Puts a title field. This is exactly the same as
the label widget but it draws a nice box around the label
itself. Please refer to Section <A HREF="node23.html#TITLE">3.2.2</A> for a description of the
usage of this token.
<P>
</LI>
<LI><TT>toggle</TT>: creates a toggle button which takes the values of
either ``0'' or ``1''. Please refer to section <A HREF="node33.html#TOGGLE">3.2.12</A> for a full
description of this token. The value of this token is extracted from
within <TT>user_controller.c</TT> using the <TT>GET_SCALAR_PARAMETER()</TT>
macro.
<P>
</LI>
<LI><TT>trigger</TT>: same as above, but momentary. That is, releasing
the button will cause the button to revert to its original
state. Please refer to section <A HREF="node34.html#TRIGGER">3.2.13</A> for a full description of
this token. The value of this token is extracted from within <TT>user_controller.c</TT> using the <TT>GET_SCALAR_PARAMETER()</TT> macro.
<P>
</LI>
<LI><TT>v_separator</TT>: Introduces a vertical line to separate
widgets. Please refer to Section <A HREF="node27.html#V_SEPARATOR">3.2.6</A> for a description
of its usage.
<P>
</LI>
<LI><TT>vslider</TT>: Creates a vertical slider. Please refer to
section <A HREF="node35.html#VSLIDER">3.2.14</A> for a more thorough description of the slider
token. The value of this token is extracted from within <TT>user_controller.c</TT> using the <TT>GET_SCALAR_PARAMETER()</TT> macro.
<P>
</LI>
<LI><TT>#</TT> (the pound sign): Insert a comment. Any characters that
appear between the # and the end of the line are ignored.
<P>
</LI>
</UL>
<P>
The following sections give a more detailed explanation for some of the aforementioned tokens.
<P>
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html359"
HREF="node22.html">The <TT>label</TT> Token</A>
<LI><A NAME="tex2html360"
HREF="node23.html">The <TT>title</TT> Token</A>
<LI><A NAME="tex2html361"
HREF="node24.html">The <TT>start_col</TT> and <TT>end_col</TT> Tokens </A>
<LI><A NAME="tex2html362"
HREF="node25.html">The <TT>start_row</TT> and <TT>end_row</TT> Tokens </A>
<LI><A NAME="tex2html363"
HREF="node26.html">The <TT>h_separator</TT> Token </A>
<LI><A NAME="tex2html364"
HREF="node27.html">The <TT>v_separator</TT> Token </A>
<LI><A NAME="tex2html365"
HREF="node28.html">The <TT>matrix</TT> Token </A>
<LI><A NAME="tex2html366"
HREF="node29.html">The <TT>slider_with_label</TT> Token</A>
<LI><A NAME="tex2html367"
HREF="node30.html">The <TT>slider</TT> Token</A>
<LI><A NAME="tex2html368"
HREF="node31.html">The <TT>spin_with_label</TT> Token</A>
<LI><A NAME="tex2html369"
HREF="node32.html">The <TT>spin</TT> Token</A>
<LI><A NAME="tex2html370"
HREF="node33.html">The <TT>toggle</TT> Token </A>
<LI><A NAME="tex2html371"
HREF="node34.html">The <TT>trigger</TT> Token </A>
<LI><A NAME="tex2html372"
HREF="node35.html">The <TT>vslider</TT> Token</A>
</UL>
<!--End of Table of Child-Links-->
<HR>
<!--Navigation Panel-->
<A NAME="tex2html357"
HREF="node22.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
SRC="/usr/share/latex2html/icons/next.png"></A>
<A NAME="tex2html355"
HREF="node19.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
SRC="/usr/share/latex2html/icons/up.png"></A>
<A NAME="tex2html349"
HREF="node20.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
SRC="/usr/share/latex2html/icons/prev.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html358"
HREF="node22.html">The label Token</A>
<B> Up:</B> <A NAME="tex2html356"
HREF="node19.html">The Lexical GUI builder</A>
<B> Previous:</B> <A NAME="tex2html350"
HREF="node20.html">Introduction</A>
<!--End of Navigation Panel-->
<ADDRESS>
Michael Barabanov
2001-06-19
</ADDRESS>
</BODY>
</HTML>
|
