generic_commands ¶

A collection of classes and other helpful objects to use when generating command drivers.

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

Please report an issue if one is found.

BaseCmd ¶

A class defining the base syntax of a command class.

The syntax is accessible through the .cmd_syntax property.

cmd_syntax `property` ¶

cmd_syntax: str

Return the syntax.

DefaultDictPassKeyToFactory ¶

Bases: ParentDefaultDictClass

A custom defaultdict.

This custom defaultdict passes the key used to access a missing value into the stored default_factory function as the only parameter.

NoDeviceProvidedError ¶

Bases: Exception

A custom exception indicating that no device was provided.

ValidatedDynamicNumberCmd ¶

Bases: BaseCmd

A mixin class that is used to validate the dynamix item number is valid.

This class checks the dynamic item number at the end of the SCPI syntax (.cmd_syntax attribute) to determine if it is a valid dynamic item number (greater than or equal to 1).