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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/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 38: Line 40:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 58: Line 62:
  
 
==Macro reference==
 
==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''
 +
|}
 +
 +
 +
{| 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;" | '''GetInt'''
 +
|-
 +
| 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" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| 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
 +
|-
 +
| 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;" | '''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''
 +
|}
 +
 +
 +
 +
 +
==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;"

Revision as of 15:13, 20 January 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 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

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


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


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


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


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


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


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


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



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 

==Macro reference==

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


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


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


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


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


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


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


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



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=32471"