State

SCPI Command :

HCOPy:PAGE:WINDow:STATe
Commands in total: 1
Subgroups: 0
Direct child commands: 1
class StateStruct[source]

Response structure. Fields:

  • 1 Channel: str: String containing the name of the channel. For a list of available channel types use method RsFsw.instrument.listPy.get() .

  • 2 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 method RsFsw.layout.catalog.window.get() query.

  • 3 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]
# 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() .

Returns:

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

set(channel: str, window: str, state: bool) → None[source]
# 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() .

Parameters:

  • channel – String containing the name of the channel. For a list of available channel types use method RsFsw.instrument.listPy.get() .

  • 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.

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