Click or drag to resize

EngineStartSpeedRamp Method

Creates a task that performs a gradual engine speed increase/decrease.

Namespace:  RRAutoLib.CTC
Assembly:  RRAutoLib (in RRAutoLib.dll) Version: 4.0.8678.28884
Syntax
Copy
Public Function StartSpeedRamp ( 
	bytSpeedTarget As Byte,
	srtInterval As UShort
) As Task(Of Boolean)

Parameters

bytSpeedTarget
Type: SystemByte
The target speed that will end the ramp. Valid values are 0 to SpeedStepMax.
srtInterval
Type: SystemUInt16
Number of milliseconds to wait between each speed step. Valid values are 100-3000.

Return Value

Type: TaskBoolean
When the task is awaited, it returns True, if the speed ramp ran to it completion, or False, if it was interrupted prematurely by another process.
Remarks
Starting a speed ramp will cancel any other running speed ramp for this engine object. The ramp will start from the current speed and end with the target speed.

The engine must be bound to a command station slot prior to calling this method.
See Also