Difference between revisions of "MC-Basic:pls.PLSPOSITION"
(Created page with '{{MC-Basic |SHORT FORM= ''<pls>''.Ppos |SYNTAX= ''<pls>''.PlsPosition[''<index>''] = ''<PLS position>'' |AVAILABILITY= All versions |DESCRIPTION= Sets or queries individual PL…') |
m |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|SYNTAX= | |SYNTAX= | ||
| − | ''<pls>''.PlsPosition['' | + | ''<pls>''.PlsPosition[<''index''>] = ''<PLS position>'' |
|AVAILABILITY= | |AVAILABILITY= | ||
| Line 10: | Line 10: | ||
|DESCRIPTION= | |DESCRIPTION= | ||
| − | Sets or queries individual PLS position values. | + | Sets or queries individual PLS position values. <br> |
| − | PLS positions are given in user units and are affected by | + | 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. <br> |
| + | An unlimited number of PLS positions can be defined, but the array must be monotonic increasing. <br> | ||
| + | |||
| + | 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.<br> | ||
| + | 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. | ||
|TYPE= | |TYPE= | ||
| Line 18: | Line 22: | ||
|RANGE= | |RANGE= | ||
| − | '' | + | <''index''>: 1 to the size of PLS data structure<br> |
| − | ''<PLS position>'': | + | ''<PLS position>'': ± MaxDouble |
|UNITS= | |UNITS= | ||
| − | + | Axis position units. | |
|DEFAULT= | |DEFAULT= | ||
| Line 31: | Line 35: | ||
|LIMITATIONS= | |LIMITATIONS= | ||
| − | + | Can be set only when PLS is disabled. | |
|EXAMPLE= | |EXAMPLE= | ||
| Line 37: | Line 41: | ||
|SEE ALSO= | |SEE ALSO= | ||
| − | * [[ | + | * [[MC-Basic:COMMON SHARED ... AS PLS|COMMON SHARED ... AS PLS]] |
| − | * [[ | + | * [[MC-Basic:CREATEPLSDATA|CREATEPLSDATA]] |
}} | }} | ||
Latest revision as of 14:11, 10 October 2018
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