Repository

SCPI Commands :

REPository:COMPlexity
REPository:ACCess
REPository:AUTHor
REPository:CATalog
REPository:COMMent
REPository:CREate
REPository:DATE
REPository:FILename
REPository:PATH
REPository:REMove
REPository:SAVE
REPository:SECurity
REPository:SELect
REPository:UUID
REPository:VERSion

class RepositoryCls

Repository commands group definition. 17 total commands, 2 Subgroups, 15 group commands

get_access() → str

# SCPI: REPository:ACCess
value: str = driver.repository.get_access()

Queries information on the access rights of the current user.

return:

access: permission,login,pass,Uname permission Permission of the current user, for example RW (read-write) login,pass Login/Pass=No: Password not required Login/Pass=Yes: Password required Uname User name of the current user

get_author() → str

# SCPI: REPository:AUTHor
value: str = driver.repository.get_author()

Enters information on the author.

return:

author: string

get_catalog() → str

# SCPI: REPository:CATalog
value: str = driver.repository.get_catalog()

Queries the available repository elements in the database.

return:

catalog: string

get_comment() → str

# SCPI: REPository:COMMent
value: str = driver.repository.get_comment()

Adds a description to the selected repository element.

return:

comment: string

get_complexity() → Complexity

# SCPI: REPository:COMPlexity
value: enums.Complexity = driver.repository.get_complexity()

Sets the complexity level.

return:

complexity: PTRain| EMITter| DIRection

get_date() → str

# SCPI: REPository:DATE
value: str = driver.repository.get_date()

Queries the creation data.

return:

date: string

get_filename() → str

# SCPI: REPository:FILename
value: str = driver.repository.get_filename()

Queries the file name of the repository archive.

return:

filename: string File path, incl. file name, and extension

get_path() → str

# SCPI: REPository:PATH
value: str = driver.repository.get_path()

Queries the directory in that the repository archive is stored.

return:

path: string

get_security() → SecurityLevel

# SCPI: REPository:SECurity
value: enums.SecurityLevel = driver.repository.get_security()

Sets the security level.

return:

security: LEV0| LEV1| LEV2| LEV3| LEV4

get_select() → str

# SCPI: REPository:SELect
value: str = driver.repository.get_select()

Selects the repository element to which the subsequent commands apply.

return:

select: string Element name, as defined with the …:CREate or …:NAME command. To query the existing elements, use the …:CATalog? command. For example, method RsPulseSeq.Repository.catalog.

get_uuid() → str

# SCPI: REPository:UUID
value: str = driver.repository.get_uuid()

Queries the repository’s Universally Unique Identifier (UUID) .

return:

uuid: string

get_version() → str

# SCPI: REPository:VERSion
value: str = driver.repository.get_version()

Sets the repository version.

return:

version: string

save() → None

# SCPI: REPository:SAVE
driver.repository.save()

Stores the repository archive. To query the storage location, use the command method RsPulseSeq.Repository.path.

save_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: REPository:SAVE
driver.repository.save_with_opc()

Stores the repository archive. To query the storage location, use the command method RsPulseSeq.Repository.path.

Same as save, but waits for the operation to complete before continuing further. Use the RsPulseSeq.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms:

Maximum time to wait in milliseconds, valid only for this call.

set_author(author: str) → None

# SCPI: REPository:AUTHor
driver.repository.set_author(author = 'abc')

Enters information on the author.

param author:

string

set_comment(comment: str) → None

# SCPI: REPository:COMMent
driver.repository.set_comment(comment = 'abc')

Adds a description to the selected repository element.

param comment:

string

set_complexity(complexity: Complexity) → None

# SCPI: REPository:COMPlexity
driver.repository.set_complexity(complexity = enums.Complexity.DIRection)

Sets the complexity level.

param complexity:

PTRain| EMITter| DIRection

set_create(create: str) → None

# SCPI: REPository:CREate
driver.repository.set_create(create = 'abc')

Creates a repository element with the selected name.

param create:

string Must be unique for the particular type of repository elements. May contain empty spaces.

set_date(date: str) → None

# SCPI: REPository:DATE
driver.repository.set_date(date = 'abc')

Queries the creation data.

param date:

string

set_remove(remove: str) → None

# SCPI: REPository:REMove
driver.repository.set_remove(remove = 'abc')

Removes the selected element from the workspace. The element must not reference any child elements. Remove the referenced elements first.

param remove:

No help available

set_security(security: SecurityLevel) → None

# SCPI: REPository:SECurity
driver.repository.set_security(security = enums.SecurityLevel.LEV0)

Sets the security level.

param security:

LEV0| LEV1| LEV2| LEV3| LEV4

set_select(select: str) → None

# SCPI: REPository:SELect
driver.repository.set_select(select = 'abc')

Selects the repository element to which the subsequent commands apply.

param select:

string Element name, as defined with the …:CREate or …:NAME command. To query the existing elements, use the …:CATalog? command. For example, method RsPulseSeq.Repository.catalog.

set_version(version: str) → None

# SCPI: REPository:VERSion
driver.repository.set_version(version = 'abc')

Sets the repository version.

param version:

string

Cloning the Group

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

Subgroups

• Volatile
• Xpol