MassMemory

SCPI Commands :

MMEMory:COPY
MMEMory:DELete
MMEMory:DRIVes
MMEMory:MDIRectory
MMEMory:MOVE
MMEMory:MSIS
MMEMory:RDIRectory
MMEMory:SAV
MMEMory:RCL
MMEMory:ALIases

class MassMemoryCls[source]

MassMemory commands group definition. 22 total commands, 6 Subgroups, 10 group commands

class AliasesStruct[source]

Structure for reading output parameters. Fields:

Alias: List[str]: No parameter help available
Path: List[str]: No parameter help available

copy(file_source: str, file_destination: str = None) → None[source]

# SCPI: MMEMory:COPY
driver.massMemory.copy(file_source = 'abc', file_destination = 'abc')

Copies an existing file. The target directory must exist.

param file_source:

string Name of the file to be copied. Wildcards ? and * are allowed if FileDestination contains a path without filename.

param file_destination:

string Path and/or name of the new file If no file destination is specified, the source file is written to the current directory (see method RsCmwBase.MassMemory.CurrentDirectory.set) . Wildcards are not allowed.

delete(filename: str) → None[source]

# SCPI: MMEMory:DELete
driver.massMemory.delete(filename = 'abc')

Deletes the specified files.

param filename:

string File to be deleted. The wildcards * and ? are allowed. Specifying a directory instead of a file is not allowed.

delete_directory(directory_name: str) → None[source]

# SCPI: MMEMory:RDIRectory
driver.massMemory.delete_directory(directory_name = 'abc')

Removes an existing empty directory from the mass memory storage system.

param directory_name:

string Wildcards are not allowed.

get_aliases() → AliasesStruct[source]

# SCPI: MMEMory:ALIases
value: AliasesStruct = driver.massMemory.get_aliases()

Returns the defined alias entries and the assigned directories. These settings are predefined and cannot be configured.

return:

structure: for return value, see the help for AliasesStruct structure arguments.

get_drives() → List[str][source]

# SCPI: MMEMory:DRIVes
value: List[str] = driver.massMemory.get_drives()

Returns a list of the available drives.

return:

drive: string Comma-separated list of strings, one string per drive

get_msis() → str[source]

# SCPI: MMEMory:MSIS
value: str = driver.massMemory.get_msis()

Changes the default storage unit (drive or server) for mass memory storage. When the default storage unit is changed, it is checked whether the current directory (see method RsCmwBase.MassMemory.CurrentDirectory.set) is also available on the new storage unit. If not, the current directory is automatically set to ‘/’.

return:

msus: No help available

make_directory(directory_name: str) → None[source]

# SCPI: MMEMory:MDIRectory
driver.massMemory.make_directory(directory_name = 'abc')

Creates a directory. If necessary, an entire path consisting of several subdirectories is created.

param directory_name:

string Wildcards are not allowed.

move(file_source: str, file_destination: str) → None[source]

# SCPI: MMEMory:MOVE
driver.massMemory.move(file_source = 'abc', file_destination = 'abc')

Moves or renames an existing object (file or directory) to a new location.

param file_source:

string Name of the object to be moved or renamed. Wildcards ? and * are only allowed for moving files without renaming.

param file_destination:

string New name and/or path of the object. Wildcards are not allowed. If a new object name without path is specified, the object is renamed. If a new path without object name is specified, the object is moved to this path. If a new path and a new object name are specified, the object is moved to this path and renamed.

recall(filename: str, msus: str = None) → None[source]

# SCPI: MMEMory:RCL
driver.massMemory.recall(filename = 'abc', msus = 'abc')

Restores the instrument settings from the specified file. This command has the same effect as the combination of method RsCmwBase.MassMemory.Load.State.set and *RCL.

param filename:

No help available

param msus:

No help available

save(filename: str, msus: str = None) → None[source]

# SCPI: MMEMory:SAV
driver.massMemory.save(filename = 'abc', msus = 'abc')

Stores the current instrument settings to the specified file. This command has the same effect as the combination of *SAV and method RsCmwBase.MassMemory.Store.State.set.

param filename:

No help available

param msus:

No help available

set_msis(msus: str) → None[source]

# SCPI: MMEMory:MSIS
driver.massMemory.set_msis(msus = 'abc')

Changes the default storage unit (drive or server) for mass memory storage. When the default storage unit is changed, it is checked whether the current directory (see method RsCmwBase.MassMemory.CurrentDirectory.set) is also available on the new storage unit. If not, the current directory is automatically set to ‘/’.

param msus:

string Default storage unit

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.massMemory.clone()

Subgroups