AvgForceClear Property

Application
Force Monitor Object FM#

Description
Activates/inactivates force and torque averaging simultaneously.

Immediate Execution
Yes

Usage
FSet Object. AvgForceClear, bValueFx, bValueFy, bValueFz, bValueTx, bValueTy, bValueTz [, bValueFmag, bValueTmag]

• Object
  Object name
  The object is specified as either of FM (numerical value) or FM (label).
• bValueFx
  A Boolean value or formula defining the new value of the property
• bValueFy
  A Boolean value or formula defining the new value of the property
• bValueFz
  A Boolean value or formula defining the new value of the property
• bValueTx
  A Boolean value or formula defining the new value of the property
• bValueTy
  A Boolean value or formula defining the new value of the property
• bValueTz
  A Boolean value or formula defining the new value of the property
• bValueFmag
  A Boolean value or formula defining the new value of the property
• bValueTmag
  A Boolean value or formula defining the new value of the property

Values
bValueFx, bValueFy, bValueFz, bValueTx, bValueTy, bValueTz, bValueFmag, bValueTmag

Name of Constants	Values	Description
False	0	Inactivates the subject axis. (default)
True	-1	Activates the subject axis.

Detailed Explanation
AvgForceClear activates/inactivates force and torque averaging simultaneously.
Be sure to execute AvgForceClear prior to executing AvgForces and XX_AvgForce.
Without executing AvgForceClear, “0” is returned.

Usage Example
This is an example of force averaging in the Fx axis.

Function CheckAverageForces
  Double AF(7)
  FSet FC1.Enabled, True, False, False, False, False, False
  FSet FC1.TargetForces, 10, 0, 0, 0, 0, 0
  FSet FS1.Reset
  FSet FM1.CoordinateSystem, FCS0
  FSet FM1.AvgForceClear, True, False, False, False, False, False, False, False
  FCKeep FC1, 10
  FGet FM1.AvgForces, AF()
  Print AF(FG_FX)
Fend

See Also
Force Monitor Object FM#