Jump to content

Component: FCD helper (Matrix Tools): Difference between revisions

From Flowcode Help
Newer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
XML import
 
No edit summary
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix Ltd
| Matrix Ltd
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
| 1.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Matrix Tools
| Matrix Tools
|}
|}




==FCD helper component==
A helper control to query the current Flowcode definition XML file. 


==[[File:Component Icon fc3c670c_502a_418f_a123_649179752383.png|Image]] FCD helper component==
==Detailed description==
A helper control to query the current FCD file


''No detailed description exists yet for this component''


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


Line 25: Line 27:
==Downloadable macro reference==
==Downloadable macro reference==


''This component does not contain any downloadable macros''
{| 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;" | '''GetStrListItem'''
|-
| colspan="2" | Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Index
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


==Simulation macro reference==


===<span style="font-weight: normal;"><u><tt>GetStrListItem</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets a list item from a string index and a textual name
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetIntListItem'''
|-
| colspan="2" | Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Index
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


Suitable for writing to a property filter


Newline is added
{| 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;" | '''Register'''
|-
| colspan="2" | Registers a property to update when the FCD changes &nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Dest
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | PropName
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | FCDPath
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | INdex
|-
| colspan="2" | A zero based index of the path to find&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | IxAttr
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | NameAttr
|-
| 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''
|}


'''Parameters'''


:[[Variable Types|STRING]] ''Index''
{| 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;" | '''GetPropertyList'''
|-
| colspan="2" | Gets a filter list suitable for adding to a property Uses the [u]IxName[/u] as the index into the list Uses the [u]Text[/u] as the line to show in list-boxes &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | FCDPath
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Index
|-
| colspan="2" | A zero based index of the path to find&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | IxName
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|STRING]] ''Name''


{| 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;" | '''SetMarks'''
|-
| colspan="2" | Decides on the presentation of the dial&nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Marks
|-
| colspan="2" | Number of marks on the dial&nbsp;
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Subs
|-
| colspan="2" | Number of marks before a 'main' mark - can be zero&nbsp;
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | ShowNumbers
|-
| colspan="2" | True to show numbers on the dial, else false&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:[[Variable Types|STRING]]
{| 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;" | '''SetRange'''
|-
| colspan="2" | Sets the min-max range to draw on the dial Used for setting the needle&nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Start
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | End
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>GetIntListItem</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets a list item from an integer and a textual name
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLabel'''
|-
| colspan="2" | Sets the label to draw in the center of the dial&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Hi
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Lo
|-
| colspan="2" | Label to draw at the bottom&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


Suitable for writing to a property filter


Newline is added
{| 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;" | '''SetPivotPos'''
|-
| colspan="2" | Sets the position of the object the lever rotates around &nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | PositionHandle
|-
| colspan="2" | A handle to the position of the depressed location&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''
|}


'''Parameters'''


:[[Variable Types|UINT]] ''Index''
{| 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;" | '''SetAutoReset'''
|-
| colspan="2" | Sets the state of the auto-reset flag If the flag is true (it is by default) then Button Helper will reset the state of each button on stop &nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | State
|-
| colspan="2" | Set true to reset to off on sim stop, else false to retain state&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''
|}


:[[Variable Types|STRING]] ''Name''


{| 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;" | '''SetLatching'''
|-
| colspan="2" | Sets whether the button is depressed when the mouse is released&nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Enabled
|-
| 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''
|}


'''Return value'''


:[[Variable Types|STRING]]
{| 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;" | '''Unregister'''
|-
| colspan="2" | Removes the object to the list if present&nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Target
|-
| 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''
|}




===<span style="font-weight: normal;"><u><tt>Register</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Registers a property to update when the FCD changes
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovementFor'''
|-
| colspan="2" | Sets the movement in units or PI/16 steps for the button&nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Target
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Move
|-
| colspan="2" | Movement to set to, default 4&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''
|}


'''Parameters'''


:[[Variable Types|HANDLE]] ''Dest''


:[[Variable Types|STRING]] ''PropName''


:[[Variable Types|STRING]] ''FCDPath''
==Property reference==


:[[Variable Types|UINT]] ''INdex''
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::A zero based index of the path to find
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
:[[Variable Types|STRING]] ''IxAttr''
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 
|-
:[[Variable Types|STRING]] ''NameAttr''
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
'''Return value'''
|-
 
|-
:''This call does not return a value''
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
 
|-
===<span style="font-weight: normal;"><u><tt>GetPropertyList</tt></u></span>===
|}
Gets a filter list suitable for adding to a property
 
Uses the <nowiki/>[u<nowiki/>]IxName<nowiki/>[/u<nowiki/>] as the index into the list
 
Uses the <nowiki/>[u<nowiki/>]Text<nowiki/>[/u<nowiki/>] as the line to show in list-boxes
 
'''Parameters'''
 
:[[Variable Types|STRING]] ''FCDPath''
 
:[[Variable Types|UINT]] ''Index''
::A zero based index of the path to find
 
:[[Variable Types|STRING]] ''IxName''
 
:[[Variable Types|STRING]] ''Text''
 
 
'''Return value'''
 
:[[Variable Types|STRING]]
 
 
 
 
==Property reference==
''This component does not contain any properties''

Revision as of 16:14, 16 November 2021

Author Matrix Ltd
Version 1.0
Category Matrix Tools


FCD helper component

A helper control to query the current Flowcode definition XML file.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

GetStrListItem
Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added  
- STRING Index
 
- STRING Name
 
- STRING Return


GetIntListItem
Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added  
- UINT Index
 
- STRING Name
 
- STRING Return


Register
Registers a property to update when the FCD changes  
[[File:]] - Dest
 
- STRING PropName
 
- STRING FCDPath
 
- UINT INdex
A zero based index of the path to find 
- STRING IxAttr
 
- STRING NameAttr
 
- VOID Return


GetPropertyList
Gets a filter list suitable for adding to a property Uses the [u]IxName[/u] as the index into the list Uses the [u]Text[/u] as the line to show in list-boxes  
- STRING FCDPath
 
- UINT Index
A zero based index of the path to find 
- STRING IxName
 
- STRING Text
 
- STRING Return


SetMarks
Decides on the presentation of the dial 
[[File:]] - Marks
Number of marks on the dial 
[[File:]] - Subs
Number of marks before a 'main' mark - can be zero 
[[File:]] - ShowNumbers
True to show numbers on the dial, else false 
[[File:]] - Return


SetRange
Sets the min-max range to draw on the dial Used for setting the needle 
[[File:]] - Start
 
[[File:]] - End
 
[[File:]] - Return


SetLabel
Sets the label to draw in the center of the dial 
- STRING Hi
 
- STRING Lo
Label to draw at the bottom 
[[File:]] - Return


SetPivotPos
Sets the position of the object the lever rotates around  
[[File:]] - PositionHandle
A handle to the position of the depressed location 
- VOID Return


SetAutoReset
Sets the state of the auto-reset flag If the flag is true (it is by default) then Button Helper will reset the state of each button on stop  
[[File:]] - State
Set true to reset to off on sim stop, else false to retain state 
- VOID Return


SetLatching
Sets whether the button is depressed when the mouse is released 
[[File:]] - Enabled
 
- VOID Return


Unregister
Removes the object to the list if present 
[[File:]] - Target
 
- VOID Return


SetMovementFor
Sets the movement in units or PI/16 steps for the button 
[[File:]] - Target
 
[[File:]] - Move
Movement to set to, default 4 
- VOID Return



Property reference

Properties
Connections
Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_FCD_helper_(Matrix_Tools)&oldid=25061"