AXY:MC-Basic:axis.ISSETTLED

From SoftMC-Wiki
Revision as of 17:41, 16 March 2014 by Lisa (talk | contribs) (Text replace - "''<axis>''" to "<''axis''>")
Jump to: navigation, search

This flag indicates whether the actual axis position is within the specified settling range. The settling range is defined by the PESETTLE property and is further qualified by the TIMESETTLE and TIMESETTLEMAX properties. When the motion profiler has completed, the absolute value of the position error (Position - Actual Position) is compared to the PESETTLE property. When the result is less than or equal to this property, for a time given by TIMESETTLE, the ISSETTLED flag is set. The TIMESETTLEMAX property sets a limit on the time to settle from the time the profiler has completed.
       0 = Not In position
       1 = In position

Syntax

?<axis>.IsSettled

Availability

All versions

Type

Long

Range

0 or 1

Scope

Configuration, Task or Terminal

Limitations

Read-Only

This property is not relevant for a Slave axis (Gear or CAM), since this type of axis is not subject to its own motion profile. Querying it on a slaved axis returns 0.

Examples

?Xaxis.IsSettled

See Also