from typing import List
from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Utilities import trim_str_response
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DsSimulationCls:
"""
| Commands in total: 84
| Subgroups: 4
| Direct child commands: 5
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("dsSimulation", core, parent)
@property
def create(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_create'):
from .Create import CreateCls
self._create = CreateCls(self._core, self._cmd_group)
return self._create
@property
def shiptoship(self):
"""
| Commands in total: 18
| Subgroups: 3
| Direct child commands: 4
"""
if not hasattr(self, '_shiptoship'):
from .Shiptoship import ShiptoshipCls
self._shiptoship = ShiptoshipCls(self._core, self._cmd_group)
return self._shiptoship
@property
def towerToAir(self):
"""
| Commands in total: 21
| Subgroups: 7
| Direct child commands: 4
"""
if not hasattr(self, '_towerToAir'):
from .TowerToAir import TowerToAirCls
self._towerToAir = TowerToAirCls(self._core, self._cmd_group)
return self._towerToAir
@property
def user(self):
"""
| Commands in total: 39
| Subgroups: 4
| Direct child commands: 0
"""
if not hasattr(self, '_user'):
from .User import UserCls
self._user = UserCls(self._core, self._cmd_group)
return self._user
[docs]
def get_catalog(self) -> List[str]:
"""
``[SOURce<HW>]:FSIMulator:DSSimulation:CATalog`` \n
Snippet: ``value: List[str] = driver.source.fsimulator.dsSimulation.get_catalog()`` \n
No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:FSIMulator:DSSimulation:CATalog?')
return Conversions.str_to_str_list(response)
# noinspection PyTypeChecker
[docs]
def get_load(self) -> str:
"""
``[SOURce<HW>]:FSIMulator:DSSimulation:LOAD`` \n
Snippet: ``value: str = driver.source.fsimulator.dsSimulation.get_load()`` \n
No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:FSIMulator:DSSimulation:LOAD?')
return trim_str_response(response)
[docs]
def set_load(self, scenario_file: str) -> None:
"""
``[SOURce<HW>]:FSIMulator:DSSimulation:LOAD`` \n
Snippet: ``driver.source.fsimulator.dsSimulation.set_load(scenario_file = 'abc')`` \n
No help available
"""
param = Conversions.value_to_quoted_str(scenario_file)
self._core.io.write(f'SOURce<HwInstance>:FSIMulator:DSSimulation:LOAD {param}')
[docs]
def get_save(self) -> str:
"""
``[SOURce<HW>]:FSIMulator:DSSimulation:SAVE`` \n
Snippet: ``value: str = driver.source.fsimulator.dsSimulation.get_save()`` \n
No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:FSIMulator:DSSimulation:SAVE?')
return trim_str_response(response)
[docs]
def set_save(self, scenario_file: str) -> None:
"""
``[SOURce<HW>]:FSIMulator:DSSimulation:SAVE`` \n
Snippet: ``driver.source.fsimulator.dsSimulation.set_save(scenario_file = 'abc')`` \n
No help available
"""
param = Conversions.value_to_quoted_str(scenario_file)
self._core.io.write(f'SOURce<HwInstance>:FSIMulator:DSSimulation:SAVE {param}')
# noinspection PyTypeChecker
[docs]
def get_scenario(self) -> enums.FadDssScen:
"""
``[SOURce<HW>]:FSIMulator:DSSimulation:SCENario`` \n
Snippet: ``value: enums.FadDssScen = driver.source.fsimulator.dsSimulation.get_scenario()`` \n
No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:FSIMulator:DSSimulation:SCENario?')
return Conversions.str_to_scalar_enum(response, enums.FadDssScen)
[docs]
def set_scenario(self, scenario: enums.FadDssScen) -> None:
"""
``[SOURce<HW>]:FSIMulator:DSSimulation:SCENario`` \n
Snippet: ``driver.source.fsimulator.dsSimulation.set_scenario(scenario = enums.FadDssScen.SHIPtoship)`` \n
No help available
"""
param = Conversions.enum_scalar_to_str(scenario, enums.FadDssScen)
self._core.io.write(f'SOURce<HwInstance>:FSIMulator:DSSimulation:SCENario {param}')
def clone(self) -> 'DsSimulationCls':
"""
Clones the group by creating new object from it and its whole existing subgroups.
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group.
"""
new_group = DsSimulationCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group