MC-Basic:pls.PLSPOSITION

From SoftMC-Wiki
Jump to: navigation, search

Sets or queries individual PLS position values.

When a PLS is first defined, it does not have any associated positions. The CreatePLSData command is used to define the values for the PLS positions.
An unlimited number of PLS positions can be defined, but the array must be monotonic increasing.

PLS position values are always absolute (and not incremental). PLS positions are given in user units, and as such are affected by axis Displacement and PositionFactor properties.
PLS positions units are dependent upon the type of position defined by PLSSource. For example, if PLSSource type is PlsPercentage, the units are percentage. If PLSSource type is PlsTime the units are milliseconds.

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

Axis position units.

Default

0 (after the PLS data structure has been created)

Scope

Configuration, Task or Terminal

Limitations

Can be set only when PLS is disabled.

Examples

PLS1.PlsPosition[5] = 2076.56

See Also