Source code for RsFsw.Implementations.MassMemory.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:
		"""
		``MMEMory:COMMent`` \n
		Snippet: ``driver.massMemory.comment.set(comment = 'abc')`` \n
		Defines a comment for the stored settings.

		:param comment: String containing the comment.
		"""
		param = Conversions.value_to_quoted_str(comment)
		self._core.io.write(f'MMEMory:COMMent {param}')




	def get(self) -> str:
		"""
		``MMEMory:COMMent`` \n
		Snippet: ``value: str = driver.massMemory.comment.get()`` \n
		Defines a comment for the stored settings.

		:return: comment: String containing the comment.
		"""
		response = self._core.io.query_str(f'MMEMory:COMMent?')
		return trim_str_response(response)