KangarooChannel.PI Method

KangarooChannelPI Method

Kangaroo Library for .NET

Makes an incremental move. This command is useful any time you want to make a motion relative to where you are right now. Rovers are a case where this is almost always what you want.

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

Syntax

C++

Copy

public KangarooMonitor PI(
	int positionIncrement,
	int speedLimit = -1,
	KangarooMoveFlags flags = KangarooMoveFlags.Default
)

Public Function PI ( 
	positionIncrement As Integer,
	Optional speedLimit As Integer = -1,
	Optional flags As KangarooMoveFlags = KangarooMoveFlags.Default
) As KangarooMonitor

public:
KangarooMonitor^ PI(
	int positionIncrement, 
	int speedLimit = -1, 
	KangarooMoveFlags flags = KangarooMoveFlags::Default
)

member PI : 
        positionIncrement : int * 
        ?speedLimit : int * 
        ?flags : KangarooMoveFlags 
(* Defaults:
        let _speedLimit = defaultArg speedLimit -1
        let _flags = defaultArg flags KangarooMoveFlags.Default
*)
-> KangarooMonitor

Parameters

positionIncrement: Type: SystemInt32
The amount to increment the current position by.
speedLimit (Optional): Type: SystemInt32
The speed limit for the move.
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