Section 7: Command reference
Model 2651A High Power System SourceMeter® Instrument Reference Manual
7-60
2651A-901-01 Rev. A / March 2011
Usage
display.inputvalue(
format
)
display.inputvalue(
format
,
default
)
display.inputvalue(
format
,
default
,
minimum
)
display.inputvalue(
format
,
default
,
minimum
,
maximum
)
format
A string that defines how the input field is formatted. See
Details
for more information
default
The default value for the input value
minimum
The minimum input value
maximum
The maximum input value
Details
format
uses 0s, the decimal point, polarity sign, and exponents to define how the input field is formatted.
format
can include the options shown in the following table.
Option Description
Examples
E
Include the E to display the value exponentially
0.0
+
Allows operators to enter positive or negative values; if the
"+" sign is not included, the operator cannot enter a
negative value
+0.00
0
Defines the digit positions for the value. You can use up to
six 0s.
+00.0000e+00
.
Include to have a decimal point appear in the value.
+0.00
The
default
parameter is the value shown when the value is first displayed.
The
minimum
and
maximum
parameters can be used to limit the values that can be entered. When + is selected
for
format
, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter
values above or below these limits.
The input value is limited to ±1e37.
Before calling
display.inputvalue()
, you should send a message prompt to the operator using
display.prompt()
. Make sure to position the cursor where the edit field should appear.
After this command is sent, script execution pauses until you enter a value and press the
ENTER
key.
For positive and negative entry ("+" sign used for the value field and/or the exponent field), polarity of a nonzero
value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel
. Polarity will also toggle when using the navigation wheel
to decrease or increase the value or exponent
past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative
polarity.
After executing this command and pressing the
EXIT (LOCAL)
key, value returns
nil
.
Example
display.clear()
display.settext("Enter value between$N -0.10 and 2.00: ")
value = display.inputvalue("+0.00", 0.5, -0.1, 2.0)
print("Value entered = ", value)
Displays an editable field (+0.50) for operator input. The valid input range is –0.10 to +2.00, with a default of
0.50.
Output:
Value entered = 1.00
