Fmag_Axes Property

Application
Force Trigger Object FT#, Force Monitor Object FM#

Description
Sets or returns the subject axis to acquire the resultant force.

Immediate Execution
No

Usage
FGet Object.Fmag_Axes, iVar
FSet Object.Fmag_Axes, iValue

  • 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

  • iValue
    An integer value or formula defining the new value of the property

Values
iValue

Name of constants Values Description
FG_XYZ 0

The forces in the X, Y, and Z axes are combined. (default)

(Fmag = sqrt(Fx2 + Fy2 + Fz2) )

FG_XY 1

The forces in the X and Y-axes are combined.

(Fmag = sqrt(Fx2 + Fy2) )

FG_YZ 2

The forces in the Y and Z-axes are combined.

(Fmag = sqrt(Fy2 + Fz2) )

FG_ZX 3

The forces in the Z and X-axes are combined.

(Fmag = sqrt(Fx2 + Fz2) )

Detailed Explanation
Fmag produces a value representing the combined force from the subject axes from the X, Y, and Z axes.
This property is used when setting or checking the subject axes to obtain the resultant force.

Usage Example
This is an example of setting the subject axes to obtain the resultant force with respect to Force Monitor Object.

Function Test_Fmag_Axes
  Integer iVar
  FSet FM1.Fmag_Axes, FG_ZX
  FGet FM1.Fmag_Axes, iVar
  Print iVar
Fend

See Also
Force Trigger Object FT#, Force Monitor Object FM#