[python source code]

status

The status commands module.

These commands are used in the following models: DMM6500, DMM7510

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

Please report an issue if one is found.

Attributes and Functions 
- status.clear()
- status.condition
- status.operation.condition
- status.operation.enable
- status.operation.event
- status.operation.getmap()
- status.operation.setmap()
- status.preset()
- status.questionable.condition
- status.questionable.enable
- status.questionable.event
- status.questionable.getmap()
- status.questionable.setmap()
- status.request_enable
- status.standard.enable
- status.standard.event

Status

Bases: BaseTSPCmd

The status command tree.

Properties and methods
  • .clear(): The status.clear() function.
  • .condition: The status.condition attribute.
  • .operation: The status.operation command tree.
  • .preset(): The status.preset() function.
  • .questionable: The status.questionable command tree.
  • .request_enable: The status.request_enable attribute.
  • .standard: The status.standard command tree.

condition property 

condition: str

Access the status.condition attribute.

Description
  • This attribute stores the status byte condition register.
Usage
  • Accessing this property will send the print(status.condition) query.
TSP Syntax 
- print(status.condition)
Raises:

operation property 

operation: StatusOperation

Return the status.operation command tree.

Sub-properties and sub-methods
  • .condition: The status.operation.condition attribute.
  • .enable: The status.operation.enable attribute.
  • .event: The status.operation.event attribute.
  • .getmap(): The status.operation.getmap() function.
  • .setmap(): The status.operation.setmap() function.

questionable property 

questionable: StatusQuestionable

Return the status.questionable command tree.

Sub-properties and sub-methods
  • .condition: The status.questionable.condition attribute.
  • .enable: The status.questionable.enable attribute.
  • .event: The status.questionable.event attribute.
  • .getmap(): The status.questionable.getmap() function.
  • .setmap(): The status.questionable.setmap() function.

request_enable property writable 

request_enable: str

Access the status.request_enable attribute.

Description
  • This attribute stores the settings of the Service Request (SRQ) Enable Register.
Usage
  • Accessing this property will send the print(status.request_enable) query.
  • Setting this property to a value will send the status.request_enable = value command.
TSP Syntax 
- status.request_enable = value
- print(status.request_enable)
Raises:

standard property 

standard: StatusStandard

Return the status.standard command tree.

Sub-properties and sub-methods
  • .enable: The status.standard.enable attribute.
  • .event: The status.standard.event attribute.

clear 

clear() -> None

Run the status.clear() function.

Description
  • This function clears event registers.
TSP Syntax 
- status.clear()
Raises:

preset 

preset() -> None

Run the status.preset() function.

Description
  • This function resets all bits in the status model.
TSP Syntax 
- status.preset()
Raises:

StatusOperation

Bases: BaseTSPCmd

The status.operation command tree.

Properties and methods
  • .condition: The status.operation.condition attribute.
  • .enable: The status.operation.enable attribute.
  • .event: The status.operation.event attribute.
  • .getmap(): The status.operation.getmap() function.
  • .setmap(): The status.operation.setmap() function.

condition property 

condition: str

Access the status.operation.condition attribute.

Description
  • This attribute reads the Operation Event Register of the status model.
Usage
  • Accessing this property will send the print(status.operation.condition) query.
TSP Syntax 
- print(status.operation.condition)
Raises:

enable property writable 

enable: str

Access the status.operation.enable attribute.

Description
  • This attribute sets or reads the contents of the Operation Event Enable Register of the status model.
Usage
  • Accessing this property will send the print(status.operation.enable) query.
  • Setting this property to a value will send the status.operation.enable = value command.
TSP Syntax 
- status.operation.enable = value
- print(status.operation.enable)
Raises:

event property 

event: str

Access the status.operation.event attribute.

Description
  • This attribute reads the Operation Event Register of the status model.
Usage
  • Accessing this property will send the print(status.operation.event) query.
TSP Syntax 
- print(status.operation.event)
Raises:

getmap 

