Notational Conventions in this Command Reference

This section describes how to read the description of commands in this chapter.

Syntax

The section headed by “Syntax” describes the syntax to send a command from the external controller to the E4982A.The syntax consists of a command part and a parameter part. The separator between the command part and the parameter part is a space.

When there are several parameters, a comma (,) is used as the separator between adjacent parameters. When the syntax contains an ellipsis between commas, it indicates the omission of one or more parameters; for example, “<numeric 1>,..., <numeric 4>” means that you should specify four parameters: <numeric 1>, <numeric 2>, <numeric 3>, and <numeric 4>. A string type parameter, such as <string> or <string 1>, must be enclosed with double quotes.

You can omit the lowercase characters of a keyword. For example, you can specify :SYST:PRES instead of :SYSTem:PRESet.

The definition of symbols used in the syntax are as follows:

<>

Characters enclosed by angular brackets are necessary parameters when sending the command.

[]

Parts enclosed by square brackets can be omitted.

{}

Braces indicate that you must select one of the items in this part. Each item is separated by a vertical bar (|).

Description

The section headed by “Description” describes how to use the command or the operation when executed.

Variable

Variable provides description about different variables that can be used with the command objects. It gives the description, data type, allowable range, preset value, unit, resolution, and notes for variable (italic) shown in the syntax.

The data types of the command objects include 5 types as shown in the following table. Before using variables, declare the data type of each variable. If you do not declare the data type of a variable, it is automatically processed as a variant type.

Data type

Name

Consumed memory

Range

Long

Long integer

4 bytes

-2,147,483,648 to 2,147,483,647

Double

Double precision floating point type

8 bytes

For a negative value: -1.79769313486232E+308 to -4.94065645841247E-324

For a positive value: -1.79769313486232E+308 to -4.94065645841247E-324

Boolean

Boolean type

2 bytes

For SCPI: ON or OFF

String

Character string type

1 byte / alphanumeric character

Up to approximately 2 billion characters

Variant

Variant type

16 bytes

No limitation

Query response

The section headed by “Query response” describes the data format read out when a query (data read-out) is available with this command.

Each read-out parameter is enclosed with {}. If there are several items within {} separated by a vertical bar (|), only one of them is read out.

When several parameters are read out, they are separated with a comma (,). An ellipsis between commas (...) indicates that the data of that part is omitted. For example, {numeric 1},...,{numeric 4} indicates that four data items, {numeric 1}, {numeric 2}, {numeric 3}, and {numeric 4}, are read out.

The <newline ><^END> is a program message terminator attached at the end of the parameter.

Related objects

Related objects provides information about other objects that are similar/related with the object.

Equivalent key

Equivalent key shows the operational procedure of the front panel keys that has the same effect as this object.