Source code for RsSmw.Implementations.System.Profiling.HwAccess

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

[docs]class HwAccessCls:
	"""HwAccess commands group definition. 3 total commands, 0 Subgroups, 3 group commands"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("hwAccess", core, parent)


[docs]	def get_description(self) -> str:
		"""SCPI: SYSTem:PROFiling:HWACcess:DESCription \n
		Snippet: value: str = driver.system.profiling.hwAccess.get_description() \n
		No command help available \n
			:return: description: No help available
		"""
		response = self._core.io.query_str('SYSTem:PROFiling:HWACcess:DESCription?')
		return trim_str_response(response)



[docs]	def get_pduration(self) -> int:
		"""SCPI: SYSTem:PROFiling:HWACcess:PDURation \n
		Snippet: value: int = driver.system.profiling.hwAccess.get_pduration() \n
		No command help available \n
			:return: duration_us: No help available
		"""
		response = self._core.io.query_str('SYSTem:PROFiling:HWACcess:PDURation?')
		return Conversions.str_to_int(response)



[docs]	def set_pduration(self, duration_us: int) -> None:
		"""SCPI: SYSTem:PROFiling:HWACcess:PDURation \n
		Snippet: driver.system.profiling.hwAccess.set_pduration(duration_us = 1) \n
		No command help available \n
			:param duration_us: No help available
		"""
		param = Conversions.decimal_value_to_str(duration_us)
		self._core.io.write(f'SYSTem:PROFiling:HWACcess:PDURation {param}')



[docs]	def get_state(self) -> bool:
		"""SCPI: SYSTem:PROFiling:HWACcess:STATe \n
		Snippet: value: bool = driver.system.profiling.hwAccess.get_state() \n
		No command help available \n
			:return: state: No help available
		"""
		response = self._core.io.query_str('SYSTem:PROFiling:HWACcess:STATe?')
		return Conversions.str_to_bool(response)



[docs]	def set_state(self, state: bool) -> None:
		"""SCPI: SYSTem:PROFiling:HWACcess:STATe \n
		Snippet: driver.system.profiling.hwAccess.set_state(state = False) \n
		No command help available \n
			:param state: No help available
		"""
		param = Conversions.bool_to_str(state)
		self._core.io.write(f'SYSTem:PROFiling:HWACcess:STATe {param}')