[python source code]

buffervar

The buffervar commands module.

These commands are used in the following models: DMM6500

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

Please report an issue if one is found.

Attributes and Functions 
- bufferVar.capacity
- bufferVar.channels[N]
- bufferVar.clear()
- bufferVar.dates[N]
- bufferVar.endindex
- bufferVar.extraformattedvalues[N]
- bufferVar.extravalues[N]
- bufferVar.extravalueunits[N]
- bufferVar.fillmode
- bufferVar.formattedreadings[N]
- bufferVar.fractionalseconds[N]
- bufferVar.logstate
- bufferVar.n
- bufferVar.readings[N]
- bufferVar.relativetimestamps[N]
- bufferVar.seconds[N]
- bufferVar.startindex
- bufferVar.statuses[N]
- bufferVar.times[N]
- bufferVar.timestamps[N]
- bufferVar.units

Buffervar

Bases: BaseTSPCmd

The bufferVar command tree.

Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Properties and methods
  • .capacity: The bufferVar.capacity attribute.
  • .channels: The bufferVar.channels[N] attribute.
  • .clear(): The bufferVar.clear() function.
  • .dates: The bufferVar.dates[N] attribute.
  • .endindex: The bufferVar.endindex attribute.
  • .extraformattedvalues: The bufferVar.extraformattedvalues[N] attribute.
  • .extravalues: The bufferVar.extravalues[N] attribute.
  • .extravalueunits: The bufferVar.extravalueunits[N] attribute.
  • .fillmode: The bufferVar.fillmode attribute.
  • .formattedreadings: The bufferVar.formattedreadings[N] attribute.
  • .fractionalseconds: The bufferVar.fractionalseconds[N] attribute.
  • .logstate: The bufferVar.logstate attribute.
  • .n: The bufferVar.n attribute.
  • .readings: The bufferVar.readings[N] attribute.
  • .relativetimestamps: The bufferVar.relativetimestamps[N] attribute.
  • .seconds: The bufferVar.seconds[N] attribute.
  • .startindex: The bufferVar.startindex attribute.
  • .statuses: The bufferVar.statuses[N] attribute.
  • .times: The bufferVar.times[N] attribute.
  • .timestamps: The bufferVar.timestamps[N] attribute.
  • .units: The bufferVar.units attribute.

capacity property writable 

capacity: str

Access the bufferVar.capacity attribute.

Description
  • This attribute sets the number of readings a buffer can store.
Usage
  • Accessing this property will send the print(bufferVar.capacity) query.
  • Setting this property to a value will send the bufferVar.capacity = value command.
TSP Syntax 
- bufferVar.capacity = value
- print(bufferVar.capacity)
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Raises:

channels property 

channels: Dict[int, Union[str, float]]

Access the bufferVar.channels[N] attribute.

Description
  • This attribute contains the channels that produced the readings that are stored in the reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.channels[N]) query.
TSP Syntax 
- print(bufferVar.channels[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

dates property 

dates: Dict[int, Union[str, float]]

Access the bufferVar.dates[N] attribute.

Description
  • When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the dates (month, day, and year) of readings stored in the reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.dates[N]) query.
TSP Syntax 
- print(bufferVar.dates[N])
Info
  • bufferVar, the reading buffer.
  • N, the reading number (1 to bufferVar.n).
Raises:

endindex property 

endindex: str

Access the bufferVar.endindex attribute.

Description
  • This attribute indicates the last index in a reading buffer.
Usage
  • Accessing this property will send the print(bufferVar.endindex) query.
TSP Syntax 
- print(bufferVar.endindex)
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Raises:

extraformattedvalues property 

extraformattedvalues: Dict[int, Union[str, float]]

Access the bufferVar.extraformattedvalues[N] attribute.

Description
  • This attribute contains the measurement and the unit of measure of the additional values in a reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.extraformattedvalues[N]) query.
