Subsystem Command Tables

These paragraphs introduce a more complete, compact way of documenting subsystems using a tabular format. The command table contains more information than just the command hierarchy shown in a graphical tree. In particular, these tables list command parameters for each command and response data formats for queries. To begin this exploration of command tables, consider a simplified SWEep subsystem for the synthesizer in both the graphical and tabular formats.

SWEep

I

DWELI GENeration MANual

AUTO

POlNt

RELative

Figure l-27. Simplified SWEep Command TreeTable 1-2. SWEep Command Table

CommandParameters IParameter Type

SWEep :DWELl

:AUTOstateBoolean(ONCE

:GENeration

:MANual

:POINt

[:RELative]

Reading the Command Table

Note the three columns in the command table labeled Command, Parameters, and Parameter Type. Commands closest to the root level are at the top of the table. Commands in square brackets are implied commands, which are discussed in later paragraphs. If a command requires one or more parameters in addition to the keyword, the parameter names are listed adjacent to the command. Parameters in square brackets are optional parameters, which are discussed in later paragraphs. If the parameter is not in square brackets, it is required and you must send a valid setting for it with

Getting Started Programming 1-71