Source code for RsFsw.Implementations.Sense.Correction.Transducer.Comment

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 CommentCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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



	def set(self, comment: str) -> None:
		"""
		``[SENSe]:CORRection:TRANsducer:COMMent`` \n
		Snippet: ``driver.sense.correction.transducer.comment.set(comment = 'abc')`` \n
		This command defines the comment for the selected transducer factor. Before you can use the command, you have to select
		and turn on a transducer.

		"""
		param = Conversions.value_to_quoted_str(comment)
		self._core.io.write(f'SENSe:CORRection:TRANsducer:COMMent {param}')




	def get(self) -> str:
		"""
		``[SENSe]:CORRection:TRANsducer:COMMent`` \n
		Snippet: ``value: str = driver.sense.correction.transducer.comment.get()`` \n
		This command defines the comment for the selected transducer factor. Before you can use the command, you have to select
		and turn on a transducer.

		"""
		response = self._core.io.query_str(f'SENSe:CORRection:TRANsducer:COMMent?')
		return trim_str_response(response)