TSP Syntax 
- print(bufferVar.extraformattedvalues[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

extravalues property 

extravalues: Dict[int, Union[str, float]]

Access the bufferVar.extravalues[N] attribute.

Description
  • This attribute contains the additional values in a reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.extravalues[N]) query.
TSP Syntax 
- print(bufferVar.extravalues[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

extravalueunits property 

extravalueunits: Dict[int, Union[str, float]]

Access the bufferVar.extravalueunits[N] attribute.

Description
  • This attribute contains the units of the additional values in a reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.extravalueunits[N]) query.
TSP Syntax 
- print(bufferVar.extravalueunits[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

fillmode property writable 

fillmode: str

Access the bufferVar.fillmode attribute.

Description
  • This attribute determines if a reading buffer is filled continuously or is filled once and stops.
Usage
  • Accessing this property will send the print(bufferVar.fillmode) query.
  • Setting this property to a value will send the bufferVar.fillmode = value command.
TSP Syntax 
- bufferVar.fillmode = value
- print(bufferVar.fillmode)
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Raises:

formattedreadings property 

formattedreadings: Dict[int, Union[str, float]]

Access the bufferVar.formattedreadings[N] attribute.

Description
  • This attribute contains the stored readings shown as numbers with units and prefixes.
Usage
  • Accessing an item from this property will send the print(bufferVar.formattedreadings[N]) query.
TSP Syntax 
- print(bufferVar.formattedreadings[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

fractionalseconds property 

fractionalseconds: Dict[int, Union[str, float]]

Access the bufferVar.fractionalseconds[N] attribute.

Description
  • This attribute contains the fractional second portion of the timestamp of each reading in the reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.fractionalseconds[N]) query.
TSP Syntax 
- print(bufferVar.fractionalseconds[N])
Info
  • bufferVar, the reading buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

logstate property writable 

logstate: str

Access the bufferVar.logstate attribute.

Description
  • This attribute indicates if information events are logged when the specified reading buffer is at 0% or 100% filled.
Usage
  • Accessing this property will send the print(bufferVar.logstate) query.
  • Setting this property to a value will send the bufferVar.logstate = value command.
TSP Syntax 
- bufferVar.logstate = value
- print(bufferVar.logstate)
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Raises:

n property 

n: str

Access the bufferVar.n attribute.

Description
  • This attribute contains the number of readings in the specified reading buffer.
Usage
  • Accessing this property will send the print(bufferVar.n) query.
TSP Syntax 
- print(bufferVar.n)
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Raises:

readings property 

readings: Dict[int, Union[str, float]]

Access the bufferVar.readings[N] attribute.

Description
  • This attribute contains the readings stored in a specified reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.readings[N]) query.
TSP Syntax 
- print(bufferVar.readings[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

relativetimestamps property 

relativetimestamps: Dict[int, Union[str, float]]

Access the bufferVar.relativetimestamps[N] attribute.

Description
  • This attribute contains the timestamps, in seconds, when each reading occurred, relative to the timestamp of the first entry in the reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.relativetimestamps[N]) query.
TSP Syntax 
- print(bufferVar.relativetimestamps[N])
Info
  • bufferVar, the reading buffer.
  • N, the reading number (1 to bufferVar.n).
Raises:

seconds property 

seconds: Dict[int, Union[str, float]]

Access the bufferVar.seconds[N] attribute.

Description
  • This attribute contains the timestamp of a reading in seconds, in UTC format.
Usage
  • Accessing an item from this property will send the print(bufferVar.seconds[N]) query.
TSP Syntax 
- print(bufferVar.seconds[N])
Info
  • bufferVar, the reading buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

startindex property 

startindex: str

Access the bufferVar.startindex attribute.

Description
  • This attribute indicates the starting index in a reading buffer.
Usage
  • Accessing this property will send the print(bufferVar.startindex) query.
TSP Syntax 
- print(bufferVar.startindex)
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Raises:

statuses property 

statuses: Dict[int, Union[str, float]]

Access the bufferVar.statuses[N] attribute.

Description
  • This attribute contains the status values of readings in the reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.statuses[N]) query.
TSP Syntax 
- print(bufferVar.statuses[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

times property 

times: Dict[int, Union[str, float]]

Access the bufferVar.times[N] attribute.

Description
  • When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the time of the readings (in hours, minutes, and seconds format) in the reading buffer.
Usage
  • Accessing an item from this property will send the print(bufferVar.times[N]) query.
TSP Syntax 
- print(bufferVar.times[N])
Info
  • bufferVar, the reading buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

timestamps property 

timestamps: Dict[int, Union[str, float]]

Access the bufferVar.timestamps[N] attribute.

Description
  • This attribute contains the timestamp when each reading saved in the specified reading buffer occurred.
Usage
  • Accessing an item from this property will send the print(bufferVar.timestamps[N]) query.
TSP Syntax 
- print(bufferVar.timestamps[N])
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
  • N, the reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the buffer.
Raises:

units property 

units: str

Access the bufferVar.units attribute.

Description
  • This attribute contains the unit of measure that is stored with readings in the reading buffer.
Usage
  • Accessing this property will send the print(bufferVar.units) query.
TSP Syntax 
- print(bufferVar.units)
Raises:

clear 

clear() -> None

Run the bufferVar.clear() function.

Description
  • This function clears all readings and statistics from the specified buffer.
TSP Syntax 
- bufferVar.clear()
Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Raises: