MC-Basic:pls.PLSPOSITION

From SoftMC-Wiki
Revision as of 16:00, 13 December 2010 by Arwiebe (talk | contribs) (Created page with '{{MC-Basic |SHORT FORM= ''<pls>''.Ppos |SYNTAX= ''<pls>''.PlsPosition[''<index>''] = ''<PLS position>'' |AVAILABILITY= All versions |DESCRIPTION= Sets or queries individual PL…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Sets or queries individual PLS position values. When a PLS is defined, no PLS positions exist. A PLS position data structure must be created, using the CREATEPLSDATA command. This PPOS property is used to define PLS position values.

PLS positions are given in user units and are affected by the axis displacement and position factor properties. PLS positions are always absolute position values (not incremental values). The PLS position data must be monotonic or the PLS is not enabled.

Short form

<pls>.Ppos

Syntax

<pls>.PlsPosition[<index>] = <PLS position>

Availability

All versions

Type

Double

Range

<index>: 1 to the size of PLS data structure
<PLS position>: +/- MaxDouble

Units

User axis position units, as given by <axis>.POSITIONFACTOR

Default

0 (after the PLS data structure has been created)

Scope

Configuration, Task or Terminal

Limitations

The PLS position may be set only when the PLS is disabled.

Examples

PLS1.PlsPosition[5] = 2076.56

See Also