Source code for RsSmw.Implementations.Source.Fsimulator.DsSimulation.Shiptoship.Water

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


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

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

	# noinspection PyTypeChecker
[docs] def get_surface(self) -> enums.FadDssS2SwatSurfType: """ ``[SOURce<HW>]:FSIMulator:DSSimulation:SHIPtoship:WATer:SURFace`` \n Snippet: ``value: enums.FadDssS2SwatSurfType = driver.source.fsimulator.dsSimulation.shiptoship.water.get_surface()`` \n No help available """ response = self._core.io.query_str('SOURce<HwInstance>:FSIMulator:DSSimulation:SHIPtoship:WATer:SURFace?') return Conversions.str_to_scalar_enum(response, enums.FadDssS2SwatSurfType)
[docs] def set_surface(self, water_surface: enums.FadDssS2SwatSurfType) -> None: """ ``[SOURce<HW>]:FSIMulator:DSSimulation:SHIPtoship:WATer:SURFace`` \n Snippet: ``driver.source.fsimulator.dsSimulation.shiptoship.water.set_surface(water_surface = enums.FadDssS2SwatSurfType.ROUGh)`` \n No help available """ param = Conversions.enum_scalar_to_str(water_surface, enums.FadDssS2SwatSurfType) self._core.io.write(f'SOURce<HwInstance>:FSIMulator:DSSimulation:SHIPtoship:WATer:SURFace {param}')
# noinspection PyTypeChecker
[docs] def get_type_py(self) -> enums.FadDssS2SwatType: """ ``[SOURce<HW>]:FSIMulator:DSSimulation:SHIPtoship:WATer:TYPE`` \n Snippet: ``value: enums.FadDssS2SwatType = driver.source.fsimulator.dsSimulation.shiptoship.water.get_type_py()`` \n No help available """ response = self._core.io.query_str('SOURce<HwInstance>:FSIMulator:DSSimulation:SHIPtoship:WATer:TYPE?') return Conversions.str_to_scalar_enum(response, enums.FadDssS2SwatType)
[docs] def set_type_py(self, water_type: enums.FadDssS2SwatType) -> None: """ ``[SOURce<HW>]:FSIMulator:DSSimulation:SHIPtoship:WATer:TYPE`` \n Snippet: ``driver.source.fsimulator.dsSimulation.shiptoship.water.set_type_py(water_type = enums.FadDssS2SwatType.FRESh)`` \n No help available """ param = Conversions.enum_scalar_to_str(water_type, enums.FadDssS2SwatType) self._core.io.write(f'SOURce<HwInstance>:FSIMulator:DSSimulation:SHIPtoship:WATer:TYPE {param}')