Series 3700A System Switch/Multimeter Reference Manual
Section 11: TSP command reference
3700AS-901-01 Rev. D/June 2018
11-317
scan.execute()
This function starts the scan immediately in the foreground with a configured scan list.
Type
TSP-Link accessible
Affected by
Where saved
Default value
Function
Yes
Usage
state
,
scanCount
,
stepCount
,
reading
= scan.execute()
state
,
scanCount
,
stepCount
,
reading
=
scan.execute(
bufferVar
)
state
The result of scanning:
scan.EMPTY
or
0
scan.BUILDING
or
1
scan.RUNNING
or
2
scan.ABORTED
or
3
scan.FAILED
or
4
scan.FAILED_INIT
or
5
scan.SUCCESS
or
6
scanCount
The present number of scans completed
stepCount
The present number of steps completed
reading
If measurements are taken during the scan, this parameter contains the last scan
reading completed
bufferVar
A reading buffer used during scanning to store the readings; if a buffer is not
specified, no readings are stored during the scan
Details
In addition to starting and running the scan in immediate mode (not in the background), you can use
this function to specify the scanning reading buffer. This reading buffer stores the readings and
accompanying attributes as specified for the scan. An error is generated if the reading buffer does not
exist or if the parameter is not a reading buffer.
Before using this command, use
scan.create()
and
scan.add()
or
scan.addimagestep()
to
set up a scan list.
Execution runs until the scan is complete or until the
abort
command is sent.
Because this function waits for the scan to complete, the
scan.state()
function cannot be used to
see the current status of scanning.
Example
scan.execute(rbBuff1)
Runs a scan immediately and stores the
readings in a reading buffer named
rbbuff1
.
Also see
(on page 11-309)
(on page 11-313)
(on page 11-315)
(on page 11-318)
(on page 11-326)
(on page 5-23)