[docs]classHsTrainCls:"""HsTrain commands group definition. 11 total commands, 3 Subgroups, 6 group commands"""def__init__(self,core:Core,parent):self._core=coreself._cmd_group=CommandsGroup("hsTrain",core,parent)@propertydefdistance(self):"""distance commands group. 0 Sub-classes, 2 commands."""ifnothasattr(self,'_distance'):from.DistanceimportDistanceClsself._distance=DistanceCls(self._core,self._cmd_group)returnself._distance@propertydefdownlink(self):"""downlink commands group. 1 Sub-classes, 0 commands."""ifnothasattr(self,'_downlink'):from.DownlinkimportDownlinkClsself._downlink=DownlinkCls(self._core,self._cmd_group)returnself._downlink@propertydefpath(self):"""path commands group. 0 Sub-classes, 1 commands."""ifnothasattr(self,'_path'):from.PathimportPathClsself._path=PathCls(self._core,self._cmd_group)returnself._path
[docs]defget_fdoppler(self)->float:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:FDOPpler \n Snippet: value: float = driver.source.fsimulator.hsTrain.get_fdoppler() \n Queries the maximum Doppler Shift for the selected configuration. \n :return: fdoppler: float Range: 0 to depends on settings """response=self._core.io.query_str('SOURce<HwInstance>:FSIMulator:HSTRain:FDOPpler?')returnConversions.str_to_float(response)
[docs]defget_kfactor(self)->float:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:KFACtor \n Snippet: value: float = driver.source.fsimulator.hsTrain.get_kfactor() \n Sets the Rician factor K for high-speed train scenario 2. \n :return: kfactor: float Range: -30 to 30 """response=self._core.io.query_str('SOURce<HwInstance>:FSIMulator:HSTRain:KFACtor?')returnConversions.str_to_float(response)
[docs]defset_kfactor(self,kfactor:float)->None:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:KFACtor \n Snippet: driver.source.fsimulator.hsTrain.set_kfactor(kfactor = 1.0) \n Sets the Rician factor K for high-speed train scenario 2. \n :param kfactor: float Range: -30 to 30 """param=Conversions.decimal_value_to_str(kfactor)self._core.io.write(f'SOURce<HwInstance>:FSIMulator:HSTRain:KFACtor {param}')
# noinspection PyTypeChecker
[docs]defget_profile(self)->enums.FadingProfileB:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:PROFile \n Snippet: value: enums.FadingProfileB = driver.source.fsimulator.hsTrain.get_profile() \n Determines the fading profile for the selected scenario. The fading profile determines which transmission path is simulated. \n :return: profile: SPATh| PDOPpler| RAYLeigh """response=self._core.io.query_str('SOURce<HwInstance>:FSIMulator:HSTRain:PROFile?')returnConversions.str_to_scalar_enum(response,enums.FadingProfileB)
[docs]defset_profile(self,profile:enums.FadingProfileB)->None:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:PROFile \n Snippet: driver.source.fsimulator.hsTrain.set_profile(profile = enums.FadingProfileB.BELLindoor) \n Determines the fading profile for the selected scenario. The fading profile determines which transmission path is simulated. \n :param profile: SPATh| PDOPpler| RAYLeigh """param=Conversions.enum_scalar_to_str(profile,enums.FadingProfileB)self._core.io.write(f'SOURce<HwInstance>:FSIMulator:HSTRain:PROFile {param}')
[docs]defget_soffset(self)->float:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:SOFFset \n Snippet: value: float = driver.source.fsimulator.hsTrain.get_soffset() \n Shifts the high speed train profile in time. INTRO_CMD_HELP: The maximum possible shift is calculated as max = 2*DS/v ,where: \n - DS is the distance in meters between the train and the BS at the beginning of the simulation - v is the velocity of the train in m/s \n :return: start_offset: float Range: 0 to 429.49672950 """response=self._core.io.query_str('SOURce<HwInstance>:FSIMulator:HSTRain:SOFFset?')returnConversions.str_to_float(response)
[docs]defset_soffset(self,start_offset:float)->None:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:SOFFset \n Snippet: driver.source.fsimulator.hsTrain.set_soffset(start_offset = 1.0) \n Shifts the high speed train profile in time. INTRO_CMD_HELP: The maximum possible shift is calculated as max = 2*DS/v ,where: \n - DS is the distance in meters between the train and the BS at the beginning of the simulation - v is the velocity of the train in m/s \n :param start_offset: float Range: 0 to 429.49672950 """param=Conversions.decimal_value_to_str(start_offset)self._core.io.write(f'SOURce<HwInstance>:FSIMulator:HSTRain:SOFFset {param}')
[docs]defget_speed(self)->float:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:SPEed \n Snippet: value: float = driver.source.fsimulator.hsTrain.get_speed() \n Sets the velocity parameter , i.e. the speed of the moving receiver in m/s. \n :return: speed: float Range: 0.001 to depends on settings """response=self._core.io.query_str('SOURce<HwInstance>:FSIMulator:HSTRain:SPEed?')returnConversions.str_to_float(response)
[docs]defset_speed(self,speed:float)->None:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:SPEed \n Snippet: driver.source.fsimulator.hsTrain.set_speed(speed = 1.0) \n Sets the velocity parameter , i.e. the speed of the moving receiver in m/s. \n :param speed: float Range: 0.001 to depends on settings """param=Conversions.decimal_value_to_str(speed)self._core.io.write(f'SOURce<HwInstance>:FSIMulator:HSTRain:SPEed {param}')
[docs]defget_state(self)->bool:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:STATe \n Snippet: value: bool = driver.source.fsimulator.hsTrain.get_state() \n Activates/deactivates simulation of High Speed Train propagation according to the selected scenario 1 or 3. \n :return: state: 1| ON| 0| OFF """response=self._core.io.query_str('SOURce<HwInstance>:FSIMulator:HSTRain:STATe?')returnConversions.str_to_bool(response)
[docs]defset_state(self,state:bool)->None:"""SCPI: [SOURce<HW>]:FSIMulator:HSTRain:STATe \n Snippet: driver.source.fsimulator.hsTrain.set_state(state = False) \n Activates/deactivates simulation of High Speed Train propagation according to the selected scenario 1 or 3. \n :param state: 1| ON| 0| OFF """param=Conversions.bool_to_str(state)self._core.io.write(f'SOURce<HwInstance>:FSIMulator:HSTRain:STATe {param}')
defclone(self)->'HsTrainCls':"""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=HsTrainCls(self._core,self._cmd_group.parent)self._cmd_group.synchronize_repcaps(new_group)returnnew_group