Jump to content

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

From Flowcode Help
No edit summary
No edit summary
Line 17: Line 17:
==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 download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/DSP_Output.fcfx FC_Comp_Source_temp/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_temp/DSP_Output.fcfx FC_Comp_Source_temp/DSP_Output.fcfx]


==Detailed description==
==Detailed description==
Line 73: Line 73:


''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''




Line 81: Line 83:
==Macro reference==
==Macro reference==


===GetIntArray===
===GetByte===
{| 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.&nbsp;
|-
|-
| 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''
|}
 
 
===GetByteArray===
{| 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;" | '''GetByteArray'''
|-
|-
| 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.&nbsp;
| 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.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
| width="90%" | Data
|-
|-
Line 105: Line 121:




===GetLongArray===
===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;" | '''GetLongArray'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloat'''
|-
|-
| 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.&nbsp;
| colspan="2" | Returns a float value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Data
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Count
|-
| colspan="2" | &nbsp;
|-
| 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''
|}
|}
Line 153: Line 159:




===GetFloat===
===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;" | '''GetFloat'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
|-
|-
| colspan="2" | Returns a float value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.&nbsp;
| colspan="2" | Returns an integer value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




===GetLong===
===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;" | '''GetLong'''
| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Data
|-
| colspan="2" | &nbsp;
|-
|-
| colspan="2" | Returns a long value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.&nbsp;
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Count
|-
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| 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''
|}
|}




===GetInt===
===GetLong===
{| 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;" | '''GetLong'''
|-
|-
| colspan="2" | Returns an integer value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.&nbsp;
| colspan="2" | Returns a long value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.&nbsp;
|-
|-
|-
|-
| 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-u32-icon.png]] - ULONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




===GetByteArray===
===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;" | '''GetByteArray'''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLongArray'''
|-
|-
| 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.&nbsp;
| 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.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Data
| width="90%" | Data
|-
|-
Line 215: Line 231:
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| 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''
|}
===GetByte===
{| 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.&nbsp;
|-
|-
| 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''
|}
|}

Revision as of 12:00, 3 February 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_temp/DSP_Output.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/DSP_Output.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples





Macro reference

GetByte

GetByte
Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
- BYTE Return


GetByteArray

GetByteArray
Returns an array of byte values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
- BYTE Data
 
- UINT Count
 
- VOID Return


GetFloat

GetFloat
Returns a float value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
- FLOAT Return


GetFloatArray

GetFloatArray
Returns an array of float values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
- FLOAT Data
 
- UINT Count
 
- VOID Return


GetInt

GetInt
Returns an integer value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
- UINT Return


GetIntArray

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


GetLong

GetLong
Returns a long value from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
- ULONG Return


GetLongArray

GetLongArray
Returns an array of long values from the specified buffer. Auto increments the read location if the buffer size is greater than 1. 
- ULONG Data
 
- UINT Count
 
- VOID Return



Property reference

Properties
Connect To
DSP component with output buffer to collect our data from. 
Auto Scale
Automatically scale the buffer type to the output type Yes: Provide automatic scaling No: Transfer data as is, maybe truncated