API Connection.GetAn: Difference between revisions
XML import of API auto-gen |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (19 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | |||
== | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetAn''' | |||
|- | |||
| colspan="2" | Gets an analog value from its channel index | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | ChannelIx | |||
|- | |||
| colspan="2" | The zero-based index of the analog channel | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | |||
| width="90%" | BitMult | |||
|- | |||
| colspan="2" | Set to read the analog value as a full-width reading for the selected device | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
=== | ==Detailed description== | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type FLOAT | * Declare a variable 'result' of type FLOAT | ||
* Add to a calculation icon: result = ::Connection.GetAn(channelix, true) | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre> | ||
Latest revision as of 14:11, 13 July 2026
|
GetAn |
| Gets an analog value from its channel index | |
 - UINT
|
ChannelIx |
| The zero-based index of the analog channel | |
 - BOOL
|
BitMult |
| Set to read the analog value as a full-width reading for the selected device | |
 - FLOAT
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type FLOAT
- Add to a calculation icon:
result = ::Connection.GetAn(channelix, true)