This Programming Manual contains information on remote control over Planar
TR1300/1, TR5048 or TR7530 Vector Network Analyzer (Analyzer) and its data
communication by means of user programs written with COM/DCOM technology.
COM technology is used when a user program runs together with an external
measurement instrument program on one PC. DCOM technology is used when a
user program runs on a PC connected with the measurement instrument by LAN.
Methods and techniques for writing of user programs are the same for both
technologies. The only difference between the technologies is that the DCOM
technology requires additional LAN setting performed by the LAN administrator.
Before reading this Manual, familiarize yourself with Analyzer Operating Manual.
1 Registering COM Server
To register COM server of the analyzer run the executable module from command
prompt with the /regserver keyword. To unregister COM server of the analyzer run
the executable module from command prompt with the /unregserver keyword.
Administrative rights are required to register/unregister COM server. Also user has
ability to register COM server during the software installation procedure.
Example of the COM server registration command:
2 COM Technology Overview
COM stands for Component Object Model. This programming technology was
developed by Microsoft for two purposes:
the model provides the specification for interaction of binary modules created
in different programming languages;
the model defines the interfacing between a client application and a server
application running either on the same PC or on two different PCs. In the latter
case, the technology has DCOM abbreviation – Distributed COM.
12
3 Automation Server
The network analyzer executable module contains a built-in COM server that
enables other programs to access its functionality. The COM server was developed
in conformity with the COM automation specification. COM automation is a
technology allowing control over the COM server by the programs written in both
traditional compiling programming languages and interpreting programming
languages, such as VBScript. This enables the server applications to make their
functionality accessible to many more clients.
4 Automation Controllers
Automationcontrollers are client programs, which use internal functionality of COM
servers. Automation controller programs are developed by users for writing their
own additions for the system.
User programs can be written in different languages:
programming languages with built-in COM support, such as Visual Basic®,
Delphi, Java;
universal programming languages, such as C, C++;
Microsoft Excel and Word office applications as they include built-in
programming language Visual Basic for Applications®;
program generators, such as National Instruments LabView®, or HP–VEE.
Examples represented in this Manual are written in Visual Basic (VB). Appendix 2
contains examples written in VB, and C++ languages.
Examples\COM\VBA folder contains source codes for examples written in Visual
Basic for Applications® (Microsoft Excel files).
Examples\COM\CPP folder contains source codes for the C++ language examples.
13
5 Local and Remote Server
The network analyzer executable module can function either as a local server or as
a remote server of COM automation.
Localserver runs on the same PC with the automation controller and each of the
programs is executed as an individual application in a separate window. COM
technology is used in this case (Figure 1).
Remote server and the automation controller run on different PCs connected by
LAN. DCOM (Distributed COM) technology is used in this case (Figure 2). When
using DCOM it is necessary to configure the local network by means of DCOM
Windows tools.
The same automation controller is used for the both COM and DCOM technology.
Some changes to the user program may be required in operators, which establish
connection with the server. Moreover, DCOM technology requires additional
settings of the LAN performed by the LAN administrator.
Figure 1. COM technology
Figure 2. DCOM technology
14
6 Structure of COM Objects
Note
The hierarchy of COM objects is organized in accordance with the
standard and syntax of the SCPI programming language.
Operators in SCPI have hierarchical chain structure, for example:
CALCulate:PARameter:DEFine S11
The same COM command written in VB programming language is
as follows:
app.SCPI.CALCulate.PARameter.DEFine = "S11"
Application
CALCulate
DISPlay
INITiate
IEEE4882
SENSe
SYSTem
SOURce
MMEMory
SCPI
TRIGer
OUTPut
HCOPy
SERVice
COM server contains several objects, which provide different functionality of the
server. The COM objects of the network analyzer executable module are organized
in a hierarchical structure. Figure 3 shows the main COM objects, which comprise
the first three levels of the hierarchical structure of the COM server. COM objects
provide various methods and properties, which allow access to the server functions;
besides, they allow access to the objects of the lower levels, which are not shown
in Figure 3.
Figure 3. The structure of COM objects
The Object Application is in the top of the hierarchy COM server. Access to the
lower level objects is implemented via higher level objects.
Dim app
Dim app as Object
Dim app as TR1300.Application
Dim app as TRVNA.Application
ObjectName
Automation object name is always equal to
“TR1300.Application”, “TRVNA.Application”
HostName
Network name of the PC hosting the COM server. This parameter
is not specified in case of a local server.
Set app = CreateObject("TRVNA.Application")
Set app = CreateObject("TRVNA.Application", "Network_Name")
Set app = CreateObject("TRVNA.Application", "192.168.10.10")
Note
The first form of the operator is used to create the reference to the
local COM server, the second one is used to create the reference to
the remote DCOM server.
7 Accessing the Application Object
To establish connection with the COM server application, create an object
reference in the client program. In COM programming the object reference needs
to be acquired preliminarily, to be used later to access the object functionality. To
define an object in Visual Basic perform the following:
1) Declare a variable as an object;
2) Assign the object to this variable.
To declare a variable, use Dim operator or other declaration statement (Public,
Private or Static). The variables used for references should be of the types Variant,
Object, or a type of a specific object. For example, the following three operators
declare app variable:
Use Set operator and CreateObject (ObjectName, HostName) function to assign a
specific object to a variable.
For example, the following operators create Application object and assign it to app
variable:
Accessing the Application Object
16
Dim SystObj
Set SystObj = app.SCPI.SYSTem
Set SensObj1 = app.SCPI.SENSe(1)
Set SensObj2 = app.SCPI.SENSe(2)
Set SensObj = app.SCPI.SENSe(1)
Set SensObj = app.SCPI.SENSe
To allow access to the objects of a lower level of the hierarchy, these objects are
specified after the reference to the higher level object and separated from it by a
dot. For example:
COM objects can have indices. For example, CALCulate, INITiate, SENSe, SOURce
objects represent various aspects of the 4 measurement channels of the Analyzer.
Therefore, it is necessary to write the channel index from 1 to 4 to acquire the
data of these objects. For example:
Visual Basic allows omitting of such indices; in this case the indices are considered
as equal to 1. For example, the following VB operators are equivalent:
app.SCPI.SYSTem.PRESet
app.SCPI.SENSe.SWEp.POINts = 201
Note
Some object properties cannot be written, and some object
properties cannot be read. In such cases, the properties are
indicated as “read only” or “write only”.
8 Object Methods
Objects have methods. Methods are actions that can be applied to objects. The
object methods are specified after the object name and separated from it by a dot.
The following example shows the PRESet method of SYSTem object. This method
performs setting of the Analyzer to the preset condition:
9 Object Properties
Along with methods, objects have properties. Properties are object characteristics
that can be set or read out. The object properties are specified after the object
name and separated from it by a dot.
To modify an object characteristic, write the value of the corresponding property.
To define an object characteristic, read out the value of its property. The following
example show the setting of the POINts property of SWEep object, i.e. the number
of sweep points:
app.SCPI.PARameter.DEFine = "S13"
Dim app
Public Sub HandleError1()
Set app = CreateObject("TRVNA.Application")
On Error Resume Next
app.SCPI.PARameter.DEFine = "S13"
If Err.Number <> 0 Then
Msg = "Error # " & Str(Err.Number) & " was generated by " &_
Err.Source & Chr(13) & Err.Description
MsgBox Msg,,"Error"
End If
...
End Sub
10 Error Handling
You can use different approaches to error handling in VB program:
check the value of Err.Number variable after execution of VB operator, which
contains the call to COM server object;
use On Error GoTo VB operator.
These approaches are represented in the examples below. The following operator
causes an error in VB program as "S13" value of the DEFine property is incorrect.
In the first example, the value of the Err.Number variable is checked after
execution of the VB operator, which contains the call to COM server object. On Error Resume Next directive instructs VB not to interrupt the program execution
when the error is detected but to pass control to the next operator in natural
order.
Error Handling
19
Dim app
Public Sub HandleError2()
Set app = CreateObject("TRVNA.Application")
On Error GoTo ErrHandler
app.SCPI.PARameter.DEFine = "S13"
...
Exit Sub
ErrHandler:
Msg = "Error # " & Str(Err.Number) & " was generated by " &_
Err.Source & Chr(13) & Err.Description
MsgBox Msg,,"Error"
End Sub
In the second example, On Error GoTo ErrHandler directive instructs VB to interrupt
the program execution when the error is detected and to pass control to
ErrHandler label.
Long
32-bit signed integer, value range from –2147483648 to
2147483647
Double
64-bit double-precision floating point, value range from
–1.79769313486232E308 to –4.94065645841247E–324 for
negative values, and from 4.94065645841247E–324 to
1.79769313486232E308 for positive values
Boolean
16-bit integer, two values 0 – False, 1 – True
String
Variable-length string
Variant
Can be either a value of arbitrary type or an array of values of
arbitrary type. In this case, the term “arbitrary type” means any
allowed type of COM automation. A variable contains information
about its type and array size (if it is an array). It is used for
communication of data arrays between a client and a server.
11 COM Automation Data Types
In COM automation, there are the following data types, which can be used for
client-to-server communication:
Measurement
1
Measurement
2
Measurement
N
Real
Imag
Real
Imag
…
Real
Imag
Measurement
1
Measurement
2
Measurement
N
Value
0
Value 0 …
Value
0
12 Measurement Data Arrays
Measurement data can be either complex values or real values. This depends on
the format selected by the user. For example, the data is real in logarithmic
magnitude format and the data is complex in polar format.
The measurement data is transferred in a Variant type variable, which represents
an array of Double type. To transfer one complex measurement, two adjacent array
cells are used. To transfer one real measurement two adjacent array cells are used
as well but the second cell is always equal to 0. Thus, measurement data array
size is a double number of the measurement points.
Figure 4. Array of complex measurements
Figure 5. Array of real measurements
Object Type
Property (read only)
Data Type
String
Description
Instrument information string. String format: manufacturer, model,
serial number, number of firmware version and number of software
version.
Range
up to 40 characters
Syntax
Dim ID As String
ID = app.NAME
Equivalent
Softkeys
None
Object Type
Property (read only)
Data Type
Boolean
Description
Ready state of the instrument. Reads out the True value after successful
completion of the boot process (about 10 sec). The vector analyzer
must be connected to PC by a USB cable.
Syntax
Dim State as Boolean
State = app.Ready
Equivalent
Softkeys
None
13 COM Server Commands
NAME
Ready
COM Server Commands
23
Object Type
Method
Description
Aborts the sweep. Switches trigger mode from Single to Hold, or from
Continuous to waiting for a trigger. If the trigger source is set to Internal,
starts a new sweep.
Syntax
app.SCPI.ABORt
Equivalent
Softkeys
None
Object Type
Property (read/write)
Data Type
String
Target
Port Pt of channel Ch,
Ch
channel number 1–9 (see Table 1)
Pt
port number 1–2 (see Table 2)
Description
De-embedding function file name (*.s2p). The file contains the circuit S–
parameters in Touchstone format.
Range
up to 256 characters
Preset Value
""
Syntax
Dim File As String
File =
app.SCPI.CALCulate(Ch).FSIMulator.SENDed.DEEMbed.
PORT(Pt).USER.FILename
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).FSIMulator.SENDed.DEEMbed.PO
RT(Pt).STATe
app.SCPI.CALCulate(Ch).FSIMulator.SENDed.DEEMbed.PO
RT(Pt).STATe = True
Equivalent
Softkeys
Analysis > Fixture Simulator > De–Embedding > Port n
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).FSIMulator.SENDed.DEEMbed.
PORT(Pt).STATe
app.SCPI.CALCulate(Ch).FSIMulator.SENDed.DEEMbed.
PORT(Pt).STATe = True
The value of the impedance for port impedance conversion function.
Range
from 1e–6 to 1e6
Out of Range
Sets the value of the limit, which is closer to the specified value.
Preset Value
50
Unit
Ω (Ohm)
Syntax
Dim Value As Double
Value = app.SCPI.CALCulate(Ch).FSIMulator.SENDed.
ZCONversion.PORT(Pt).Z0.R
app.SCPI.CALCulate(Ch).FSIMulator.SENDed.
ZCONversion.PORT(Pt).Z0.R = 75
Equivalent
Softkeys
Analysis > Fixture Simulator > Port Z Conversion > Port n Z0
The ON/OFF state of the port impedance conversion function.
Allowable
Values
True
Port Z conversion function ON
False
Port Z conversion function OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status = app.SCPI.CALCulate(Ch).FSIMulator.SENDed.
ZCONversion.STATe
app.SCPI.CALCulate(Ch).FSIMulator.SENDed.
ZCONversion.STATe = True
Equivalent
Softkeys
Analysis > Fixture Simulator > Port Z Conversion > Port Z Conversion
Sets the value of the limit, which is closer to the specified value.
Preset Value
1
Syntax
Dim TraceNum As Long
TraceNum = app.SCPI.CALCulate(Ch).PARameter.COUNt
app.SCPI.CALCulate(Ch).PARameter.COUNt = 2
Equivalent
Softkeys
None
COM Server Commands
31
SCPI.CALCulate(Ch).PARameter(Tr).DEFine
Object Type
Property (read/write)
Data Type
String
Target
Trace Tr of channel Ch,
Ch
channel number 1–9 (see Table 1)
Tr
trace number 1–8 (see Table 3)
Description
The measurement parameter of the trace.
Allowable
Values
"S11"
S11 parameter
"S21"
S21 parameter
"A"
Abs A parameter
"B"
Abs B parameter
"R"
Abs R parameter
Out of Range
An error occurs.
Preset Value
Depends on the trace number.
Tr 1, Tr 3, Tr 5, Tr 7
"S11"
Tr 2, Tr 4, Tr 6, Tr 8
"S21"
Syntax
Dim Meas As String
Meas = app.SCPI.CALCulate(Ch).PARameter(Tr).DEFine
app.SCPI.CALCulate(Ch).PARameter(Tr).DEFine = "S11"
Equivalent
Softkeys
Response > Measurement > S11 | S21
COM Server Commands
32
Table 3. Tr: Trace Number
Data Type
Long
Description
Trace number
Range
from 1 to 8
Out of Range
An error occurs. Error code: 202.
Notes
If the trace number is not specified, it is taken as equal to 1.
Object Type
Method
Target
Trace Tr of channel Ch,
Ch
channel number 1–9 (see Table 1)
Tr
trace number 1–8 (see Table 3)
Description
Sets the active channel and trace.
Syntax
app.SCPI.CALCulate(Ch).PARameter(Tr).SELect
Notes
If the channel number is greater than the number of the channels
displayed, an error occurs and the command is ignored. If the trace
number is greater than the number of the traces displayed in the
channel, an error occurs and the command is ignored.
Equivalent
Softkeys
Channel > Active Channel
Trace > Active Trace
SCPI.CALCulate(Ch).PARameter(Tr).SELect
COM Server Commands
33
SCPI.CALCulate(Ch).PARameter(Tr).SPORt
Object Type
Property (read/write)
Data Type
Long
Target
Trace Tr of channel Ch,
Ch
channel number 1–9 (see Table 1)
Tr
trace number 1–8 (see Table 3)
Description
The number of the source port for absolute measurements.
Range
From 1 to 2
Out of range
An error occurs..
Preset Value
1
Syntax
Dim StimPort As Long
StimPort =
app.SCPI.CALCulate(Ch).PARameter(Tr).SPORt
app.SCPI.CALCulate(Ch).PARameter(Tr).SPORt = 1
Equivalent
Softkeys
Response > Measurement > Abs A | Abs B | Abs R
COM Server Commands
COM Server Commands
34
Object Type
Property (read/write)
Data Type
String
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The S–parameter conversion function type.
Range
"IMPedance"
Reflection or Transmission equivalent impedance
according to the trace measurement parameter (S11
or S21)
"ADMittance"
Reflection or Transmission equivalent admittance
according to the trace measurement parameter (S11
or S21)
"INVersion"
Inverse S–parameter
"CONJugation"
S–parameter conjugate
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
An error occurs.
Preset Value
"IMP"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.CONVersion.FUNCtion
app.SCPI.CALCulate(Ch).SELected.CONVersion.FUNCtion
= "INV"
Equivalent
Softkeys
Analysis > Conversion > Function > Impedance Z | AdmittanceY | Inverse
1/S | Conjugation
SCPI.CALCulate(Ch).SELected.CONVersion.FUNCtion
35
SCPI.CALCulate(Ch).SELected.CONVersion.STATe
Object Type
Property (read/write)
Data Type
Boolean
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the S-parameter conversion function.
Allowable
Values
True
S–parameter conversion function ON
False
S–parameter conversion function OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.CONVersion.STATe
app.SCPI.CALCulate(Ch).SELected.CONVersion.STATe =
True
Equivalent
Softkeys
Analysis > Conversion > Conversion
COM Server Commands
COM Server Commands
36
Object Type
Property (read/write)
Data Type
Double
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The value of the electrical delay.
Range
from –10 to 10
Out of Range
Sets the value of the limit, which is closer to the specified value.
Preset Value
0
Unit
s (second)
Syntax
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.CORRection.EDELay.
TIME
app.SCPI.CALCulate(Ch).SELected.CORRection.EDELay.
TIME = 1e–9
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The formatted data array. The array elements contain measurements in
the current format, for example, in logarithmic magnitude format (Log
Mag). Also, see section 12.
The array size is 2N, where N is the number of measurement points.
For the n–th point, where n from 1 to N:
Data(2n–2)
real number in rectangular format, real part in polar and
Smith chart formats;
Data(2n–1)
0 in rectangular format, imaginary part in polar and Smith
chart formats.
Syntax
Dim Data As Variant
Data = app.SCPI.CALCulate(Ch).SELected.DATA.FDATa
Equivalent
Softkeys
None
COM Server Commands
39
SCPI.CALCulate(Ch).SELected.DATA.FMEMory
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The formatted memory array. The array elements contain saved
measurements in the current format, for example, in logarithmic
magnitude format (Log Mag). Also, see section 12.
The array size is 2N, where N is the number of measurement points.
For the n–th point, where n from 1 to N:
Data(2n–2)
real number in rectangular format, real part in polar
and Smith chart formats;
Data(2n–1)
0 in rectangular format, imaginary part in polar and
Smith chart formats.
Syntax
Dim Data As Variant
Data = app.SCPI.CALCulate(Ch).SELected.DATA.FMEMory
Equivalent
Softkeys
None
COM Server Commands
40
SCPI.CALCulate(Ch).SELected.DATA.SDATa
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The corrected data array. The corrected measurements are complex
numbers. Also, see section 12.
The array size is 2N, where N is the number of measurement points.
For the n–th point, where n from 1 to N:
Data(2n–2)
the real part of corrected measurement;
Data(2n–1)
the imaginary part of corrected measurement.
Syntax
Dim Data As Variant
Data = app.SCPI.CALCulate(Ch).SELected.DATA.SDATa
Equivalent
Softkeys
None
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The corrected memory array. The corrected measurements are complex
numbers. Also, see section 12.
The array size is 2N, where N is the number of measurement points.
For the n–th point, where n from 1 to N:
Data(2n–2)
the real part of corrected measurement memory;
Data(2n–1)
the imaginary part of corrected measurement memory.
Syntax
Dim Data As Variant
Data = app.SCPI.CALCulate(Ch).SELected.DATA.SMEMory
Equivalent
Softkeys
None
COM Server Commands
SCPI.CALCulate(Ch).SELected.DATA.SMEMory
COM Server Commands
41
Object Type
Property (read/write)
Data Type
Double
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The gate center value of the gating function.
Range
Varies depending on the frequency span and the number of points.
Out of Range
Sets the value of the limit, which is closer to the specified value.
Preset Value
0
Unit
s (seconds), m (meters) or ft (feet)
Syntax
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
CENTer
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
CENTer = 1e–8
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The gate shape of the gating function.
Range
"MAXimum"
Maximum shape
"WIDE"
Wide shape
"NORMal"
Normal shape
"MINimum"
Minimum shape
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
An error occurs.
Preset Value
"NORM"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
SHAPe
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
SHAPe = "MAX"
Equivalent
Softkeys
Analysis > Gating > Shape > Maximum | Wide | Normal | Minimum
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the gating function.
Allowable
Values
True
Gating function ON
False
Gating function OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
STATe
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
STATe = Status
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The gate stop value of the gating function.
Range
Varies depending on the frequency span and the number of points.
Out of Range
Sets the value of the limit, which is closer to the specified value.
Preset Value
1e–8
Unit
s (seconds), m (meters) or ft (feet)
Syntax
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
STOP
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
STOP = 1e–7
Equivalent
Softkeys
Analysis > Gating > Stop
SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.STOP
COM Server Commands
47
Object Type
Property (read/write)
Data Type
String
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The gate type of the gating function.
Range
"BPASs"
Bandpass type
"NOTCh"
Notch type
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
An error occurs.
Preset Value
"BPAS"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
TYPE
app.SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.
TYPE = "NOTC"
Equivalent
Softkeys
Analysis > Gating > Type
SCPI.CALCulate(Ch).SELected.FILTer.GATE.TIME.TYPE
48
SCPI.CALCulate(Ch).SELected.FORMat
Object Type
Property (read/write)
Data Type
String
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
Data format.
Range
"MLOGarithmic"
Logarithmic magnitude
"PHASe"
Phase
"GDELay"
Group delay time
"SLINear"
Smith chart format (Lin)
"SLOGarithmic"
Smith chart format (Log)
"SCOMplex"
Smith chart format (Real/Imag)
"SMITh"
Smith chart format (R + jX)
"SADMittance"
Smith chart format (G + jB)
"PLINear"
Polar format (Lin)
"PLOGarithmic"
Polar format (Log)
"POLar"
Polar format (Real/Imag)
"MLINear"
Linear magnitude
"SWR"
Voltage standing wave ratio
"REAL"
Real part
"IMAGinary"
Imaginary part
"UPHase"
Expanded phase
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
An error occurs.
Preset Value
"MLOG"
Syntax
Dim Param As String
Param = app.SCPI.CALCulate(Ch).SELected.FORMat
app.SCPI.CALCulate(Ch).SELected.FORMat = "PHAS"
Equivalent
Softkeys
Response > Format > Log Mag | SWR | Phase | Expand Phase | Group
Delay | Lin Mag | Real | Imag
Response > Format > Smith > Log / Phase | Lin / Phase | Real / Imag |
R+jX | G+jB
Response > Format > Polar > Log / Phase | Ling / Phase | Real / Imag
COM Server Commands
49
SCPI.CALCulate(Ch).SELected.FUNCtion.DATA
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The data array of analysis executed by the
SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute method.
The array size is 2N, where N is the number of points defined by the
SCPI.CALCulate(Ch).SELected.FUNCtion.POINts property.
For the n–th point, where n from 1 to N:
Data(2n–2)
the response value in the n–th measurement point;
Data(2n–1)
the stimulus value in the n–th measurement point.
Always set to 0 for the analysis of mean value, standard
deviation, and peak–to–peak value.
Syntax
Dim Data As Variant
Data =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.DATA
Equivalent
Softkeys
None
COM Server Commands
COM Server Commands
50
Object Type
Property (read/write)
Data Type
Boolean
Target
All traces of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF coupling state of the analysis range for the
SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute method.
Allowable
Values
True
Coupling state ON
False
Coupling state OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.DOMain.
COUPle
app.SCPI.CALCulate(Ch).SELected.FUNCtion.DOMain.
COUPle = Status
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.DOMain.
STOP
app.SCPI.CALCulate(Ch).SELected.FUNCtion.DOMain.
STOP = 2e9
Equivalent
Softkeys
None
SCPI.CALCulate(Ch).SELected.FUNCtion.DOMain.STOP
54
SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute
Object Type
Method
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
Executes the analysis specified with the
SCPI.CALCulate(Ch).SELected.FUNCtion.TYPE property.
The analysis result can then be read out with the
SCPI.CALCulate(Ch).SELected.FUNCtion.DATA property.
Syntax
app.SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute
Equivalent
Softkeys
None
COM Server Commands
COM Server Commands
55
Object Type
Property (read/write)
Data Type
Double
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The lower limit for the peak excursion value when executing the peak
search by the SCPI.CALCulate(Ch).SELected.FUNCtion. EXECute method.
Range
Varies depending on the trace format.
Out of Range
No limitation
Preset Value
3
Unit
dB (decibel) | ° (degree) | s (second)
Syntax
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.PEXCursion
app.SCPI.CALCulate(Ch).SELected.FUNCtion.PEXCursion
= 1.5
Equivalent
Softkeys
None
SCPI.CALCulate(Ch).SELected.FUNCtion.PEXCursion
56
SCPI.CALCulate(Ch).SELected.FUNCtion.POINts
Object Type
Property (read only)
Data Type
Long
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The number of points (data pairs) of the analysis result by the
SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute method.
Always equal to 1, when the search is executed for the maximum,
minimum, mean, standard deviation, peak, and peak–to–peak values.
The actual number of points is read out, when the search is executed
for all peaks or all targets.
Syntax
Dim Value As Long
Value =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.POINts
Equivalent
Softkeys
None
COM Server Commands
57
SCPI.CALCulate(Ch).SELected.FUNCtion.PPOLarity
Object Type
Property (read/write)
Data Type
String
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The polarity selection when performing the peak search by the
SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute method.
Range
"POSitive"
Positive peaks
"NEGative"
Negative peaks
"BOTH"
Both positive peaks and negative peaks
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"POS"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.PPOLarity
app.SCPI.CALCulate(Ch).SELected.FUNCtion.PPOLarity
= "NEG"
Equivalent
Softkeys
None
COM Server Commands
58
SCPI.CALCulate(Ch).SELected.FUNCtion.TARGet
Object Type
Property (read/write)
Data Type
Double
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The target level when performing the search for the trace and the
target level crosspoints by the SCPI.CALCulate(Ch).SELected. FUNCtion.EXECute method.
Range
Varies depending on the trace format.
Out of Range
No limitation
Preset Value
0
Unit
dB (decibel) | ° (degree) | s (second)
Syntax
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.TARGet
app.SCPI.CALCulate(Ch).SELected.FUNCtion.TARGet = –
10
Equivalent
Softkeys
None
COM Server Commands
COM Server Commands
59
Object Type
Property (read/write)
Data Type
String
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The transition type selection when performing the search for the trace
and the target level crosspoints by the
SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute method.
Range
"POSitive"
Positive peaks
"NEGative"
Negative peaks
"BOTH"
Both positive peaks and negative peaks
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"POS"
Syntax
Dim Param As String
Param = app.SCPI.CALCulate(Ch).SELected.FUNCtion.
TTRansition
app.SCPI.CALCulate(Ch).SELected.FUNCtion.
TTRansition = "BOTH"
Equivalent
Softkeys
None
SCPI.CALCulate(Ch).SELected.FUNCtion.TTRansition
60
SCPI.CALCulate(Ch).SELected.FUNCtion.TYPE
Object Type
Property (read/write)
Data Type
String
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The selection of the type of analysis executed by the
SCPI.CALCulate(Ch).SELected.FUNCtion.EXECute method.
Range
"PTPeak"
Peak–to–peak (difference between the maximum value
and the minimum value)
"STDEV"
Standard deviation
"MEAN"
Mean value
"MAXimum"
Maximum value
"MINimum"
Minimum value
"PEAK"
Search for the peak
"APEak"
Search for all the peaks
"ATARget"
Search for all targets
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"PTP"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.FUNCtion.TYPE
app.SCPI.CALCulate(Ch).SELected.FUNCtion.TYPE =
"STDEV"
Equivalent
Softkeys
None
COM Server Commands
61
SCPI.CALCulate(Ch).SELected.LIMit.DATA
Object Type
Property (read/write)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The data array, which is the limit line in the limit test function. The
array size is 1 + 5N, where N is the number of measuring points.
For the n–th point, where n from 1 to N:
Data(0)
The number of limit line segments N is from 0 to 100.
Setting 0 clears the limit line;
Data(5n–4)
type of the n–th limit line segment;
0: OFF
1: Upper limit
2: Lower limit
Data(5n–3)
the stimulus value in the start point of the n–th
segment;
Data(5n–2)
the stimulus value in the end point of the n–th segment;
Data(5n–1)
the response value in the start point of the n–th
segment;
Data(5n–0)
the response value in the end point of the n–th segment.
Notes
If the array size is not 1 + 5N, where N is Data(0), an error occurs. If
Data(5n – 4) is less than 0 or more than 2, an error occurs. When
Data(5n–3), Data(5n–2), Data(5n–1) and Data(5n–0) elements are out
of allowable range, the value is set to the limit, which is closer to the
specified value.
Syntax
Dim Data As Variant
Data = app.SCPI.CALCulate(Ch).SELected.LIMit.DATA
app.SCPI.CALCulate(Ch).SELected.LIMit.DATA =
Array(1,2,800,900,–10,–10)
Equivalent
Softkeys
Analysis > Limit Test > Edit Limit Line
COM Server Commands
62
SCPI.CALCulate(Ch).SELected.LIMit.DISPlay.STATe
Object Type
Property (read/write)
Data Type
Boolean
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the limit line display of the limit test function.
Allowable
Values
True
Limit line display ON
False
Limit line display OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.LIMit.DISPlay.STATe
app.SCPI.CALCulate(Ch).SELected.LIMit.DISPlay.STATe
= True
Equivalent
Softkeys
Analysis > Limit Test > Limit Line
Object Type
Property (read only)
Data Type
Boolean
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The limit test result.
Allowable
Values
True
Fail
False
Pass
Syntax
Dim Status As Boolean
Status = app.SCPI.CALCulate(Ch).SELected.LIMit.FAIL
Equivalent
Softkeys
None
COM Server Commands
SCPI.CALCulate(Ch).SELected.LIMit.FAIL
COM Server Commands
63
Object Type
Property (read/write)
Data Type
Double
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The value of the limit line offset along Y–axis.
Range
Varies depending on the trace format.
Out of Range
No limitation
Preset Value
0
Unit
dB (decibel) | ° (degree) | s (second)
Syntax
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.LIMit.OFFSet.
AMPLitude
app.SCPI.CALCulate(Ch).SELected.LIMit.OFFSet.
AMPLitude = –10
Equivalent
Softkeys
Analysis > Limit Test > Limit Line Offsets > Response Offset
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The data array, which is the limit test results. The array size is 4N,
where N is the number of measurement points.
For the n–th point, where n from 1 to N:
Data(4n–3)
the stimulus value in the n–th point
Data(4n–2)
the limit test result in the n–th point
–1: No limit
0: Fail
1: Pass
Data(4n–1)
the upper limit value in the n–th point (0 – if there is
no limit)
Data(4n–0)
the lower limit value in the n–th point (0 – if there is
no limit)
Syntax
Dim Data As Variant
Data =
app.SCPI.CALCulate(Ch).SELected.LIMit.REPort.ALL
Equivalent
Softkeys
None
COM Server Commands
66
SCPI.CALCulate(Ch).SELected.LIMit.REPort.DATA
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The data array, which is the stimulus values at all the measurement
points that failed the limit test. The array size is defined by the
Dim Cnt As Long
Cnt =
app.SCPI.CALCulate(Ch).SELected.LIMit.REPort.POINts
Equivalent
Softkeys
None
COM Server Commands
68
SCPI.CALCulate(Ch).SELected.LIMit.STATe
Object Type
Property (read/write)
Data Type
Boolean
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the limit test function.
Allowable
Values
True
Limit test function ON
False
Limit test function OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.LIMit.STATe
app.SCPI.CALCulate(Ch).SELected.LIMit.STATe = True
Equivalent
Softkeys
Analysis > Limit Test > Limit Test
COM Server Commands
COM Server Commands
69
Object Type
Method
Target
Marker Mk of the active trace of channel Ch,
Ch
channel number 1–9 (see Table 1)
Mk
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
Sets the active marker. If a marker is OFF this function will turn it ON.
Turning ON a marker with the number from 1 to 15 will turn ON all the
markers of smaller numbers. Turning ON the reference marker with
number 16 does not turn ON the markers with the numbers from 1 to
15, but switches these markers to the relative measurement mode.
Markers > Active Marker > Marker n
Markers > Reference Marker
Data Type
Long
Description
Marker number. Numbers from 1 to 15 are for regular markers, number
16 is for the reference marker.
Range
from 1 to 16
Out of Range
An error occurs..
Notes
If the marker number is not specified, it is taken as equal to 1.
SCPI.CALCulate(Ch).SELected.MARKer(Mk).ACTivate
Table 4. Mk: Marker Number
COM Server Commands
70
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
Marker Mk of the active trace of channel Ch,
Ch
channel number 1–9 (see Table 1)
Mk
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The bandwidth search result. The bandwidth search can be performed
relatively to the marker Mk, or relatively to the absolute maximum
value of the trace (in this case the marker number is ignored), what is
set by the SCPI.CALCulate(Ch).SELected.MARKer.BWIDth. REFerence property.
The array contains 4 elements:
Data(0)
Bandwidth;
Data(1)
Center frequency;
Data(2)
Q value;
Data(3)
Loss.
Notes
If the bandwidth search is impossible, all the read out values are 0. If
the search is performed relatively to a maker, which is OFF, an error
occurs.
Syntax
Dim Data As Variant
Data =
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).BWIDth.
DATA
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The selection of the reference point for the bandwidth search function:
reference marker or absolute maximum value of the trace.
Range
"MARKer"
Bandwidth search relative to the reference marker
"MAXimum"
Bandwidth search relative to the absolute maximum of
the trace
"MINimum"
Bandwidth search relative to the absolute minimum of
the trace
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"MAX"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.MARKer.BWIDth.
REFerence
app.SCPI.CALCulate(Ch).SELected.MARKer.BWIDth.
REFerence = "MARK"
Equivalent
Softkeys
Markers > Marker Math > Bandwidth Search > Search Ref To
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The type of the bandwidth search function.
Range
"BPASs"
Bandpass
"NOTCh"
Notch
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"BPAS"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.MARKer.BWIDth.TYPE
app.SCPI.CALCulate(Ch).SELected.MARKer.BWIDth.TYPE
= "NOTC"
Equivalent
Softkeys
Markers > Marker Math > Bandwidth Search > Type
SCPI.CALCulate(Ch).SELected.MARKer.BWIDth.TYPE
75
SCPI.CALCulate(Ch).SELected.MARKer.COUPle
Object Type
Property (read/write)
Data Type
Boolean
Target
All traces of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the marker coupling function.
Allowable
Values
True
Marker coupling ON
False
Marker coupling OFF
Preset Value
True
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.MARKer.COUPle
app.SCPI.CALCulate(Ch).SELected.MARKer.COUPle =
false
Equivalent
Softkeys
Markers > Properties > Marker Couple
COM Server Commands
COM Server Commands
76
Object Type
Property (read/write)
Data Type
Double
Target
All traces of channel Ch (if the marker search range coupling is set to
OFF by the SCPI.CALCulate(Ch).SELected.FUNCtion. DOMain.COUPle property), the active trace of channel Ch (if
otherwise),
Ch channel number 1–9 (see Table 1)
Description
The start value of the marker search range.
Range
From the stimulus current start value to the stimulus current stop
value.
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.MARKer(1).FUNCtion.
DOMain.STARt
app.SCPI.CALCulate(Ch).SELected.MARKer(1).FUNCtion.
DOMain.STARt = 1e6
All traces of channel Ch (if the marker search range coupling is set to
OFF by the SCPI.CALCulate(Ch).SELected.MARKer. FUNCtion.DOMain.COUPle property), the active trace of channel Ch
(if otherwise),
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the arbitrary range when executing the marker
search.
Allowable
Values
True
Marker search range ON
False
Marker search range OFF (entire sweep range)
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.MARKer(1).FUNCtion.
DOMain.STATe
app.SCPI.CALCulate(Ch).SELected.MARKer(1).FUNCtion.
DOMain.STATe = True
Equivalent
Softkeys
Markers > Marker Search > Search Range
SCPI.CALCulate(Ch).SELected.MARKer(Mk).FUNCtion.DOMain.
STATe
COM Server Commands
78
Object Type
Property (read/write)
Data Type
Double
Target
All traces of channel Ch (if the marker search range coupling is set to
OFF by the SCPI.CALCulate(Ch).SELected.MARKer. FUNCtion.DOMain.COUPle property), the active trace of channel Ch
(if otherwise),
Ch channel number 1–9 (see Table 1)
Description
The stop value of the marker search range.
Range
From the stimulus current start value to the stimulus current stop
value.
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.MARKer(1).FUNCtion.
DOMain.STOP
app.SCPI.CALCulate(Ch).SELected.MARKer(1).FUNCtion.
DOMain.STOP = 1e6
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
Executes the marker search according to the specified criterion. The
type of the marker search is set by the SCPI.CALCulate(Ch). SELected.MARKer(Mk).FUNCtion.TYPE property.
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The peak excursion value, when the marker search for peak is
performed by the SCPI.CALCulate(Ch).SELected. MARKer(Mk).FUNCtion.EXECute method.
Range
Varies depending on the trace format.
Out of Range
No limitation
Preset Value
1
Unit
dB (decibel) | ° (degree) | s (second)
Syntax
Dim Value As Double
Value = app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.PEXCursion
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.PEXCursion = 3.0
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The peak polarity selection, when the marker search for peak is
performed by the SCPI.CALCulate(Ch).SELected. MARKer(Mk).FUNCtion.EXECute method.
Range
"POSitive"
Positive polarity
"NEGative"
Negative polarity
"BOTH"
Both positive polarity and negative polarity
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"POS"
Syntax
Dim Param As String
Param = app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.PPOLarity
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.PPOLarity = "neg"
Dim Value As Double
Value = app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.TARGet
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.TARGet = –10
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The ON/OFF state of the marker search tracking function.
Allowable
Values
True
Marker search tracking ON
False
Marker search tracking OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.TRACking
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.TRACking = True
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The selection of the type of the target transition, when the marker
search for transition is performed by the SCPI.CALCulate(Ch). SELected.MARKer(Mk).FUNCtion.EXECute method.
Range
"POSitive"
Positive target transition
"NEGative"
Negative target transition
"BOTH"
Both positive target transition and negative target
transition
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"POS"
Syntax
Dim Param As String
Param = app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.TTRansition
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).
FUNCtion.TTRansition = "NEG"
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The selection of the type of the marker search, which is performed by
the SCPI.CALCulate(Ch).SELected.MARKer(Mk). FUNCtion.EXECute method.
Range
"MAXimum"
Maximum value search
"MINimum"
Minimum value search
"PEAK"
Peak search
"LPEak"
Peak search to the left from the marker
"RPEak"
Peak search to the right from the marker
"TARGet"
Target search
"LTARget"
Target search to the left from the marker
"RTARget"
Target search to the right from the marker
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
The value is ignored.
Preset Value
"MAX"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).FUNCtion
.TYPE
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).FUNCtion
.TYPE = "MIN"
Equivalent
Softkeys
Markers > Marker Search > Maximum | Minimum
Markers > Marker Search > Peak > Search Peak | Search Max Peak |
Search Peak Left | Search Peak Right
Markers > Marker Search > Target > Search Target | Search Target Left |
Search Target Right
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The setting of the value of the specified item to the value of the
position of the marker.
Range
"STARt"
Sweep start value set to the stimulus value of the marker
position.
"STOP"
Sweep stop value set to the stimulus value of the marker
position.
"CENTer"
Sweep center value set to the stimulus value of the marker
position.
"RLEVel"
Reference value set to the response value of the marker
position.
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The ON/OFF state of a marker. Turning ON a marker with the number
from 1 to 15 will turn ON all the markers of smaller numbers. Turning
OFF a marker with the number from 1 to 15 will turn OFF all the
markers of greater numbers (except for the reference marker). Turning
ON/OFF the reference marker with number 16 does not turn ON/OFF
the markers with the numbers from 1 to 15, but switches these markers
to the relative measurement mode.
Allowable
Values
True
Marker ON
False
Marker OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).STATe
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).STATe =
True
Dim Value As Double
Value =
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).X
app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).X = 1e9
Equivalent
Softkeys
Markers > Edit Stimulus
COM Server Commands
90
SCPI.CALCulate(Ch).SELected.MARKer(Mk).Y
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
Marker Mk of the active trace of channel Ch,
Ch
channel number 1–9 (see Table 1)
Mk
marker number 1–15, or reference marker number 16 (see
Table 4)
Description
The response value of the marker. If the reference marker is turned ON,
the values of the markers from 1 to 15 are read out as relative values to
the reference marker.
The array includes 2 elements:
Data(0)
real number in rectangular format, real part in polar and
Smith chart formats;
Data(1)
0 in rectangular format, imaginary part in polar and Smith
chart formats.
Syntax
Dim Data As Variant
Data = app.SCPI.CALCulate(Ch).SELected.MARKer(Mk).Y
Equivalent
Softkeys
None
COM Server Commands
91
SCPI.CALCulate(Ch).SELected.MARKer.COUNt
Object Type
Property (read/write)
Data Type
Long
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The number of the turned ON markers excluding the reference marker.
Range
from 0 to 15
Out of Range
Sets the value of the limit, which is closer to the specified value.
Preset Value
0
Syntax
Dim MarkerCnt As Long
MarkerCnt =
app.SCPI.CALCulate(Ch).SELected.MARKer.COUNt
app.SCPI.CALCulate(Ch).SELected.MARKer.COUNt = 5
Equivalent
Softkeys
None
Object Type
Method
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
Removes the data (All memory traces) from the memory trace.
Syntax
app.SCPI.CALCulate(Ch).SELected.MATH.DELete
Equivalent
Softkeys
Trace > Delete All Memory
COM Server Commands
SCPI.CALCulate(Ch).SELected.MATH.DELete
92
SCPI.CALCulate(Ch).SELected.MATH.FUNCtion
Object Type
Property (read/write)
Data Type
String
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The selection of the math operation between the measurement data
and the memory trace data. The math result replaces the data trace. If
the data trace is not saved, the command is ignored.
Range
"DIVide"
Division Data / Mem.
"MULTiply"
Multiplication Data x Mem.
"ADD"
Addition Data + Mem.
"SUBTract"
Subtraction Data – Mem.
"NORMal"
No math
Notes
The short format of the parameter is indicated by upper case letters.
There is no distinction between upper and lower case letters when the
property is written. When the property is read out, the short format is
indicated by upper case letters.
Out of Range
An error occurs.
Preset Value
"NORM"
Syntax
Dim Param As String
Param =
app.SCPI.CALCulate(Ch).SELected.MATH.FUNCtion
app.SCPI.CALCulate(Ch).SELected.MATH.FUNCtion=
"DIV"
Equivalent
Softkeys
Trace > Data Math > Data/Mem | Data*Mem | Data+Mem | Data–Mem |
OFF
COM Server Commands
93
SCPI.CALCulate(Ch).SELected.MATH.MEMorize
Object Type
Method
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
Saves the measurement data to the memory trace. Automatically turns
on the display of the memory trace.
Syntax
app.SCPI.CALCulate(Ch).SELected.MATH.MEMorize
Equivalent
Softkeys
Trace > Memorize Data Trace
Object Type
Property (read/write)
Data Type
Boolean
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the Maximum Hold function.
Allowable
Values
True
Maximum Hold ON
False
Maximum Hold OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.MAXhold.STATe
app.SCPI.CALCulate(Ch).SELected.MAXhold.STATe =
True
Equivalent
Softkeys
Trace > Max Hold
COM Server Commands
SCPI.CALCulate(Ch).SELected.MAXhold.STATe
94
SCPI.CALCulate(Ch).SELected.MSTatistics.DATA
Object Type
Property (read only)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The math statistics data array. The statistics function is applied either
over the whole range (for all the trace), or within the range specified by
the SCPI.CALCulate(Ch).SELected.MSTatistics.DOMain. STATe property (the range limits are determined by two markers).
The array includes 3 elements:
Data(0)
Mean value;
Data(1)
Standard deviation;
Data(2)
Peak–to–peak (difference between the maximum value and
the minimum value).
Syntax
Dim Data As Variant
Data =
app.SCPI.CALCulate(Ch).SELected.MSTatistics.DATA
Equivalent
Softkeys
None
COM Server Commands
COM Server Commands
95
Object Type
Property (read/write)
Data Type
Long
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The number of the marker, which specifies the start frequency of the
math statistics range.
Range
from 1 to 16
Out of Range
Sets the value of the limit, which is closer to the specified value.
Preset Value
1
Syntax
Dim MkrNum As Long
MkrNum =
app.SCPI.CALCulate(Ch).SELected.MSTatistics.DOMain.
MARKer.STARt
app.SCPI.CALCulate(Ch).SELected.
MSTatistics.DOMain.MARKer.STARt = 3
Equivalent
Softkeys
Markers > Marker Math > Statistics > Statistics Start
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The number of the marker, which specifies the stop frequency of the
math statistics range.
Range
from 1 to 16
Out of Range
Sets the value of the limit, which is closer to the specified value.
Preset Value
2
Syntax
Dim Mkr As Long
Mkr =
app.SCPI.CALCulate(Ch).SELected.MSTatistics.DOMain.
MARKer.STOP
app.SCPI.CALCulate(Ch).SELected.MSTatistics.DOMain.
MARKer.STOP = 4
Equivalent
Softkeys
Markers > Marker Math > Statistics > Statistics Stop
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the math statistics range.
Allowable
Values
True
Statistics range ON
False
Statistics range OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.MSTatistics.DOMain.
STATe
app.SCPI.CALCulate(Ch).SELected.MSTatistics.DOMain.
STATe = True
Equivalent
Softkeys
Markers > Marker Math > Statistics > Statistics Range
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the math statistics display.
Allowable
Values
True
Statistics display ON
False
Statistics display OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.MSTatistics.STATe
app.SCPI.CALCulate(Ch).SELected.MSTatistics.STATe =
True
Equivalent
Softkeys
Markers > Marker Math > Statistics > Statistics
COM Server Commands
99
SCPI.CALCulate(Ch).SELected.RLIMit.DATA
Object Type
Property (read/write)
Data Type
Variant (Double array)
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The data array, which is the limit line for the ripple limit function. The
array size is 1 + 4N, where N is the number of limit line segments.
For the n–th point, where n from 1 to N:
Data(0)
the number of limit line segments N is the integer from
0 to 12. Setting 0 clears the limit line;
Data(4n–3)
type of the n–th limit line segment;
0: Off
1: On
Data(4n–2)
the stimulus value in the beginning point of the n–th
segment;
Data(4n–2)
the stimulus value in the end point of the n–th
segment;
Data(4n–0)
the ripple limit value of the n–th segment.
Notes
If the array size is not 1 + 4N, where N is Data(0), an error occurs. If
Data(4n – 3) is less than 0 or more than 1, an error occurs. When
Data(4n–2), Data(4n–1), and Data(4n–0) elements are out of allowable
range, the value is set to the limit, which is closer to the specified
value.
Syntax
Dim Data As Variant
Data = app.SCPI.CALCulate(Ch).SELected.RLIMit.DATA
app.SCPI.CALCulate(Ch).SELected.RLIMit.DATA =
Array(1,1,800,900,10)
Equivalent
Softkeys
Analysis > Ripple Limit > Edit Ripple Limit
COM Server Commands
100
SCPI.CALCulate(Ch).SELected.RLIMit.DISPlay.LINE
Object Type
Property (read/write)
Data Type
Boolean
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
The ON/OFF state of the ripple limit line display.
Allowable
Values
True
Ripple limit line ON
False
Ripple limit line OFF
Preset Value
False
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.RLIMit.DISPlay.LINE
app.SCPI.CALCulate(Ch).SELected.RLIMit.DISPlay.LINE
= True
Equivalent
Softkeys
Analysis > Ripple Limit > Limit Line
Object Type
Property (read only)
Data Type
Boolean
Target
The active trace of channel Ch,
Ch channel number 1–9 (see Table 1)
Description
Ripple limit test result.
Allowable
Values
True
Fail
False
Pass
Syntax
Dim Status As Boolean
Status =
app.SCPI.CALCulate(Ch).SELected.RLIMit.FAIL
Equivalent
Softkeys
None
COM Server Commands
SCPI.CALCulate(Ch).SELected.RLIMit.FAIL
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.