Difference between revisions of "API Connection.GetAn"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Gets an analog value from its channel index
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAn'''
 +
|-
 +
| colspan="2" | Gets an analog value from its channel index&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | ChannelIx
 +
|-
 +
| colspan="2" | The zero-based index of the analog channel&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Connection|Connection]]
 
−
:[[API Connection|GetAn]]
 
−
</div>
 
−
__TOC__
 
−
 
−
==Parameters==
 
−
[[Variable types|UINT]] ''ChannelIx''
 
−
:The zero-based index of the analog channel
 
−
 
−
[[Variable types|BOOL]] ''BitMult''
 
−
:Set to read the analog value as a full-width reading for the selected device
 
  
 +
==Detailed description==
  
−
==Return value==
 
−
[[Variable types|FLOAT]]
 
−
''<span style="color:red;">No additional information</span>''
 
−
 
−
 
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 30: Line 30:
 
* Declare a variable 'result' of type FLOAT
 
* Declare a variable 'result' of type FLOAT
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.GetAn(channelix, true)</pre>
−
 
−
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetAn
Gets an analog value from its channel index 
Fc9-u16-icon.png - UINT ChannelIx
The zero-based index of the analog channel 
Fc9-bool-icon.png - BOOL BitMult
Set to read the analog value as a full-width reading for the selected device 
Fc9-f32-icon.png - 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)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Connection.GetAn&oldid=30263"