Source code for rsrtx.Implementations.Mtest.Result.State

from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import enums


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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

	# noinspection PyTypeChecker
[docs] def get(self, mask_test: str) -> enums.MtestResultState: """ ``MTESt:RESult:STATe`` \n Snippet: ``value: enums.MtestResultState = driver.mtest.result.state.get(mask_test = 'abc')`` \n Shows if the test is running or has finished. The state is set to Finished if no acquisitions remain (see method ``RsRtx.mtest.result.count.remaining.get()`` ) . :return: state: RUNNing | FINished """ param = Conversions.value_to_quoted_str(mask_test) response = self._core.io.query_str_with_opc(f'MTESt:RESult:STATe? {param}') return Conversions.str_to_scalar_enum(response, enums.MtestResultState)