[python source code]

dataqueue

The dataqueue commands module.

These commands are used in the following models: DAQ6510, DMM6500, DMM7510, MP5103, SMU2450, SMU2460, SMU2461, SMU2470, SMU2601B, SMU2602B, SMU2604B, SMU2606B, SMU2611B, SMU2612B, SMU2614B, SMU2634B, SMU2635B, SMU2636B, SMU2651A, SMU2657A, SS3706A

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- dataqueue.add()
- dataqueue.clear()
- dataqueue.count
- dataqueue.next()

Dataqueue

Bases: BaseTSPCmd

The dataqueue command tree.

Constants
  • .CAPACITY: The maximum number of entries that you can store in the data queue.
Properties and methods
  • .add(): The dataqueue.add() function.
  • .clear(): The dataqueue.clear() function.
  • .count: The dataqueue.count attribute.
  • .next(): The dataqueue.next() function.

CAPACITY class-attribute instance-attribute 

CAPACITY = 'dataqueue.CAPACITY'

count property 

count: str

Access the dataqueue.count attribute.

Description
  • This attribute contains the number of items in the data queue.
Usage
  • Accessing this property will send the print(dataqueue.count) query.
TSP Syntax 
- print(dataqueue.count)
Raises:

add 

add(value: str, timeout: float | None = None) -> str

Run the dataqueue.add() function.

Description
  • This function adds an entry to the data queue.
TSP Syntax 
- dataqueue.add()
Parameters:
  • value (str) –

    The data item to add; value can be of any type.

  • timeout (optional, default: None ) –

    The maximum number of seconds to wait for space in the data queue.
Returns:
  • str –

    The result of the function call.
Raises:

clear 

clear() -> None

Run the dataqueue.clear() function.

Description
  • This function clears the data queue.
TSP Syntax 
- dataqueue.clear()
Raises:

next 

next(timeout: float | None = None) -> str

Run the dataqueue.next() function.

Description
  • This function removes the next entry from the data queue.
TSP Syntax 
- dataqueue.next()
Parameters:
  • timeout (optional, default: None ) –

    The number of seconds to wait for data in the queue.
Returns:
  • str –

    The result of the function call.
Raises: