[python source code]

format

The format commands module.

These commands are used in the following models: SS3706A

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

Please report an issue if one is found.

Attributes and Functions 
- format.asciiprecision
- format.byteorder
- format.data

Format

Bases: BaseTSPCmd

The format command tree.

Properties and methods
  • .asciiprecision: The format.asciiprecision attribute.
  • .byteorder: The format.byteorder attribute.
  • .data: The format.data attribute.

asciiprecision property writable 

asciiprecision: str

Access the format.asciiprecision attribute.

Description
  • This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.
Usage
  • Accessing this property will send the print(format.asciiprecision) query.
  • Setting this property to a value will send the format.asciiprecision = value command.
TSP Syntax 
- format.asciiprecision = value
- print(format.asciiprecision)
Info
  • precision, a number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number from 1 to 16; set to 0 to have the instrument select the precision automatically based on the number that is being formatted.
Raises:

byteorder property writable 

byteorder: str

Access the format.byteorder attribute.

Description
  • This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.
Usage
  • Accessing this property will send the print(format.byteorder) query.
  • Setting this property to a value will send the format.byteorder = value command.
TSP Syntax 
- format.byteorder = value
- print(format.byteorder)
Info

  • order, the byte order value as follows:

    • Most significant byte first: 0, format.NORMAL, format.NETWORK, or format.BIGENDIAN
    • Least significant byte first: 1, format.SWAPPED or format.LITTLEENDIAN.
Raises:

data property writable 

data: str

Access the format.data attribute.

Description
  • This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.
Usage
  • Accessing this property will send the print(format.data) query.
  • Setting this property to a value will send the format.data = value command.
TSP Syntax 
- format.data = value
- print(format.data)
Raises: