EndStatusData Result

Description
Returns a reason for end status failure in a general purpose sequence.

Usage
FGGet Sequence.EndStatusData, iVar

• Sequence
  General purpose sequence name or string variable representing general purpose sequence name

• iVar
  Integer variable that shows a returned value

Values
iVar

Bit	Results
0	Object whose AbortSeqOnFail is True failed.
1	Start position orientation (X, Y, Z, U, V, W) deviated from the specified range.
2	Starting arm orientation (Hand, Elbow, Wrist) differed from the specified arm orientation.

Detailed Explanation
Returns a reason for end status failure in a general purpose sequence.
AbortSeqOnFail is a property that specifies whether to end or continue a sequence after a force guide object has failed. If the force guide object whose AbortSeqOnFail is True fails, the general purpose sequence will also fail.
The start position/orientation (X, Y, Z, U, V, W) is checked when the PosCheckEnabled property is True.
The force guide sequence will fail if the sequence starting position/orientation deviates from the point specified by the StartCheckPoint property by an amount that exceeds the value specified by StartPntTolX in the X direction, exceeds the value specified by StartPntTolY in the Y direction, or exceeds the value specified by StartPntTolZ in the Z direction in the coordinate system specified by StartPntTolLocal, or exceeds the angle specified by StartPntTolRot in the direction of rotation. When a failure occurs, the general purpose object will not be executed.
The starting arm orientation (Hand, Elbow, Wrist) is checked when the OrientCheckEnabled property is True. The force guide sequence will fail if the sequence starting arm orientation differs from each arm orientation at a point specified by the StartCheckPoint property. In such a case, the general purpose object will not be executed.

Usage Example
The following is an example of a simple program that acquires a result with FGGet.

Function EndStatuDataTest
  Integer iVar

  Motor On

  FGRun Sequence1
  FGGet Sequence1.EndStatusData, iVar  ' Acquisition of EndStatusData
  Print iVar
Fend

See Also
FGGet, general purpose sequence