Difference between revisions of "Component: Circular Buffer (Float) (Buffer)"
From Flowcode Help
Jump to navigationJump to searchLine 52: | Line 52: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
+ | |||
+ | |||
Line 57: | Line 59: | ||
==Macro reference== | ==Macro reference== | ||
+ | ===WaitForValues=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 90: | Line 93: | ||
+ | ===GetNumberValues=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 103: | Line 107: | ||
+ | ===PeekData=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 116: | Line 121: | ||
+ | ===PutData=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 134: | Line 140: | ||
+ | ===LookForValues=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 167: | Line 174: | ||
+ | ===GetData=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 180: | Line 188: | ||
+ | ===FlushBuffer=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 193: | Line 202: | ||
+ | ===GetIndexedValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- |
Revision as of 11:48, 3 February 2023
Author | Matrix Ltd |
Version | 1.5 |
Category | Buffer |
Contents
Circular Buffer (Float) component
Circular buffer component allowing easy and efficient first in first out (FIFO) style data storage. Also features macros to allow you to check for specific floating point values.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_CircularBufferFloat.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_CircularBufferFloat.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
WaitForValues
GetNumberValues
GetNumberValues | |
Returns the number of valid 16-bit data values currently stored inside the buffer. | |
- UINT | Return |
PeekData
PeekData | |
Reads the next available 16-bit data value from the circular buffer without advancing the current index, Returns the default value if the buffer is empty. | |
- FLOAT | Return |
PutData
LookForValues
GetData
GetData | |
Reads the next available 32-bit floating point value from the circular buffer, Returns the default value if the buffer is empty. | |
- FLOAT | Return |
FlushBuffer
FlushBuffer | |
Clears the contents of the buffer and re-initialises the index locations. | |
- VOID | Return |
GetIndexedValue
GetIndexedValue | |
Gets the value of a single 32-bit floating point value at a known location in the buffer. Leaves the buffer contents and pointers untouched. | |
- UINT | address |
- FLOAT | Return |