Current Page:
NeXtMidas Training
Option Trees
Command Dictionary
Dictionary Entries
|
|
- Dictionary Entries:
- Dictionary entries must be in alphabetical order, by command name.
- Dictionary entries are specified as follows:
<name> <s>,<nargs> ,ARG1=,ARG2=,...,ARGn=,
Each entry specifies the following:
- Command name and abbreviation
<name>
- The command name and abbreviation. This is the name of the command (in uppercase)
with an optional star (
* ) indicating the minimum number of letters
(to the left of the star) required when abbreviating the name of the command.
- For example the
EXPLAIN command in the SYS option tree is specified
as EXP*LAIN . This means that any abbreviation of the name starting
with EXP can be used (e.g. EXP , EXPL , and
EXPLAIN would all be valid).
- Command support
<s>
- The one-letter indication of the type of command (P=Primitive, I=Intrinsic,
M=Macro, etc.).
- Number of arguments
<nargs>
- The number of arguments the command takes in.
- The number can be followed by a plus sign (e.g. "
3+ ") to indicate
that it takes N-or-more arguments.
- Primitives (like
PLOT ) that have "Keyword Only Parameters" indicate
this by using plus sign.
- Parameter tags and defaults
ARG1=,ARG2=,...,ARGn=,
- These are commonly called the "defaults" for the command even
though they also include the parameter tags.
(This nomenclature comes from X-Midas where only the default
values are included.)
- This is a comma-separated list of the tags for the command parameters, each
specified in
TAG= form.
- This can optionally include default values for the parameters, which appear
in
TAG=VALUE format. Any defaults that are strings should be
quoted.
- In a few rare instances the parameters are index based and have no corresponding
tag (
CALCULATOR is an example of this). In those cases the
TAG= is omitted.
- Primitives that have "Keyword Only Parameters" do not specify them in the command
dictionary.
- A few examples:
CALC*ULATOR I,2+ ,LABEL=ANSWER,,
DEMO* M,2 ,PORT=9101,REMOTE=localhost:9000,
DATA*LIST P,5 ,FILE=,START=0,NELEM=32,ABSC=IN,FORM=,,
EXP*LAIN I,2 ,NAME=EXPLAIN,SECTION=,
PLOT* P,1+ ,FILE=,
|
|
|