State

SCPI Command :

HCOPy:PAGE:WINDow:STATe
class StateCls[source]

State commands group definition. 1 total commands, 0 Subgroups, 1 group commands

class StateStruct[source]

Response structure. Fields:

  • Channel: str: String containing the name of the channel. For a list of available channel types use [CMDLINKRESOLVED Instrument.ListPy#get_ CMDLINKRESOLVED].

  • Window: str: String containing the name of the existing window. By default, the name of a window is the same as its index. To determine the name and index of all active windows in the active channel, use the [CMDLINKRESOLVED Layout.Catalog.Window#get_ CMDLINKRESOLVED] query.

  • State: bool: 1 | 0 | ON | OFF 1 | ON The window is included in the printout. 0 | OFF The window is not included in the printout.

get() StateStruct[source]
# SCPI: HCOPy:PAGE:WINDow:STATe
value: StateStruct = driver.hardCopy.page.window.state.get()

This command selects the windows to be included in the printout for method RsFsw.HardCopy.Content.set.

return

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

set(channel: str, window: str, state: bool) None[source]
# SCPI: HCOPy:PAGE:WINDow:STATe
driver.hardCopy.page.window.state.set(channel = 'abc', window = 'abc', state = False)

This command selects the windows to be included in the printout for method RsFsw.HardCopy.Content.set.

param channel

String containing the name of the channel. For a list of available channel types use method RsFsw.Instrument.ListPy.get_.

param window

String containing the name of the existing window. By default, the name of a window is the same as its index. To determine the name and index of all active windows in the active channel, use the method RsFsw.Layout.Catalog.Window.get_ query.

param state

1 | 0 | ON | OFF 1 | ON The window is included in the printout. 0 | OFF The window is not included in the printout.