PTPBoostOK Method

Description
Returns whether or not the PTP (Point to Point) motion from a current position to a target position is a small travel distance.

Syntax
Function PTPBoostOK (PointNumber As Integer) As Boolean
Function PTPBoostOK (Point As SpelPoint) As Boolean
Function PTPBoostOK (PointExpr As String) As Boolean

Parameters
Each syntax has one parameter that specifies the target point to check.

• PointNumber
  Specifies the target point using the point number of a previously taught point in the Controller’s point memory for the current robot.
• Point
  Specifies the target point using the SpelPoint data type
• PointExpr
  Specifies the target point using a string expression

Return Value
True if PTPBoost will be used, False if not.

Remarks
If an error occurs and the ErrorNumber property of the SpelException is 3101, see the remarks in the SetPoint method.

See Also
PTPBoost Method, SetPoint Method

PTPBoostOK Example
VB Example:

If m_spel.PTPBoostOK(1) Then  
    m_spel.Go(1)  
End If  

C# Example:

if (m_spel.PTPBoostOK(1))  
	m_spel.Go(1);