Difference between revisions of "Component: Library Component (Misc)"

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_LibraryComponent.fcfx FC_Comp_Source_LibraryComponent.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LibraryComponent.fcfx FC_Comp_Source_LibraryComponent.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 26: Line 28:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 32: Line 36:
  
 
==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;" | '''FlashRx'''
 +
|-
 +
| colspan="2" | Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up. 
 +
|-
 +
|-
 +
| 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;" | '''FlashTx'''
 +
|-
 +
| colspan="2" | Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up. 
 +
|-
 +
|-
 +
| 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;" | '''GetLinkHandle'''
 +
|-
 +
| colspan="2" | Gets the handle of the source object we are pointing to. Returns 0 for not valid. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | 0=Source, 1=Reference 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| 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;" | '''SetLinkHandle'''
 +
|-
 +
| colspan="2" | Sets the handle of the source object we are pointing to.  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | 0=Source, 1=Reference 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Handle
 +
|-
 +
| 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;" | '''SetConsoleHandle'''
 +
|-
 +
| colspan="2" | Sets the link to the component console allowing for click through and for  panel console viewer linkage. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Handle
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==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-11-icon.png]]
 +
| width="90%" | Title
 +
|-
 +
| colspan="2" | Component main title, shown in the middle of the library component. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 +
| width="90%" | Peripheral
 +
|-
 +
| colspan="2" | Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
 +
| width="90%" | Vertical Alignment
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show Comms Indicators
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Source Icon
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Input Icon
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Source Is Ref
 +
|-
 +
| colspan="2" | Moves both I/O icons to be on the right hand side. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Reference Icon
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Output Icon
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | LinkTo
 +
|-
 +
| colspan="2" |  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:16, 20 January 2023

Author MatrixTSL
Version 1.0
Category Misc


Library Component component

A simple library component designed to create a panel presence for any components that don't need or have a graphical simulation. Compatible with linking icons.

Component Source Code

Please click here to view the component source code (Beta): FC_Comp_Source_LibraryComponent.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Fc9-comp-macro.png FlashRx
Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FlashTx
Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetLinkHandle
Gets the handle of the source object we are pointing to. Returns 0 for not valid. 
Fc9-u8-icon.png - BYTE Index
0=Source, 1=Reference 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png SetLinkHandle
Sets the handle of the source object we are pointing to.  
Fc9-u8-icon.png - BYTE Index
0=Source, 1=Reference 
Fc9-h32-icon.png - HANDLE Handle
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetConsoleHandle
Sets the link to the component console allowing for click through and for panel console viewer linkage. 
Fc9-h32-icon.png - HANDLE Handle
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-11-icon.png Title
Component main title, shown in the middle of the library component. 
Fc9-type-11-icon.png Name
Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event. 
Fc9-type-11-icon.png Peripheral
Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer. 
Fc9-type-12-icon.png Vertical Alignment
 
Fc9-type-7-icon.png Show Comms Indicators
 
Fc9-conn-icon.png Source Icon
Fc9-type-16-icon.png Input Icon
 
Fc9-type-7-icon.png Source Is Ref
Moves both I/O icons to be on the right hand side. 
Fc9-conn-icon.png Reference Icon
Fc9-type-16-icon.png Output Icon
 
Fc9-type-16-icon.png LinkTo
 

==Macro reference==

Fc9-comp-macro.png FlashRx
Flashes the receive icon for a set period of time. Automatically clears the icon once time period is up. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FlashTx
Flashes the transmit icon for a set period of time. Automatically clears the icon once time period is up. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetLinkHandle
Gets the handle of the source object we are pointing to. Returns 0 for not valid. 
Fc9-u8-icon.png - BYTE Index
0=Source, 1=Reference 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png SetLinkHandle
Sets the handle of the source object we are pointing to.  
Fc9-u8-icon.png - BYTE Index
0=Source, 1=Reference 
Fc9-h32-icon.png - HANDLE Handle
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetConsoleHandle
Sets the link to the component console allowing for click through and for panel console viewer linkage. 
Fc9-h32-icon.png - HANDLE Handle
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-11-icon.png Title
Component main title, shown in the middle of the library component. 
Fc9-type-11-icon.png Name
Handle name of the component, shown at the top of the library component. Automatically populated by the parent Rename event. 
Fc9-type-11-icon.png Peripheral
Peripheral name of the component, shown at the top of the library component. Automatically populated by the CAL hardware component layer. 
Fc9-type-12-icon.png Vertical Alignment
 
Fc9-type-7-icon.png Show Comms Indicators
 
Fc9-conn-icon.png Source Icon
Fc9-type-16-icon.png Input Icon
 
Fc9-type-7-icon.png Source Is Ref
Moves both I/O icons to be on the right hand side. 
Fc9-conn-icon.png Reference Icon
Fc9-type-16-icon.png Output Icon
 
Fc9-type-16-icon.png LinkTo
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Library_Component_(Misc)&oldid=32758"