Open Rails

MSTSTrainControlSystem Members

MSTSTrainControlSystem overview

Public Instance Constructors

MSTSTrainControlSystem Constructor Initializes a new instance of the MSTSTrainControlSystem class.

Public Instance Fields

AlerterSound (inherited from TrainControlSystem) True if alerter sound rings, otherwise false
AWSMonitor
BrakePipePressureBar (inherited from TrainControlSystem) Train brake pipe pressure. Returns float.MaxValue if no data is available.
ClockTime (inherited from AbstractScriptClass) Clock value (in seconds) for the simulation. Starts at activity start time.
CurrentPostSpeedLimitMpS (inherited from TrainControlSystem) Max allowed speed determined by current speedpost.
CurrentSignalSpeedLimitMpS (inherited from TrainControlSystem) Max allowed speed determined by current signal.
Deceleration (inherited from TrainControlSystem) (float currentSpeedMpS, float targetSpeedMpS, float distanceM) Returns the deceleration needed to decrease the speed to the target speed at the target distance
DistanceCurve (inherited from TrainControlSystem) (float currentSpeedMpS, float targetSpeedMpS, float slope, float delayS, float decelerationMpS2) Returns a distance curve based safe braking distance, unit is m
DistanceM (inherited from AbstractScriptClass) Running total of distance travelled - always positive, updated by train physics.
EmergencyCausesThrottleDown
EmergencyEngagesHorn
EmergencyStopMonitor
GetBoolParameter (inherited from TrainControlSystem) Get bool parameter in the INI file.
GetFloatParameter (inherited from TrainControlSystem) Get int parameter in the INI file.
GetIntParameter (inherited from TrainControlSystem) Get int parameter in the INI file.
GetStringParameter (inherited from TrainControlSystem) Get string parameter in the INI file.
IsAlerterEnabled (inherited from TrainControlSystem) False if vigilance monitor was switched off in game options, thus requested to be auto reset.
IsBrakeEmergency (inherited from TrainControlSystem) True if train brake controller is in emergency position, otherwise false.
IsBrakeFullService (inherited from TrainControlSystem) True if train brake controller is in full service position, otherwise false.
IsDirectionReverse (inherited from TrainControlSystem) True if train direction is reverse.
IsTrainControlEnabled (inherited from TrainControlSystem) False if train control is switched off because the train is autopiloted.
NextPostDistanceM (inherited from TrainControlSystem) Distance to next speedpost.
NextPostSpeedLimitMpS (inherited from TrainControlSystem) Max allowed speed determined by next speedpost.
NextSignalAspect (inherited from TrainControlSystem) Aspect of the next signal.
NextSignalDistanceM (inherited from TrainControlSystem) Distance to next signal.
NextSignalSpeedLimitMpS (inherited from TrainControlSystem) Max allowed speed determined by next signal.
OverspeedMonitor
PowerAuthorization (inherited from TrainControlSystem) True if circuit breaker or power contactor close authorization is true.
SetCurrentSpeedLimitMpS (inherited from TrainControlSystem) Set current speed limit of the train, as to be shown on SPEEDLIMIT cabcontrol.
SetDynamicBrakeController (inherited from TrainControlSystem) Set dynamic brake controller to position in range [0-1].
SetEmergencyBrake (inherited from TrainControlSystem) Set emergency braking on or off.
SetFullBrake (inherited from TrainControlSystem) Set train brake controller to full service position.
SetHorn (inherited from TrainControlSystem) Set horn on (true) or off (false).
SetInterventionSpeedLimitMpS (inherited from TrainControlSystem) The speed at the train control system applies brake automatically. Determines needle color (orange/red) on circular speed gauge, when the locomotive already runs above the permitted speed limit. Otherwise is unused.
SetMonitoringStatus (inherited from TrainControlSystem) Monitoring status determines the colors speeds displayed with. (E.g. circular speed gauge).
SetNextSignalAspect (inherited from TrainControlSystem) Will be whown on ASPECT_DISPLAY cabcontrol.
SetNextSpeedLimitMpS (inherited from TrainControlSystem) Set speed limit of the next signal, as to be shown on SPEEDLIM_DISPLAY cabcontrol.
SetOverspeedWarningDisplay (inherited from TrainControlSystem) Set OVERSPEED cabcontrol display on or off.
SetPantographsDown (inherited from TrainControlSystem) Cut power by pull all pantographs down.
SetPenaltyApplicationDisplay (inherited from TrainControlSystem) Set PENALTY_APP cabcontrol display on or off.
SetPowerAuthorization (inherited from TrainControlSystem) Set the circuit breaker or power contactor close authorization.
SetThrottleController (inherited from TrainControlSystem) Set throttle controller to position in range [0-1].
SetVigilanceAlarm (inherited from TrainControlSystem) Switch vigilance alarm sound on (true) or off (false).
SetVigilanceAlarmDisplay (inherited from TrainControlSystem) Set ALERTER_DISPLAY cabcontrol display's alarm state on or off.
SetVigilanceEmergencyDisplay (inherited from TrainControlSystem) Set ALERTER_DISPLAY cabcontrol display's emergency state on or off.
SpeedCurve (inherited from TrainControlSystem) (float targetDistanceM, float targetSpeedMpS, float slope, float delayS, float decelerationMpS2) Returns a speed curve based speed limit, unit is m/s
SpeedMpS (inherited from TrainControlSystem) Train's actual absolute speed.
TrainLengthM (inherited from TrainControlSystem) Train's length
TrainSpeedLimitMpS (inherited from TrainControlSystem) Max allowed speed for the train determined by consist.
TriggerSoundAlert1 (inherited from TrainControlSystem) Trigger Alert1 sound event
TriggerSoundAlert2 (inherited from TrainControlSystem) Trigger Alert2 sound event
TriggerSoundInfo1 (inherited from TrainControlSystem) Trigger Info1 sound event
TriggerSoundInfo2 (inherited from TrainControlSystem) Trigger Info2 sound event
TriggerSoundPenalty1 (inherited from TrainControlSystem) Trigger Penalty1 sound event
TriggerSoundPenalty2 (inherited from TrainControlSystem) Trigger Penalty2 sound event
TriggerSoundSystemActivate (inherited from TrainControlSystem) Trigger Activate sound event
TriggerSoundSystemDeactivate (inherited from TrainControlSystem) Trigger Deactivate sound event
TriggerSoundWarning1 (inherited from TrainControlSystem) Trigger Warning1 sound event
TriggerSoundWarning2 (inherited from TrainControlSystem) Trigger Warning2 sound event
VigilanceMonitor

Public Instance Properties

Activated (inherited from TrainControlSystem)

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type.
GetType (inherited from Object)Gets the type of the current instance.
HandleEvent
Initialize
SetEmergency
ToString (inherited from Object)Returns a string that represents the current object.
Update
UpdateInputs

Protected Instance Methods

Finalize (inherited from Object)Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

MSTSTrainControlSystem Class | ORTS Namespace