from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import enums
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class ControlCls:
"""Control commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("control", core, parent)
[docs] def set(self, repetition: enums.HardcopyHeader, line=repcap.Line.Default) -> None:
"""SCPI: HCOPy:TREPort:ITEM:HEADer:LINE<li>:CONTrol \n
Snippet: driver.hardCopy.treport.item.header.line.control.set(repetition = enums.HardcopyHeader.ALWays, line = repcap.Line.Default) \n
This command selects how often the items in the report header are displayed in the document. \n
:param repetition: GLOBal The selected header line is displayed at the top of every page of the report. NEVer The selected header line is displayed on no page of the report. Note that a line that does not contain anything is still displayed in the report as a blank line. If you select NEVer, the line is not displayed at all. SECTion The selected header line is displayed after the title of every subreport.
:param line: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Line')
"""
param = Conversions.enum_scalar_to_str(repetition, enums.HardcopyHeader)
line_cmd_val = self._cmd_group.get_repcap_cmd_value(line, repcap.Line)
self._core.io.write(f'HCOPy:TREPort:ITEM:HEADer:LINE{line_cmd_val}:CONTrol {param}')
# noinspection PyTypeChecker
[docs] def get(self, line=repcap.Line.Default) -> enums.HardcopyHeader:
"""SCPI: HCOPy:TREPort:ITEM:HEADer:LINE<li>:CONTrol \n
Snippet: value: enums.HardcopyHeader = driver.hardCopy.treport.item.header.line.control.get(line = repcap.Line.Default) \n
This command selects how often the items in the report header are displayed in the document. \n
:param line: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Line')
:return: repetition: GLOBal The selected header line is displayed at the top of every page of the report. NEVer The selected header line is displayed on no page of the report. Note that a line that does not contain anything is still displayed in the report as a blank line. If you select NEVer, the line is not displayed at all. SECTion The selected header line is displayed after the title of every subreport."""
line_cmd_val = self._cmd_group.get_repcap_cmd_value(line, repcap.Line)
response = self._core.io.query_str(f'HCOPy:TREPort:ITEM:HEADer:LINE{line_cmd_val}:CONTrol?')
return Conversions.str_to_scalar_enum(response, enums.HardcopyHeader)