Difference between revisions of "API Connection.SetAn"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Sets an analog value from its index, range 0->1
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAn'''
 +
|-
 +
| colspan="2" | Sets an analog value from its index, range 0->1&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-f32-icon.png]] - FLOAT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Value to set, 0 to 1 if BitDivide is false&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | BitDivide
 +
|-
 +
| colspan="2" | Set to write 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-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|UINT]] ChannelIx''
 
−
:The zero-based index of the analog channel
 
  
−
''[[Variable types|FLOAT]] Value''
 
−
:Value to set, 0 to 1 if BitDivide is false
 
  
−
''[[Variable types|BOOL]] BitDivide''
 
−
:Set to write the analog value as a full-width reading for the selected device
 
  
−
===Return value===
+
==Examples==
−
[[Variable types|BOOL]]
+
===Calling in a calculation===
−
 
 
−
No additional information
 
−
 
 
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
−
* Add to a calculation icon: <pre class="brush:[C]">result = ::Connection.SetAn(channelix, value, false)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Connection.SetAn(channelix, value, false)</pre>

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png SetAn
Sets an analog value from its index, range 0->1 
Fc9-u16-icon.png - UINT ChannelIx
The zero-based index of the analog channel 
Fc9-f32-icon.png - FLOAT Value
Value to set, 0 to 1 if BitDivide is false 
Fc9-bool-icon.png - BOOL BitDivide
Set to write the analog value as a full-width reading for the selected device 
Fc9-bool-icon.png - BOOL Return


Detailed description

Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon: 
    result = ::Connection.SetAn(channelix, value, false)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Connection.SetAn&oldid=30264"