from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ContentCls:
"""
| Commands in total: 8
| Subgroups: 0
| Direct child commands: 8
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("content", core, parent)
[docs]
def get_title(self) -> bool:
"""
``POWer:REPort:CONTent:TITLe`` \n
Snippet: ``value: bool = driver.power.report.content.get_title()`` \n
Includes the title page in the report.
:return: content_title: OFF | ON
"""
response = self._core.io.query_str('POWer:REPort:CONTent:TITLe?')
return Conversions.str_to_bool(response)
[docs]
def set_title(self, content_title: bool) -> None:
"""
``POWer:REPort:CONTent:TITLe`` \n
Snippet: ``driver.power.report.content.set_title(content_title = False)`` \n
Includes the title page in the report.
:param content_title: OFF | ON
"""
param = Conversions.bool_to_str(content_title)
self._core.io.write(f'POWer:REPort:CONTent:TITLe {param}')
# noinspection PyTypeChecker
[docs]
def get_msetup(self) -> enums.PwrReportContent:
"""
``POWer:REPort:CONTent:MSETup`` \n
Snippet: ``value: enums.PwrReportContent = driver.power.report.content.get_msetup()`` \n
Sets how often the respective content is shown in the final report.
"""
response = self._core.io.query_str('POWer:REPort:CONTent:MSETup?')
return Conversions.str_to_scalar_enum(response, enums.PwrReportContent)
[docs]
def set_msetup(self, content_meas_set: enums.PwrReportContent) -> None:
"""
``POWer:REPort:CONTent:MSETup`` \n
Snippet: ``driver.power.report.content.set_msetup(content_meas_set = enums.PwrReportContent.ALWAYS)`` \n
Sets how often the respective content is shown in the final report.
:param content_meas_set: ALWAYS | NEVER | ONCE
"""
param = Conversions.enum_scalar_to_str(content_meas_set, enums.PwrReportContent)
self._core.io.write(f'POWer:REPort:CONTent:MSETup {param}')
# noinspection PyTypeChecker
[docs]
def get_settings(self) -> enums.PwrReportContent:
"""
``POWer:REPort:CONTent:SETTings`` \n
Snippet: ``value: enums.PwrReportContent = driver.power.report.content.get_settings()`` \n
Sets how often the respective content is shown in the final report.
"""
response = self._core.io.query_str('POWer:REPort:CONTent:SETTings?')
return Conversions.str_to_scalar_enum(response, enums.PwrReportContent)
[docs]
def set_settings(self, content_sett: enums.PwrReportContent) -> None:
"""
``POWer:REPort:CONTent:SETTings`` \n
Snippet: ``driver.power.report.content.set_settings(content_sett = enums.PwrReportContent.ALWAYS)`` \n
Sets how often the respective content is shown in the final report.
:param content_sett: ALWAYS | NEVER | ONCE
"""
param = Conversions.enum_scalar_to_str(content_sett, enums.PwrReportContent)
self._core.io.write(f'POWer:REPort:CONTent:SETTings {param}')
# noinspection PyTypeChecker
[docs]
def get_vsetup(self) -> enums.PwrReportContent:
"""
``POWer:REPort:CONTent:VSETup`` \n
Snippet: ``value: enums.PwrReportContent = driver.power.report.content.get_vsetup()`` \n
Sets how often the respective content is shown in the final report.
:return: content_vert_set: ALWAYS | NEVER | ONCE
"""
response = self._core.io.query_str('POWer:REPort:CONTent:VSETup?')
return Conversions.str_to_scalar_enum(response, enums.PwrReportContent)
[docs]
def set_vsetup(self, content_vert_set: enums.PwrReportContent) -> None:
"""
``POWer:REPort:CONTent:VSETup`` \n
Snippet: ``driver.power.report.content.set_vsetup(content_vert_set = enums.PwrReportContent.ALWAYS)`` \n
Sets how often the respective content is shown in the final report.
:param content_vert_set: ALWAYS | NEVER | ONCE
"""
param = Conversions.enum_scalar_to_str(content_vert_set, enums.PwrReportContent)
self._core.io.write(f'POWer:REPort:CONTent:VSETup {param}')
# noinspection PyTypeChecker
[docs]
def get_hsetup(self) -> enums.PwrReportContent:
"""
``POWer:REPort:CONTent:HSETup`` \n
Snippet: ``value: enums.PwrReportContent = driver.power.report.content.get_hsetup()`` \n
Sets how often the respective content is shown in the final report.
"""
response = self._core.io.query_str('POWer:REPort:CONTent:HSETup?')
return Conversions.str_to_scalar_enum(response, enums.PwrReportContent)
[docs]
def set_hsetup(self, content_horiz_set: enums.PwrReportContent) -> None:
"""
``POWer:REPort:CONTent:HSETup`` \n
Snippet: ``driver.power.report.content.set_hsetup(content_horiz_set = enums.PwrReportContent.ALWAYS)`` \n
Sets how often the respective content is shown in the final report.
:param content_horiz_set: ALWAYS | NEVER | ONCE
"""
param = Conversions.enum_scalar_to_str(content_horiz_set, enums.PwrReportContent)
self._core.io.write(f'POWer:REPort:CONTent:HSETup {param}')
# noinspection PyTypeChecker
[docs]
def get_tsetup(self) -> enums.PwrReportContent:
"""
``POWer:REPort:CONTent:TSETup`` \n
Snippet: ``value: enums.PwrReportContent = driver.power.report.content.get_tsetup()`` \n
Sets how often the respective content is shown in the final report.
"""
response = self._core.io.query_str('POWer:REPort:CONTent:TSETup?')
return Conversions.str_to_scalar_enum(response, enums.PwrReportContent)
[docs]
def set_tsetup(self, content_trig_set: enums.PwrReportContent) -> None:
"""
``POWer:REPort:CONTent:TSETup`` \n
Snippet: ``driver.power.report.content.set_tsetup(content_trig_set = enums.PwrReportContent.ALWAYS)`` \n
Sets how often the respective content is shown in the final report.
:param content_trig_set: ALWAYS | NEVER | ONCE
"""
param = Conversions.enum_scalar_to_str(content_trig_set, enums.PwrReportContent)
self._core.io.write(f'POWer:REPort:CONTent:TSETup {param}')
# noinspection PyTypeChecker
[docs]
def get_msignal(self) -> enums.PwrReportContent:
"""
``POWer:REPort:CONTent:MSIGnal`` \n
Snippet: ``value: enums.PwrReportContent = driver.power.report.content.get_msignal()`` \n
Sets how often the respective content is shown in the final report.
"""
response = self._core.io.query_str('POWer:REPort:CONTent:MSIGnal?')
return Conversions.str_to_scalar_enum(response, enums.PwrReportContent)
[docs]
def set_msignal(self, content_measured_signs: enums.PwrReportContent) -> None:
"""
``POWer:REPort:CONTent:MSIGnal`` \n
Snippet: ``driver.power.report.content.set_msignal(content_measured_signs = enums.PwrReportContent.ALWAYS)`` \n
Sets how often the respective content is shown in the final report.
:param content_measured_signs: ALWAYS | NEVER | ONCE
"""
param = Conversions.enum_scalar_to_str(content_measured_signs, enums.PwrReportContent)
self._core.io.write(f'POWer:REPort:CONTent:MSIGnal {param}')
# noinspection PyTypeChecker
[docs]
def get_resu(self) -> enums.PwrReportContent:
"""
``POWer:REPort:CONTent:RESU`` \n
Snippet: ``value: enums.PwrReportContent = driver.power.report.content.get_resu()`` \n
Sets how often the respective content is shown in the final report.
"""
response = self._core.io.query_str('POWer:REPort:CONTent:RESU?')
return Conversions.str_to_scalar_enum(response, enums.PwrReportContent)
[docs]
def set_resu(self, content_results: enums.PwrReportContent) -> None:
"""
``POWer:REPort:CONTent:RESU`` \n
Snippet: ``driver.power.report.content.set_resu(content_results = enums.PwrReportContent.ALWAYS)`` \n
Sets how often the respective content is shown in the final report.
:param content_results: ALWAYS | NEVER | ONCE
"""
param = Conversions.enum_scalar_to_str(content_results, enums.PwrReportContent)
self._core.io.write(f'POWer:REPort:CONTent:RESU {param}')