Keithley 2601 Reference Manual page 287

Series 2600 System SourceMeter® Instruments Reference Manual
display.inputvalue
Function Displays a formatted input field that the operator can edit.
There are four ways to use this function:
Usage
value = display.inputvalue(format)
value = display.inputvalue(format, default)
value = display.inputvalue(format, default, min)
value = display.inputvalue(format, default, min, max)
format
default
min
max
Remarks • This function will make use of text to create an editable input field on the user screen at
the present cursor position. The first write to the display after poweron will clear the user
screen.
• Examples of the input field:
+0.0000+00.0000E+000.00000E+0
• Value field:
+
0
for the value (as shown above in the third and fourth examples).
• .If used, include the decimal point (.) where needed for the value.
• Exponent field (optional):
E
+
0 Defines the digit positions for the exponent.
• Along with specifying the format for the input field, there are options to specify minimum
and maximum limits for the input field. When NOT using the "+" sign for the value field,
the minimum limit cannot be set to less than zero. When using the "+" sign, the minimum
limit can set to less than zero (e.g., -2).
• There is also an option to specify a
initially displayed value for the field will be the default value.
• Message prompts to instruct the operator should be displayed prior to calling this
function. Make sure to position the cursor where the edit field should appear.
• The input value is limited to ±1e37.
Remarks • After sending this command, script execution waits for the operator to enter a value and
(cont.) press ENTER:
• If limits are used, the operator will not be able to input values outside the minimum and
maximum limits.
• For positive and negative entry ("+" sign used for the value field and/or the exponent
field), polarity of a non-zero value or exponent can be toggled by positioning the cursor
on the polarity sign and turning the wheel. Polarity will also toggle when using the wheel
to decrease or increase the value or exponent past zero. A zero value or exponent (e.g.
+00) is always positive and cannot be toggled to negative polarity.
• After sending this command and pressing the EXIT key, value will return nil.
Details See "Parameter value
Also see display.prompt, display.setcursor,
Displays an editable field ("+0.50") for operator input – Valid input range is -0.10 to
Example
+2.00, with a default of 0.50:
display.clear()
value = display.inputvalue("+0.00", 0.5, -0.1, 2.0)
2600S-901-01 Rev. C / January 2008
Define format string for the input field using 0,
the decimal point (.), polarity sign (+) and 'E'
for exponent.
Set the default value for the parameter.
Set the minimum input value that can be set.
Set the maximum input value that can be set.
Include a "+" sign for positive/negative value entry. Not including
the "+" sign prevents negative value entry.
Defines the digit positions for the value. Up to six 0 can be used
Include the "E" for exponent entry.
Include a "+" sign for positive/negative exponent entry. Not including
the "+" sign prevents negative exponent entry.
default
prompting" in Section
display.settext
Return to Section Topics
value. When this command is executed, the
14.
Section 12: Instrument Control Library
12-27