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
class HsTrainCls[source]

HsTrain commands group definition. 11 total commands, 3 Subgroups, 6 group commands

get_fdoppler() float[source]
# SCPI: [SOURce<HW>]:FSIMulator:HSTRain:FDOPpler
value: float = driver.source.fsimulator.hsTrain.get_fdoppler()

Queries the maximum Doppler Shift for the selected configuration.

return

fdoppler: float Range: 0 to depends on settings

get_kfactor() float[source]
# SCPI: [SOURce<HW>]:FSIMulator:HSTRain:KFACtor
value: float = driver.source.fsimulator.hsTrain.get_kfactor()

Sets the Rician factor K for high speed train scenario 2.

return

kfactor: float Range: -30 to 30

get_profile() RsSmw.enums.FadingProfileB[source]
# SCPI: [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.

return

profile: SPATh| PDOPpler| RAYLeigh

get_soffset() float[source]
# SCPI: [SOURce<HW>]:FSIMulator:HSTRain:SOFFset
value: float = driver.source.fsimulator.hsTrain.get_soffset()
Shifts the high speed train profile in time.

INTRO_CMD_HELP: 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

return

start_offset: float Range: 0 to 429.49672950

get_speed() float[source]
# SCPI: [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.

return

speed: float Range: 0.001 to depends on settings

get_state() bool[source]
# SCPI: [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.

return

state: 1| ON| 0| OFF

set_kfactor(kfactor: float) None[source]
# SCPI: [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.

param kfactor

float Range: -30 to 30

set_profile(profile: RsSmw.enums.FadingProfileB) None[source]
# SCPI: [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.

param profile

SPATh| PDOPpler| RAYLeigh

set_soffset(start_offset: float) None[source]
# SCPI: [SOURce<HW>]:FSIMulator:HSTRain:SOFFset
driver.source.fsimulator.hsTrain.set_soffset(start_offset = 1.0)
Shifts the high speed train profile in time.

INTRO_CMD_HELP: 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

param start_offset

float Range: 0 to 429.49672950

set_speed(speed: float) None[source]
# SCPI: [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.

param speed

float Range: 0.001 to depends on settings

set_state(state: bool) None[source]
# SCPI: [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.

param state

1| ON| 0| OFF

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.source.fsimulator.hsTrain.clone()

Subgroups