Difference between revisions of "Component: Console Writer (Indicators)"

Revision as of 11:59, 3 February 2023

Author	Matrix TSL
Version	1.0
Category	Indicators

Console Writer component

A simple component to aid in creating and wiriting data to a console tab. Allows text to be coloured and automatically appended with a timestamp.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/ConsoleWriter.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/ConsoleWriter.fcfx

Detailed description

No detailed description exists yet for this component

Examples

A basic example using two circular knobs to simulate data e.g., temperature. Both xy chart and Console, log the data.

Logging Example

Macro reference

AddString

	AddString
Adds text string to the console window.
- STRING	Data

- VOID	Return

Clear

	Clear
Clears the contents of the console tab.
- VOID	Return

CountLines

	CountLines
Counts the number of lines in the console.
- ULONG	Return

GetTextLine

	GetTextLine
Gets the string data from a specific line in the console.
- LONG	Line
Line number, -1 for the last line.
- STRING	Return

SetColour

	SetColour
Allows for full RGB colour selection
- BYTE	R
Colour channel, Range: 0-255
- BYTE	G
Colour channel, Range: 0-255
- BYTE	B
Colour channel, Range: 0-255
- VOID	Return

SetColourIdx

	SetColourIdx
Sets the text colour from the properties selection of colours.
- BYTE	Index
Range: 0-3
- VOID	Return

SetTextLine

	SetTextLine
Sets the string data from a specific line in the console.
- LONG	Line
Line number, -1 for the last line.
- STRING	Data

- VOID	Return

ShowConsole

	ShowConsole
Pops up the console window and shows the correct tab.
- VOID	Return

Property reference

	Properties
	Console Name
Textual name of the console shown as the tab name at the top of the console window.
	Colour 0
Used to define a colour channel referenced by the SetColourIdx component macro call.
	Colour 1
Used to define a colour channel referenced by the SetColourIdx component macro call.
	Colour 2
Used to define a colour channel referenced by the SetColourIdx component macro call.
	Colour 3
Used to define a colour channel referenced by the SetColourIdx component macro call.
	New Line After Data
Automatically append a newline character after any data has been written to the console using the AddString component macro.
	Clear On Sim Start
Automatically clear the console tab when the simulation is started.
	Add Timestamp
Automatically adds a timestamp to the console after a newline character has been received.
	Timestamp
	Date Format
Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY"
	Time Separator
Characters that are used in between the time digits
	Date Separator
Characters that are used in between the date digits
	TimeStamp Separator
Characters that are used between the time and date strings when returning a full time stamp.
	Override Colour
Overrides the current selected colour when writing the timestamp.
	Timestamp Colour
Defines the colour of the time stamp text

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ConsoleWriter.fcfx FC_Comp_Source_ConsoleWriter.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/ConsoleWriter.fcfx FC_Comp_Source_temp/ConsoleWriter.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ConsoleWriter.fcfx FC_Comp_Source_ConsoleWriter.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/ConsoleWriter.fcfx FC_Comp_Source_temp/ConsoleWriter.fcfx]
 ==Detailed description==
@@ Line 74: / Line 74: @@
 {{Fcfile|Logging_Example.fcsx|Logging Example}}
@@ Line 81: / Line 83: @@
 ==Macro reference==
-===Clear===
+===AddString===
 {| 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;" | '''Clear'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddString'''
+|-
+| colspan="2" | Adds text string to the console window.&nbsp;
+|-
 |-
-| colspan="2" | Clears the contents of the console tab.&nbsp;
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Data
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 95: / Line 102: @@
-===CountLines===
+===Clear===
 {| 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;" | '''CountLines'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
 |-
-| colspan="2" | Counts the number of lines in the console.&nbsp;
+| colspan="2" | Clears the contents of the console tab.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| 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''
 |}
-===AddString===
+===CountLines===
 {| 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;" | '''AddString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CountLines'''
 |-
-| colspan="2" | Adds text string to the console window.&nbsp;
+| colspan="2" | Counts the number of lines in the console.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Data
-|-
-| 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''
 |}
-===SetTextLine===
+===GetTextLine===
 {| 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;" | '''SetTextLine'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTextLine'''
 |-
-| colspan="2" | Sets the string data from a specific line in the console.&nbsp;
+| colspan="2" | Gets the string data from a specific line in the console.&nbsp;
 |-
 |-
@@ Line 142: / Line 144: @@
 | colspan="2" | Line number, -1 for the last line.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | Data
-|-
-| 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''
 |}
@@ Line 200: / Line 197: @@
-===ShowConsole===
+===SetTextLine===
 {| 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;" | '''ShowConsole'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTextLine'''
+|-
+| colspan="2" | Sets the string data from a specific line in the console.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Line
+|-
+| colspan="2" | Line number, -1 for the last line.&nbsp;
 |-
-| colspan="2" | Pops up the console window and shows the correct tab.&nbsp;
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Data
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 214: / Line 221: @@
-===GetTextLine===
+===ShowConsole===
 {| 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;" | '''GetTextLine'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowConsole'''
 |-
-| colspan="2" | Gets the string data from a specific line in the console.&nbsp;
+| colspan="2" | Pops up the console window and shows the correct tab.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Line
-|-
-| colspan="2" | Line number, -1 for the last line.&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''
 |}