from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.Utilities import trim_str_response
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DescriptionCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("description", core, parent)
[docs]
def set(self, description: str) -> None:
"""
``HCOPy:TREPort:DESCription`` \n
Snippet: ``driver.hardCopy.treport.description.set(description = 'abc')`` \n
This command defines the description of the test report as shown on its title page.
:param description: String containing the description of the test report.
"""
param = Conversions.value_to_quoted_str(description)
self._core.io.write(f'HCOPy:TREPort:DESCription {param}')
[docs]
def get(self) -> str:
"""
``HCOPy:TREPort:DESCription`` \n
Snippet: ``value: str = driver.hardCopy.treport.description.get()`` \n
This command defines the description of the test report as shown on its title page.
:return: description: String containing the description of the test report.
"""
response = self._core.io.query_str(f'HCOPy:TREPort:DESCription?')
return trim_str_response(response)