Keithley 2657A User Manual

Model 2657A High Power System SourceMeter® Instrument Reference Manual Section 7: TSP command reference
2657A-901-01 Rev. B/December 2012 7-45
dataqueue.add()
This function adds an entry to the data queue.
Type TSP-Link accessible
Affected by Where saved Default value
Function Yes
Usage
result = dataqueue.add(value)
result = dataqueue.add(value, timeout)
result
The resulting value of true or false based on the success of the function
value
The data item to add; value can be of any type
timeout
The maximum number of seconds to wait for space in the data queue
Details
You cannot use the timeout value when accessing the data queue from a remote node (you can only use the
timeout value while adding data to the local data queue).
The timeout value is ignored if the data queue is not full.
The dataqueue.add() function returns false:
• If the timeout expires before space is available in the data queue
• If the data queue is full and a timeout value is not specified
If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain
any references to the original table or to any subtables.
Example
dataqueue.clear()
dataqueue.add(10)
dataqueue.add(11, 2)
result = dataqueue.add(12, 3)
if result == false then
print("Failed to add 12 to the dataqueue")
end
print("The dataqueue contains:")
while dataqueue.count > 0 do
print(dataqueue.next())
end
Clear the data queue.
Each line adds one item to the data queue.
Output:
The dataqueue contains:
1.00000e+01
1.10000e+01
1.20000e+01
Also see
dataqueue.CAPACITY (on page 7-45)
dataqueue.clear()
(on page 7-46)
dataqueue.count
(on page 7-47)
dataqueue.next()
(on page 7-47)
dataqueue.CAPACITY
This constant is the maximum number of entries that you can store in the data queue.
Type TSP-Link accessible
Affected by Where saved Default value
Constant Yes

Keithley 2657A Specifications

General

Brand	Keithley
Model	2657A
Category	Measuring Instruments
Language	English