KangarooChannel.SI Method

KangarooChannelSI Method

Kangaroo Library for .NET

Moves at a particular speed, incremental from the current speed. This is useful for cruise control: a negative increment will slow down, a positive increment will speed up, and a zero increment will hold the current speed.

Namespace: DimensionEngineering.Kangaroo
Assembly: DimensionEngineering.Kangaroo (in DimensionEngineering.Kangaroo.dll) Version: 1.0.5.0 (1.0.5.0)

Syntax

C++

Copy

public KangarooMonitor SI(
	int velocityIncrement,
	int rampLimit = -1,
	KangarooMoveFlags flags = KangarooMoveFlags.Default
)

Public Function SI ( 
	velocityIncrement As Integer,
	Optional rampLimit As Integer = -1,
	Optional flags As KangarooMoveFlags = KangarooMoveFlags.Default
) As KangarooMonitor

public:
KangarooMonitor^ SI(
	int velocityIncrement, 
	int rampLimit = -1, 
	KangarooMoveFlags flags = KangarooMoveFlags::Default
)

member SI : 
        velocityIncrement : int * 
        ?rampLimit : int * 
        ?flags : KangarooMoveFlags 
(* Defaults:
        let _rampLimit = defaultArg rampLimit -1
        let _flags = defaultArg flags KangarooMoveFlags.Default
*)
-> KangarooMonitor

Parameters

velocityIncrement: Type: SystemInt32
The amount to increment the current speed by.
rampLimit (Optional): Type: SystemInt32
The max rate at which to change the commanded speed.
flags (Optional): Type: DimensionEngineering.KangarooKangarooMoveFlags
Modifiers for the move command.

Return Value

Type: KangarooMonitor
A KangarooMonitor for tracking the move request.

Reference

KangarooChannel Class

DimensionEngineering.Kangaroo Namespace