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

Revision as of 09:55, 27 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 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

	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

	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

	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

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

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

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

	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

	GetByte
Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.
- BYTE	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

==Macro reference==

	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

	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

	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

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

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

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

	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

	GetByte
Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.
- BYTE	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

==Macro reference==

	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

	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

	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

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

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

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

	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

	GetByte
Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.
- BYTE	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

==Macro reference==

	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

	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

	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

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

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

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

	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

	GetByte
Returns a byte value from the specified buffer. Auto increments the read location if the buffer size is greater than 1.
- BYTE	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

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/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_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==
@@ Line 44: / Line 46: @@
 ==Examples==
@@ Line 68: / Line 72: @@
 ==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.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| 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''
+|}
+{| 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.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| 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''
+|}
+{| 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.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[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''
+|}
+{| 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.&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''
+|}
+{| 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.&nbsp;
+|-
+|-
+| 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.&nbsp;
+|-
+|-
+| 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.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
+|}
+{| 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''
+|}
+==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.&nbsp;
+|-
+| 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&nbsp;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"

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

Revision as of 09:55, 27 January 2023

Contents

Output Digital component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools