TriggeredAxes Status

Application
Force Trigger Object FT#, Force Motion Restriction Object FMR#

Description
This returns the met/not met status of the force trigger or force motion restriction when position is subject by axis.

Immediate Execution
No

Usage
FGet Object.TriggeredAxes, iVar

• Object
  Object name
  The object is specified as either of FT (numerical value), FMR (numerical value), FT (label) or FMR (label).

• iVar
  An integer variable defining the value of the property

Values
When using for force trigger object:

Bit	Results
0	Met Fx LowerLevel conditions
1	Met Fy LowerLevel conditions
2	Met Fz LowerLevel conditions
3	Met Tx LowerLevel conditions
4	Met Ty LowerLevel conditions
5	Met Tz LowerLevel conditions
6	Met Fmag LowerLevel conditions
7	Met Tmag LowerLevel conditions
8	Met Fx UpperLevel conditions
9	Met Fy UpperLevel conditions
10	Met Fz UpperLevel conditions
11	Met Tx UpperLevel conditions
12	Met Ty UpperLevel conditions
13	Met Tz UpperLevel conditions
14	Met Fmag UpperLevel conditions
15	Met Tmag UpperLevel conditions

The value of each Bit
0: Not met
1: Met

When using for force motion restriction object:

Bit	Results
0	Met PosX LowerLevel conditions
1	Met PosY LowerLevel conditions
2	Met PosZ LowerLevel conditions
3	Met Dist LowerLevel conditions
4	Met Rot LowerLevel conditions
5	Met PosX UpperLevel conditions
6	Met PosY UpperLevel conditions
7	Met PosZ UpperLevel conditions
8	Met Dist UpperLevel conditions
9	Met Rot UpperLevel conditions

The value of each Bit
0: Not met
1: Met

Detailed Explanation
This returns the met/not met status by axis for the force trigger or force motion restriction just before triggering.
For each axis of the force trigger or force motion restriction the corresponding bit is “1” when the conditions are met. The bit is “0” when not met.
However, when under the Polarity Property FG_OUT is set, the UpperLevel and LowerLevel are set to “1” or “0”.
When FG_IN is set, both the UpperLevel and LowerLevel are set to “1” when the conditions are met.
Force trigger function is used to accomplish branch processing based on the met/not met status of force in each axis.
Force motion restriction is used to accomplish branch processing based on the met/not met status of position in each axis.
When a value is acquired for an Integer variable, depending on the met/not met status, there are times when the value is negative. Int32 or Int64 type variables are recommended.

Usage Example
This is an example of branch processing based on the met/not met status of each axis for the force trigger.

Function TriggeredAxesTest
  Int64 iVar
  FCKeep FC1 Till FT1, 10
  FGet FT1.TriggeredAxes, iVar
  If (iVar And &H01) <> 0 Then
    ' The process when Fx LowerLevel conditions are met
    -
  ElseIf (iVar And &H100) <> 0 Then
    ' The process when Fx UpperLevel conditions are met
    -
  EndIf
Fend

See Also
Force Trigger Object FT#, Force Motion Restriction Object FMR#