[python source code]

scriptvar

The scriptvar 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 
- scriptVar.autorun
- scriptVar.list()
- scriptVar.name
- scriptVar.run()
- scriptVar.save()
- scriptVar.source

Scriptvar

Bases: BaseTSPCmd

The scriptVar command tree.

Info
  • scriptVar, the name of the variable that references the script.
Properties and methods
  • .autorun: The scriptVar.autorun attribute.
  • .list(): The scriptVar.list() function.
  • .name: The scriptVar.name attribute.
  • .run(): The scriptVar.run() function.
  • .save(): The scriptVar.save() function.
  • .source: The scriptVar.source attribute.

autorun property writable 

autorun: str

Access the scriptVar.autorun attribute.

Description
  • This attribute controls the autorun state of a script.
Usage
  • Accessing this property will send the print(scriptVar.autorun) query.
  • Setting this property to a value will send the scriptVar.autorun = value command.
TSP Syntax 
- scriptVar.autorun = value
- print(scriptVar.autorun)
Info
  • scriptVar, the name of the variable that references the script.
Raises:

name property writable 

name: str

Access the scriptVar.name attribute.

Description
  • This attribute contains the name of a script in the runtime environment.
Usage
  • Accessing this property will send the print(scriptVar.name) query.
  • Setting this property to a value will send the scriptVar.name = value command.
TSP Syntax 
- scriptVar.name = value
- print(scriptVar.name)
Info
  • scriptVar, the name of the variable that references the script.
Raises:

source property 

source: str

Access the scriptVar.source attribute.

Description
  • This attribute contains the source code of a script.
Usage
  • Accessing this property will send the print(scriptVar.source) query.
TSP Syntax 
- print(scriptVar.source)
Info
  • scriptVar, the name of the variable that references the script that contains the source code.
Raises:

list 

list() -> None

Run the scriptVar.list() function.

Description
  • This function generates a script listing.
TSP Syntax 
- scriptVar.list()
Info
  • scriptVar, the name of the variable that references the script.
Raises:

run 

run() -> None

Run the scriptVar.run() function.

Description
  • This function runs a script.
TSP Syntax 
- scriptVar.run()
Info
  • scriptVar, the name of the variable that references the script.
Raises:

save 

save(filename: str | None = None) -> None

Run the scriptVar.save() function.

Description
  • This function saves the script to nonvolatile memory or to a USB flash drive.
TSP Syntax 
- scriptVar.save()
Parameters:
  • filename (optional, default: None ) –

    A string that contains the file name to use when saving the script to a USB flash drive.
Raises: