Jackson Labs PHASE STATION 53100A, User Manual

Page: 151 / 225

PhaseStation 53100A User’s Manual V1.04 25-Apr-2022 151
EventAcqSetup([user])
This is an optional user-supplied function.
EventAcqSetup()
is called after a measurement
running on a PhaseStation 53100A has connected to the target instrument, but before it
enters the pretrigger state in preparation for data acquisition. The optional
user
parameter receives the optional user variable passed to
AcqStartAcquisition()
.
During the setup phase, a number of additional setup-related API functions are
available. The user setup handler typically uses these functions to communicate with
the 53100A to query operational parameters, validate correct operation, and identify
signal frequencies and amplitudes at the input jacks. The setup handler may also need
to communicate with other equipment in certain applications.
In order to proceed to the pretrigger phase, the setup handler must exit by calling
AcqSetupEnd()
. Most scripts other than diagnostic applications will not need to
implement a setup handler.
EventAcqTriggered([user])
This is an optional user-supplied function.
EventAcqTriggered()
is called when a
measurement initiated by
AcqStartAcquisition()
begins collecting data. Typically this
happens a few seconds after
AcqStartAcquisition()
is called by the user-provided
EventRunScript()
function, unless the deferred acquisition options on the Acquire menu
have been used to postpone data collection. The optional
user
parameter receives the
optional user variable passed to
AcqStartAcquisition()
.
Any errors that occur between
EventRunScript()
and
EventAcqTriggered()
automatically
terminate script execution.
See
EventRunScript()
for further information.
EventRunScript()
This is a mandatory user-supplied function that must appear in every TimeLab script. It
is called when the user issues
Scripts→Run script or a similar command, and serves as
the entry point for script execution.
Typically,
EventRunScript()
does little more than set up the appropriate acquisition
parameters and call
AcqStartAcquisition()
, returning immediately afterwards.
Subsequently, the script’s
EventAcqTriggered()
handler is called by TimeLab when the
acquisition begins collecting data after the optional
EventAcqSetup()
phase.
EventAcqTriggered(),
in turn, may use
TimeSetTimer()
to arrange for periodic callback service
to
EventTimer()
. Scripts that need to perform extensive measurement supervision and
control operations normally do so within their
EventTimer()
handlers, while final result
evaluation and report generation is done within
EventAcqDone()
.