Jackson Labs PHASE STATION 53100A, User Manual

Page: 148 / 225

PhaseStation 53100A User’s Manual V1.04 25-Apr-2022 148
AcqSetParam(String key, String value)
Each script instance maintains a dictionary of acquisition parameters that can be used to
override any or all of the acquisition dialog parameters when
AcqStartAcquisition()
is called.
AcqSetParam()
updates the stored value for the specified acquisition parameter.
The best way to obtain a list of measurement parameter names and values for a given
instrument is to use the
Save Measurement Script button in the Utility tab of the
acquisition dialog to create a script that will contain explicit
AcqSetParam()
statements for
each supported parameter. Almost all parameters will have obvious counterparts in the
instrument’s acquisition dialog; you can also refer to the
Legend menu section on page
110 for individual descriptions.
See
AcqStrParam()
,
AcqNumParam()
and
AcqClearParams()
for more information.
AcqStartAcquisition(String menu_entry, Boolean skip_dialog [, Number user_value])
Starts a new measurement based on the script instance’s current set of acquisition
parameters.
The
menu_entry
parameter should correspond
exactly
to the name of the instrument as it
appears on the Acquire menu, including any ellipsis (...) that follows it. Currently the
only officially-supported instrument names for scripted measurements are the
Miles
Design TimePod ...
and
Jackson Labs PhaseStation …
entries, so one of these strings
must be supplied as the
menu_entry
value.
With a script-initiated measurement, the initial acquisition parameters are the same as
the default values in a fresh TimeLab installation. These default parameters are then
overwritten with any entries that appear in the script instance’s acquisition-parameter
dictionary, as described in
AcqNumParam
(),
AcqStrParam
(), and
AcqSetParam
(). Unlike a
manual measurement, script-based measurements do not write their parameters back
to the driver’s .INI file. As a result, the dialog defaults that will appear in the next user-
initiated acquisition will not reflect the parameters used for the last scripted acquisition.
Next, if
skip_dialog
is false, TimeLab will present the acquisition dialog to the user,
allowing any parameters to be changed before the measurement begins. In most cases,
skip_dialog
should be set to true to allow the script to run without further user
intervention. This will be the case for measurement scripts created with the Save script
button in the acquisition dialog.
The
AcqStartAcquisition()
function will return true if the acquisition is initiated successfully,
or false if an error occurred. Reasons for failure might include the lack of an available
slot in the legend table for the plot(s) created by the acquisition, the use of an
unrecognized
menu_entry
name, the specification of an invalid acquisition parameter