Section 11: TSP command reference
Series 3700A System Switch/Multimeter Reference Manual
11-70
3700AS-901-01 Rev. D/June 2018
channel.getpole()
This function queries the pole settings for the specified channels.
Type
TSP-Link accessible
Affected by
Where saved
Default value
Function
Yes
Instrument reset
Channel reset
Recall setup
Create configuration script
Save setup
Card dependent, typically 2
Usage
poles
= channel.getpole("
channelList
")
poles
Returns a comma-separated string of the poles, based on
channelList
; can be:
▪
One-pole:
1
▪
Two-pole:
2
▪
Four-pole:
4
channelList
A string listing the channels to query for their pole settings
Details
channelList
can contain
"slot
X
"
, where
X
is
1
to
6
, or
"allslots"
.
When the channel list parameter for this function is
"slot
X
"
, the response first lists the channels
starting from lowest to highest.
When the channel list parameter for this function is
"allslots"
, the response starts with slot 1 and
increases to slot 6. Each slot is processed completely before going to the next. All slot 1 channels are
listed before slot 2 channels.
The response is the numeric value representing the pole selection and not the text. For example, 4-
pole selection is 4 and not
channel.POLES_FOUR
.
An error message is generated if:
•
An empty parameter string is specified.
•
The specified channel does not exist for card installed in slot.
•
Parameter syntax error such as incorrect format for
channelList
.
•
A channel pattern was specified.
•
An analog backplane relay was specified.
•
Channel does not support pole setting like a digital I/O.
Command processing stops as soon as an error is detected. No partial list is returned. If an error is
detected or the slot is empty, the response is
nil
.
Digital I/O, DAC, backplane, and totalizer channels are not supported.
