HsTrain
SCPI Commands :
[SOURce<HW>]:FSIMulator:HSTRain:FDOPpler
[SOURce<HW>]:FSIMulator:HSTRain:KFACtor
[SOURce<HW>]:FSIMulator:HSTRain:PROFile
[SOURce<HW>]:FSIMulator:HSTRain:SOFFset
[SOURce<HW>]:FSIMulator:HSTRain:SPEed
[SOURce<HW>]:FSIMulator:HSTRain:STATe
- Commands in total: 11Subgroups: 3Direct child commands: 6
- get_fdoppler() float[source]
# [SOURce<HW>]:FSIMulator:HSTRain:FDOPpler value: float = driver.source.fsimulator.hsTrain.get_fdoppler()
Queries the maximum Doppler Shift for the selected configuration.
- Returns:
fdoppler: float Range: 0 to depends on settings
- get_kfactor() float[source]
# [SOURce<HW>]:FSIMulator:HSTRain:KFACtor value: float = driver.source.fsimulator.hsTrain.get_kfactor()
Sets the Rician factor K for high-speed train scenario 2.
- Returns:
kfactor: float Range: -30 to 30
- get_profile() FadingProfileB[source]
# [SOURce<HW>]:FSIMulator:HSTRain:PROFile value: enums.FadingProfileB = driver.source.fsimulator.hsTrain.get_profile()
Determines the fading profile for the selected scenario. The fading profile determines which transmission path is simulated.
- Returns:
profile: SPATh | PDOPpler | RAYLeigh
- get_soffset() float[source]
# [SOURce<HW>]:FSIMulator:HSTRain:SOFFset value: float = driver.source.fsimulator.hsTrain.get_soffset()
Shifts the high speed train profile in time. The maximum possible shift is calculated as max = 2``*DS``/v ,where:
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
- Returns:
start_offset: float Range: 0 to 429.49672950
- get_speed() float[source]
# [SOURce<HW>]:FSIMulator:HSTRain:SPEed value: float = driver.source.fsimulator.hsTrain.get_speed()
Sets the velocity parameter , i.e. the speed of the moving receiver in m/s.
- Returns:
speed: float Range: 0.001 to depends on settings
- get_state() bool[source]
# [SOURce<HW>]:FSIMulator:HSTRain:STATe value: bool = driver.source.fsimulator.hsTrain.get_state()
Activates/deactivates simulation of High Speed Train propagation according to the selected scenario 1 or 3.
- Returns:
state: 1 | ON | 0| OFF
- set_kfactor(kfactor: float) None[source]
# [SOURce<HW>]:FSIMulator:HSTRain:KFACtor driver.source.fsimulator.hsTrain.set_kfactor(kfactor = 1.0)
Sets the Rician factor K for high-speed train scenario 2.
- Parameters:
kfactor – float Range: -30 to 30
- set_profile(profile: FadingProfileB) None[source]
# [SOURce<HW>]:FSIMulator:HSTRain:PROFile driver.source.fsimulator.hsTrain.set_profile(profile = enums.FadingProfileB.BELLindoor)
Determines the fading profile for the selected scenario. The fading profile determines which transmission path is simulated.
- Parameters:
profile – SPATh | PDOPpler | RAYLeigh
- set_soffset(start_offset: float) None[source]
# [SOURce<HW>]:FSIMulator:HSTRain:SOFFset driver.source.fsimulator.hsTrain.set_soffset(start_offset = 1.0)
Shifts the high speed train profile in time. The maximum possible shift is calculated as max = 2``*DS``/v ,where:
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
- Parameters:
start_offset – float Range: 0 to 429.49672950
- set_speed(speed: float) None[source]
# [SOURce<HW>]:FSIMulator:HSTRain:SPEed driver.source.fsimulator.hsTrain.set_speed(speed = 1.0)
Sets the velocity parameter , i.e. the speed of the moving receiver in m/s.
- Parameters:
speed – float Range: 0.001 to depends on settings
- set_state(state: bool) None[source]
# [SOURce<HW>]:FSIMulator:HSTRain:STATe driver.source.fsimulator.hsTrain.set_state(state = False)
Activates/deactivates simulation of High Speed Train propagation according to the selected scenario 1 or 3.
- Parameters:
state – 1 | ON | 0| OFF
Cloning the Group
# Create a copy of the original group, that exists independently
hsTrain_copy = driver.source.fsimulator.hsTrain.clone()
Subgroups