Difference between revisions of "Component: Output Digital (DSP Outputs)"

From Flowcode Help
Jump to navigationJump to search
 
(8 intermediate revisions by the same user not shown)
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Output.fcfx FC_Comp_Source_DSP_Output.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Output.fcfx FC_Comp_Source_DSP_Output.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Output.fcfx FC_Comp_Source_DSP_Output.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
  
  
Line 40: Line 48:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
  
  
Line 61: Line 75:
  
  
−
==Macro reference==
 
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIntArray'''
 
−
|-
 
−
| colspan="2" | Returns an array of integer values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Count
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLongArray'''
 
−
|-
 
−
| colspan="2" | Returns an array of long values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Count
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloatArray'''
 
−
|-
 
−
| colspan="2" | Returns an array of float values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Count
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloat'''
 
−
|-
 
−
| colspan="2" | Returns a float value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLong'''
 
−
|-
 
−
| colspan="2" | Returns a long value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
 +
 +
 +
 +
==Macro reference==
 +
 +
===GetByte===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
 
|-
 
|-
−
| colspan="2" | Returns an integer value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
+
| colspan="2" | Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===GetByteArray===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 194: Line 129:
  
  
 +
===GetFloat===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloat'''
 
|-
 
|-
−
| colspan="2" | Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
+
| colspan="2" | Returns a float value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
 
+
===GetFloatArray===
−
 
 
−
==Property reference==
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Connect To
 
−
|-
 
−
| colspan="2" | DSP component with output buffer to collect our data from. 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Auto Scale
 
−
|-
 
−
| colspan="2" | Automatically scale the buffer type to the output type Yes: Provide automatic scaling No: Transfer data as is, maybe truncated 
 
−
|}==Macro reference==
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIntArray'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloatArray'''
 
|-
 
|-
−
| colspan="2" | Returns an array of integer values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
+
| colspan="2" | Returns an array of float values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
| width="90%" | Data
 
| width="90%" | Data
 
|-
 
|-
Line 251: Line 167:
  
  
 +
===GetInt===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLongArray'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
 
|-
 
|-
−
| colspan="2" | Returns an array of long values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
+
| colspan="2" | Returns an integer value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Count
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===GetIntArray===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloatArray'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIntArray'''
 
|-
 
|-
−
| colspan="2" | Returns an array of float values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
+
| colspan="2" | Returns an array of integer values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" | Data
 
| width="90%" | Data
 
|-
 
|-
Line 297: Line 205:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===GetLong===
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloat'''
 
−
|-
 
−
| colspan="2" | Returns a float value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 323: Line 219:
  
  
 +
===GetLongArray===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLongArray'''
 
|-
 
|-
−
| colspan="2" | Returns an integer value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
+
| colspan="2" | Returns an array of long values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
 
−
 
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByteArray'''
 
−
|-
 
−
| colspan="2" | Returns an array of byte values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
 
| width="90%" | Data
 
| width="90%" | Data
 
|-
 
|-
Line 357: Line 241:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
 
−
|-
 
−
| colspan="2" | Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
  
  

Latest revision as of 10:26, 20 October 2023

Author Matrix Ltd
Version 1.2
Category DSP Outputs


Output Digital component

Allows the values from a buffer to be read. Either a value at a time or as an array.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DSP_Output.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DSP_Output.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples









Macro reference

GetByte

Fc9-comp-macro.png GetByte
Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-u8-icon.png - BYTE Return


GetByteArray

Fc9-comp-macro.png GetByteArray
Returns an array of byte values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-u8-icon.png - BYTE Data
 
Fc9-u16-icon.png - UINT Count
 
Fc9-void-icon.png - VOID Return


GetFloat

Fc9-comp-macro.png GetFloat
Returns a float value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-f32-icon.png - FLOAT Return


GetFloatArray

Fc9-comp-macro.png GetFloatArray
Returns an array of float values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-f32-icon.png - FLOAT Data
 
Fc9-u16-icon.png - UINT Count
 
Fc9-void-icon.png - VOID Return


GetInt

Fc9-comp-macro.png GetInt
Returns an integer value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-u16-icon.png - UINT Return


GetIntArray

Fc9-comp-macro.png GetIntArray
Returns an array of integer values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-u16-icon.png - UINT Data
 
Fc9-u16-icon.png - UINT Count
 
Fc9-void-icon.png - VOID Return


GetLong

Fc9-comp-macro.png GetLong
Returns a long value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-u32-icon.png - ULONG Return


GetLongArray

Fc9-comp-macro.png GetLongArray
Returns an array of long values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
Fc9-u32-icon.png - ULONG Data
 
Fc9-u16-icon.png - UINT Count
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-7-icon.png Auto Scale
Automatically scale the buffer type to the output type Yes: Provide automatic scaling No: Transfer data as is, maybe truncated 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Output_Digital_(DSP_Outputs)&oldid=39537"