getmap(bit_number: int) -> str

Run the status.operation.getmap() function.

Description
  • This function requests the mapped set event and mapped clear event status for a bit in the Operation Event Registers.
TSP Syntax 
- status.operation.getmap()
Parameters:
  • bit_number (int) –

    The bit number to check.
Returns:
  • str –

    The result of the function call.
Raises:

setmap 

setmap(bit_number: int, set_event: int, clear_event: int | None = None) -> None

Run the status.operation.setmap() function.

Description
  • This function allows you to map events to bits in the Operation Event Register.
TSP Syntax 
- status.operation.setmap()
Parameters:
  • bit_number (int) –

    The bit number that is mapped to an event (0 to 14).

  • set_event (int) –

    The number of the event that sets the bits in the condition and event registers; 0 if no mapping.

  • clear_event (optional, default: None ) –

    The number of the event that clears the bit in the condition register; 0 if no mapping.
Raises:

StatusQuestionable

Bases: BaseTSPCmd

The status.questionable command tree.

Properties and methods
  • .condition: The status.questionable.condition attribute.
  • .enable: The status.questionable.enable attribute.
  • .event: The status.questionable.event attribute.
  • .getmap(): The status.questionable.getmap() function.
  • .setmap(): The status.questionable.setmap() function.

condition property 

condition: str

Access the status.questionable.condition attribute.

Description
  • This attribute reads the Questionable Condition Register of the status model.
Usage
  • Accessing this property will send the print(status.questionable.condition) query.
TSP Syntax 
- print(status.questionable.condition)
Raises:

enable property writable 

enable: str

Access the status.questionable.enable attribute.

Description
  • This attribute sets or reads the contents of the questionable event enable register of the status model.
Usage
  • Accessing this property will send the print(status.questionable.enable) query.
  • Setting this property to a value will send the status.questionable.enable = value command.
TSP Syntax 
- status.questionable.enable = value
- print(status.questionable.enable)
Raises:

event property 

event: str

Access the status.questionable.event attribute.

Description
  • This attribute reads the Questionable Event Register.
Usage
  • Accessing this property will send the print(status.questionable.event) query.
TSP Syntax 
- print(status.questionable.event)
Raises:

getmap 

getmap(bit_number: int) -> str

Run the status.questionable.getmap() function.

Description
  • This function requests the mapped set event and mapped clear event status for a bit in the Questionable Event Registers.
TSP Syntax 
- status.questionable.getmap()
Parameters:
  • bit_number (int) –

    The bit number to check (0 to 14).
Returns:
  • str –

    The result of the function call.
Raises:

setmap 

setmap(bit_number: int, set_event: int, clear_event: int | None = None) -> None

Run the status.questionable.setmap() function.

Description
  • This function maps events to bits in the questionable event registers.
TSP Syntax 
- status.questionable.setmap()
Parameters:
  • bit_number (int) –

    The bit number that is mapped to an event (0 to 14).

  • set_event (int) –

    The number of the event that sets the bits in the condition and event registers; 0 if no mapping.

  • clear_event (optional, default: None ) –

    The number of the event that clears the bit in the condition register; 0 if no mapping.
Raises:

StatusStandard

Bases: BaseTSPCmd

The status.standard command tree.

Properties and methods
  • .enable: The status.standard.enable attribute.
  • .event: The status.standard.event attribute.

enable property writable 

enable: str

Access the status.standard.enable attribute.

Description
  • This attribute reads or sets the bits in the Status Enable register of the Standard Event Register.
Usage
  • Accessing this property will send the print(status.standard.enable) query.
  • Setting this property to a value will send the status.standard.enable = value command.
TSP Syntax 
- status.standard.enable = value
- print(status.standard.enable)
Raises:

event property 

event: str

Access the status.standard.event attribute.

Description
  • This attribute returns the contents of the Standard Event Status Register set of the status model.
Usage
  • Accessing this property will send the print(status.standard.event) query.
TSP Syntax 
- print(status.standard.event)
Raises: