Jackson Labs PHASE STATION 53100A, User Manual, Page: 162 / 225

PhaseStation 53100A User’s Manual V1.04 25-Apr-2022 162
ScriptSetTTYHeader(Number linenum [, String text])
Sets and/or retrieves the text displayed at the top of the script TTY window that is
associated with the plot(s) bound to the script instance.
The
linenum
argument specifies which of the first two TTY lines will be retrieved or
updated; it must equal 0 or 1. The
text
argument is optional. If present, it will replace
the existing text for the specified TTY line. Regardless, the function will return the
contents of the specified line at the time it was called.
Note that the script TTY is associated with the most recent plot that has been acquired
by the script or otherwise bound to it. (All channels in a multichannel acquisition share
the same TTY.) The
Print
function will write its output to the TimeLab status line if no
TTY is associated with the script, but
ScriptTTYHeader()
will fail with an exception. In most
cases, you should not attempt to write to the TTY before
AcqStartAcquisition()
has been
called.
ScriptShowTTY([Boolean show])
Shows or hides the script TTY window that is associated with the plot(s) bound to the
script instance, returning the previous visibility state. If the
show
argument is omitted,
the function will return the current visibility state without changing it.
The script TTY window becomes visible by default upon successful execution of
AcqStartAcquisition()
. However, because the TTY can obscure a large portion of the
TimeLab graph display area, simple scripts that report little or no status information may
wish to hide the TTY window. The user will still have the option to select
Scripts→ Toggle script console for selected plot ( F11 ) to show the TTY manually.
Unlike the other TTY functions,
ScriptShowTTY()
may be called at any time. The visibility
state that it establishes will be inherited by any subsequent plots that the script
acquires.
ScriptStrParam(Number n )
Returns a String corresponding to the contents of the
n
th (zero-based) command line
parameter following the JavaScript (.js) program name on the TimeLab command line.
An exception will be thrown if the requested parameter is not present.
See 53100A_command_line_example.js for a detailed usage example.
ScriptUnbind()
Removes the association between the script instance and any plot to which it is bound.
SetupDetectedAmpldBfs
SetupDetectedValid