State

SCPI Commands :

SCENario:LOCalized:EMITter:STATe:CLEar
SCENario:LOCalized:EMITter:STATe:COUNt
SCENario:LOCalized:EMITter:STATe:DELete
SCENario:LOCalized:EMITter:STATe:DURation
SCENario:LOCalized:EMITter:STATe:ENABle
SCENario:LOCalized:EMITter:STATe:INSert
SCENario:LOCalized:EMITter:STATe:SELect
SCENario:LOCalized:EMITter:STATe:VALue

class StateCls

State commands group definition. 9 total commands, 1 Subgroups, 8 group commands

clear() → None

# SCPI: SCENario:LOCalized:EMITter:STATe:CLEar
driver.scenario.localized.emitter.state.clear()

Deletes all items from the list or the table.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: SCENario:LOCalized:EMITter:STATe:CLEar
driver.scenario.localized.emitter.state.clear_with_opc()

Deletes all items from the list or the table.

Same as clear, 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.

delete(delete: float) → None

# SCPI: SCENario:LOCalized:EMITter:STATe:DELete
driver.scenario.localized.emitter.state.delete(delete = 1.0)

Deletes the particular item.

param delete:

float

get_count() → float

# SCPI: SCENario:LOCalized:EMITter:STATe:COUNt
value: float = driver.scenario.localized.emitter.state.get_count()

Queries the number of existing items.

return:

count: integer

get_duration() → float

# SCPI: SCENario:LOCalized:EMITter:STATe:DURation
value: float = driver.scenario.localized.emitter.state.get_duration()

Sets the duration during that the emitter remains in the current state.

return:

duration: float Range: -1e+06 to 1e+06

get_enable() → bool

# SCPI: SCENario:LOCalized:EMITter:STATe:ENABle
value: bool = driver.scenario.localized.emitter.state.get_enable()

Enables that an emitter can use on and off states.

return:

enable: ON| OFF| 1| 0

get_select() → float

# SCPI: SCENario:LOCalized:EMITter:STATe:SELect
value: float = driver.scenario.localized.emitter.state.get_select()

Selects the item to which the subsequent commands apply.

return:

select: float Item number within the range 1 to …:COUNt. For example, method RsPulseSeq.Sequence.Item.count. Range: 1 to 4096

get_value() → bool

# SCPI: SCENario:LOCalized:EMITter:STATe:VALue
value: bool = driver.scenario.localized.emitter.state.get_value()

Sets the emitter state during the selected period.

return:

value: ON| OFF| 1| 0

set_duration(duration: float) → None

# SCPI: SCENario:LOCalized:EMITter:STATe:DURation
driver.scenario.localized.emitter.state.set_duration(duration = 1.0)

Sets the duration during that the emitter remains in the current state.

param duration:

float Range: -1e+06 to 1e+06

set_enable(enable: bool) → None

# SCPI: SCENario:LOCalized:EMITter:STATe:ENABle
driver.scenario.localized.emitter.state.set_enable(enable = False)

Enables that an emitter can use on and off states.

param enable:

ON| OFF| 1| 0

set_insert(insert: float) → None

# SCPI: SCENario:LOCalized:EMITter:STATe:INSert
driver.scenario.localized.emitter.state.set_insert(insert = 1.0)

Inserts a new item before the selected one.

param insert:

float

set_select(select: float) → None

# SCPI: SCENario:LOCalized:EMITter:STATe:SELect
driver.scenario.localized.emitter.state.set_select(select = 1.0)

Selects the item to which the subsequent commands apply.

param select:

float Item number within the range 1 to …:COUNt. For example, method RsPulseSeq.Sequence.Item.count. Range: 1 to 4096

set_value(value: bool) → None

# SCPI: SCENario:LOCalized:EMITter:STATe:VALue
driver.scenario.localized.emitter.state.set_value(value = False)

Sets the emitter state during the selected period.

param value:

ON| OFF| 1| 0

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.scenario.localized.emitter.state.clone()

Subgroups

• Add