MC-Basic:element.ISSETTLED

From SoftMC-Wiki
Revision as of 02:35, 27 September 2017 by Chi (talk | contribs)
Jump to: navigation, search
Language: [[::MC-Basic:element.ISSETTLED|English]]  • [[::MC-Basic:element.ISSETTLED/zh-hans|中文(简体)‎]]

This flag indicates whether the actual element position is within the specified settling range. The settling range is defined by the PESETTLE property and is further qualified by the TIMESETTLE property.
When the motion profiler has completed, the absolute value of the position error (Target Position - Actual Position) is compared to the PESETTLE property. When the the result is less than or equal to this property for the 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


This property is not relevant moving frame tracking. The return value in this cases is 0

Syntax

?<element>.IsSettled

Availability

All versions

Type

Long

Range

0 or 1

Scope

Configuration, Task or Terminal

Limitations

  • Read only.
  • Not relevant for a slave axis (gear or cam), since this type of element is not subject to its own motion profile. Querying it on a slave axis returns 0.

Examples

Axis
?A1.IsSettled

Group
?G1.IsSettled

See Also