5.2.7 Example Command Table
The command tree can also be presented as a table. The hypothetical instrument
command
tree portion
of
Figure 5-3 is shown below as Table 5-1. The symbols used
with the tree are also used with the table.
The angle brackets
« » indicate the parameter is entered by the user. Lower case
text between the angle brackets show the parameter that is expected. ON/OFF are
Boolean parameters. Discrete parameters often appear as command keywords in
the command table, but must not be confused; a whitespace is still required before
them on the command
Hne.
AlI parameters have manufacturer specified default
values which will exist at power-up
or
*RST. Numerical values entered, which are
out
of
range for the branch, will not be acted upon and will retum an error when the
SYSTem:ERRor? query is sent.
The
sqnare hrackets ([ ]) are optional commands that are
not
required
in
the
command Hne, but may be used for documentation clarity. Some parameters or
portions
of
parameters may be optional and will
be
shown with square brackets
around them.
Table 5-1. EXAMPLE MARKER COMMAND TABLE
COMMAND PARAMETERS PARAMETER TYPE
:
MARKer
POSition
POINt
AOFF
[STATe]
SYNC
<name>
<address>
<name>
state
(optionalJ
detector
numeric (label)
numeric
numeric (label)
Boolean
discrete
5-8 Remote Operation
Under
the
"Command"
heading
in
the table, the subsystem
command
is not
indented. Each sub-command is indented showing the level
of
subordination. The
Parameter column indicates the parameter expected for the commando The
Parameter Type column shows the type
of
parameter for the sub-command.
5.2.8 Example Command Syntax Diagrams
The command Hst can also
be
presented as a syntax (or railroad) diagram. The
hypothetical instrument command tree
in
Figure 5-3 is
shawn
on the following
pages as raiIroad diagrams. Some symbols used with the tree are also used with the
diagram.
RaiIroad diagrams (so called because they look like raiIroad layouts from above) are
another way to present the command flow. There is a raiIroad diagram for each
command in a subsystem. As with the command tree
and
the
command
table,
raiIroad diagrams have some unique symbols.
Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com