[python source code]

alias

The alias commands module.

These commands are used in the following models: DPO7AX, LPD6, MSO4, MSO4B, MSO5, MSO5B, MSO5LP, MSO6, MSO6B

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

Please report an issue if one is found.

Commands and Queries 
- ALIas {ON|OFF|<NR1>}
- ALIas:CATalog?
- ALIas:DEFine <QString>
- ALIas:DEFine?
- ALIas:DELEte <QString>
- ALIas:DELEte:ALL
- ALIas:DELEte:NAMe <QString>
- ALIas:STATE {ON|OFF|<NR1>}
- ALIas:STATE?
- ALIas?

Alias

Bases: SCPICmdWrite, SCPICmdRead

The ALIas command.

Description
  • This command sets or queries the state of alias functionality, and it is identical to the ALIAS:STATE command.
Usage
  • Using the .query() method will send the ALIas? query.
  • Using the .verify(value) method will send the ALIas? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ALIas value command.
SCPI Syntax 
- ALIas {ON|OFF|<NR1>}
- ALIas?
Info
  • OFF turns Alias expansion off.
  • ON turns Alias expansion on. When a defined alias is received, the specified command sequence is substituted for the alias and executed.
  • <NR1> = 0 disables Alias mode; any other value enables Alias mode.
Properties
  • .catalog: The ALIas:CATalog command.
  • .define: The ALIas:DEFine command.
  • .delete: The ALIas:DELEte command.
  • .state: The ALIas:STATE command.

catalog property 

catalog: AliasCatalog

Return the ALIas:CATalog command.

Description
  • This query-only command returns a list of the currently defined alias labels, separated by commas. If no aliases are defined, the query returns the string ‘’.
Usage
  • Using the .query() method will send the ALIas:CATalog? query.
  • Using the .verify(value) method will send the ALIas:CATalog? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ALIas:CATalog?

define property 

define: AliasDefine

Return the ALIas:DEFine command.

Description
  • This command assigns a sequence of program messages to an alias label. These messages are then substituted for the alias whenever it is received as a command or query, provided that ALIas:STATE is turned on. The query form of this command returns the definitions of a selected alias. Note: Attempting to give two aliases the same name causes an error. To give a new alias the name of an existing alias, the existing alias must first be deleted.
Usage
  • Using the .query() method will send the ALIas:DEFine? query.
  • Using the .verify(value) method will send the ALIas:DEFine? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ALIas:DEFine value command.
SCPI Syntax 
- ALIas:DEFine <QString>
- ALIas:DEFine?
Info
  • <QString> assigns a sequence of program messages to an alias label. The is argument is formatted as: <,>{|}. Thefirst is the alias label. This label cannot be a command name. Labelsmust start with a letter and can contain only letters, numbers, and underscores;other characters are not allowed. The label must be less than or equal to 12 characters. The second or is a complete sequence of programmessages. The messages can contain only valid commands that must be separatedby semicolons and must follow all rules for concatenating commands. Thesequence must be less than or equal to 256 characters.

delete property 

delete: AliasDelete

Return the ALIas:DELEte command.

Description
  • This command removes a specified alias and is identical to ALIas:DELEte:NAMe. An error message is generated if the named alias does not exist.
Usage
  • Using the .write(value) method will send the ALIas:DELEte value command.
SCPI Syntax 
- ALIas:DELEte <QString>
Info
  • <QString> is the name of the alias to be removed. Using ALIas:DELEte without specifying an alias causes an execution error. must be apreviously defined value.
Sub-properties
  • .all: The ALIas:DELEte:ALL command.
  • .name: The ALIas:DELEte:NAMe command.

state property 

state: AliasState

Return the ALIas:STATE command.

Description
  • This command turns aliases on or off and is identical to the ALIas command. The query form of this command returns the state of the aliases.
Usage
  • Using the .query() method will send the ALIas:STATE? query.
  • Using the .verify(value) method will send the ALIas:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ALIas:STATE value command.
SCPI Syntax 
- ALIas:STATE {ON|OFF|<NR1>}
- ALIas:STATE?
Info
  • <NR1> = 0 turns off aliases; any other value turns on aliases.
  • OFF turns alias expansion off.
  • ON turns alias expansion on. When a defined alias is received, the specified command sequence is substituted for the alias and executed.

AliasCatalog

Bases: SCPICmdRead

The ALIas:CATalog command.

