This dictionary style command/query listing provides the following informational elements for each command and/or query. Note that not all command/queries use all descriptive fields. Fields that are Not Applicable are listed as “NA”. For some commands/queries, the descriptive field sequence may vary.
• Command/Query
This is the actual command/query string in their long form syntax with any permitted add-on Cmd Parameters.
In many cases, the command form is listed on the first line and the query form is listed on the second line.
Not all parameters are listed for all commands.
For complete definitions of each parameter type, refer to the VectorStar MS4640B Series Programming Manual – 10410-00322.
• Description
Describes the function of the command/query. For paired command/query entries, the command is described first, and the query second.
Where no query is provided, the description adds “No Query”. Where no command form is provided, the description adds “Query Only.”
If present, the parameter list is defined as a listing and definition of each parameter.
If appropriate, additional descriptions and examples are provided to further describe the command functions and options.
• Command (Cmd) Parameters
Lists the provided Cmd Parameters, usually in the form of an OR statement. For example, if the parameter is listed as <char>: UP|DOWN|LEFT|RIGHT, the permitted values are UP or DOWN or LEFT or RIGHT. This form is used when the Cmd Parameters are the same for the command and query.
Optional parameters are denoted with fuzzy brackets as “{ }”. For example, for the example:
:COMMand <Char1> {<NRf>}
The <Char1> parameter is required and the <NRf> parameter is optional.
• Query Parameters
As above, but used when the query command has optional or required parameters to focus the output to a specific element such as a channel number, trace number, or segment.
• Output
Typically used with queries where it describes what the instrument returns after the query (or sometimes the command) has been issued.
• Range
Lists the range of values available to the command/query such as a frequency range. Where appropriate, the range units are stated.
• Default Value
Provides the default value typically found when the instrument is in an as-shipped factory default state. User-defined instrument configuration settings can change the default values.
• Syntax Example
Note
The Syntax Example is not a script example, and does not imply any specific instrument state, prerequisite settings, equipped equipment, or previously issued commands.
For command/query pairs, the first example line is the command in short form syntax, and, where available, with a typical permitted parameter. If a typical parameter is not available, the required parameter type is shown. The second example line is the query short form a typical value for any permitted value.
This shows an short-form example of the command/query. If available, the command/query includes a typical parameter value. For command/query pairs, the command syntax example is shown first followed by the query syntax example.