Description
  • This query-only command returns a list of the currently defined alias labels, separated by commas. If no aliases are defined, the query returns the string ‘’.
Usage
  • Using the .query() method will send the ALIas:CATalog? query.
  • Using the .verify(value) method will send the ALIas:CATalog? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- ALIas:CATalog?

AliasDefine

Bases: SCPICmdWrite, SCPICmdRead

The ALIas:DEFine command.

Description
  • This command assigns a sequence of program messages to an alias label. These messages are then substituted for the alias whenever it is received as a command or query, provided that ALIas:STATE is turned on. The query form of this command returns the definitions of a selected alias. Note: Attempting to give two aliases the same name causes an error. To give a new alias the name of an existing alias, the existing alias must first be deleted.
Usage
  • Using the .query() method will send the ALIas:DEFine? query.
  • Using the .verify(value) method will send the ALIas:DEFine? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ALIas:DEFine value command.
SCPI Syntax 
- ALIas:DEFine <QString>
- ALIas:DEFine?
Info
  • <QString> assigns a sequence of program messages to an alias label. The is argument is formatted as: <,>{|}. Thefirst is the alias label. This label cannot be a command name. Labelsmust start with a letter and can contain only letters, numbers, and underscores;other characters are not allowed. The label must be less than or equal to 12 characters. The second or is a complete sequence of programmessages. The messages can contain only valid commands that must be separatedby semicolons and must follow all rules for concatenating commands. Thesequence must be less than or equal to 256 characters.

AliasDelete

Bases: SCPICmdWrite, SCPICmdRead

The ALIas:DELEte command.

Description
  • This command removes a specified alias and is identical to ALIas:DELEte:NAMe. An error message is generated if the named alias does not exist.
Usage
  • Using the .write(value) method will send the ALIas:DELEte value command.
SCPI Syntax 
- ALIas:DELEte <QString>
Info
  • <QString> is the name of the alias to be removed. Using ALIas:DELEte without specifying an alias causes an execution error. must be apreviously defined value.
Properties
  • .all: The ALIas:DELEte:ALL command.
  • .name: The ALIas:DELEte:NAMe command.

all property 

all: AliasDeleteAll

Return the ALIas:DELEte:ALL command.

Description
  • This command deletes all existing aliases.
Usage
  • Using the .write() method will send the ALIas:DELEte:ALL command.
SCPI Syntax 
- ALIas:DELEte:ALL

name property 

name: AliasDeleteName

Return the ALIas:DELEte:NAMe command.

Description
  • This command removes a specified alias. An error message is generated if the named alias does not exist. This command is identical to ALIas:DELEte.
Usage
  • Using the .write(value) method will send the ALIas:DELEte:NAMe value command.
SCPI Syntax 
- ALIas:DELEte:NAMe <QString>
Info
  • <QString> is the name of the alias to remove. Using ALIas:DELEte:NAMewithout specifying an alias causes an exception error. must be apreviously defined alias.

AliasDeleteAll

Bases: SCPICmdWriteNoArguments

The ALIas:DELEte:ALL command.

Description
  • This command deletes all existing aliases.
Usage
  • Using the .write() method will send the ALIas:DELEte:ALL command.
SCPI Syntax 
- ALIas:DELEte:ALL

AliasDeleteName

Bases: SCPICmdWrite

The ALIas:DELEte:NAMe command.

Description
  • This command removes a specified alias. An error message is generated if the named alias does not exist. This command is identical to ALIas:DELEte.
Usage
  • Using the .write(value) method will send the ALIas:DELEte:NAMe value command.
SCPI Syntax 
- ALIas:DELEte:NAMe <QString>
Info
  • <QString> is the name of the alias to remove. Using ALIas:DELEte:NAMewithout specifying an alias causes an exception error. must be apreviously defined alias.

AliasState

Bases: SCPICmdWrite, SCPICmdRead

The ALIas:STATE command.

Description
  • This command turns aliases on or off and is identical to the ALIas command. The query form of this command returns the state of the aliases.
Usage
  • Using the .query() method will send the ALIas:STATE? query.
  • Using the .verify(value) method will send the ALIas:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the ALIas:STATE value command.
SCPI Syntax 
- ALIas:STATE {ON|OFF|<NR1>}
- ALIas:STATE?
Info
  • <NR1> = 0 turns off aliases; any other value turns on aliases.
  • OFF turns alias expansion off.
  • ON turns alias expansion on. When a defined alias is received, the specified command sequence is substituted for the alias and executed.