Difference between revisions of "Component: Console Writer (Indicators)"
(XML import) |
|||
| Line 140: | Line 140: | ||
This property is of type ''Line of text'' and can be referenced with the variable name ''ConsoleName''. | This property is of type ''Line of text'' and can be referenced with the variable name ''ConsoleName''. | ||
| − | + | Textual name of the console shown as the tab name at the top of the console window. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Colour 0</u></span> | <span style="font-weight: normal;"><u>Colour 0</u></span> | ||
| Line 148: | Line 146: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour0''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Colour0''. | ||
| − | + | Used to define a colour channel referenced by the SetColourIdx component macro call. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Colour 1</u></span> | <span style="font-weight: normal;"><u>Colour 1</u></span> | ||
| Line 156: | Line 152: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour1''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Colour1''. | ||
| − | + | Used to define a colour channel referenced by the SetColourIdx component macro call. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Colour 2</u></span> | <span style="font-weight: normal;"><u>Colour 2</u></span> | ||
| Line 164: | Line 158: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour2''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Colour2''. | ||
| − | + | Used to define a colour channel referenced by the SetColourIdx component macro call. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Colour 3</u></span> | <span style="font-weight: normal;"><u>Colour 3</u></span> | ||
| Line 172: | Line 164: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour3''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Colour3''. | ||
| − | + | Used to define a colour channel referenced by the SetColourIdx component macro call. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>New Line After Data</u></span> | <span style="font-weight: normal;"><u>New Line After Data</u></span> | ||
| Line 180: | Line 170: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''NLAfterData''. | This property is of type ''True or false'' and can be referenced with the variable name ''NLAfterData''. | ||
| − | + | Automatically append a newline character after any data has been written to the console using the AddString component macro. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Clear On Sim Start</u></span> | <span style="font-weight: normal;"><u>Clear On Sim Start</u></span> | ||
| Line 194: | Line 182: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''Timestamp''. | This property is of type ''True or false'' and can be referenced with the variable name ''Timestamp''. | ||
| − | + | Automatically adds a timestamp to the console after a newline character has been received. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Date Format</u></span> | <span style="font-weight: normal;"><u>Date Format</u></span> | ||
| Line 203: | Line 189: | ||
Specifies the format of the date string. | Specifies the format of the date string. | ||
| − | |||
| − | |||
No - "DD/MM/YY" | No - "DD/MM/YY" | ||
| Line 238: | Line 222: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''TimestampColour''. | This property is of type ''Color picker'' and can be referenced with the variable name ''TimestampColour''. | ||
| − | + | Defines the colour of the time stamp text. | |
Revision as of 13:05, 5 February 2021
| Author | Matrix TSL |
| Version | 1.0 (Release) |
| Category | Indicators |
Contents
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.
Examples
No additional examples
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
Clear
Clears the contents of the console tab.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
CountLines
Counts the number of lines in the console.
Parameters
- This macro has no parameters
Return value
AddString
Adds text string to the console window.
Parameters
- <- STRING Data
- This parameter may be returned back to the caller
Return value
- This call does not return a value
SetTextLine
Sets the string data from a specific line in the console.
Parameters
- LONG Line
- Line number, -1 for the last line.
- <- STRING Data
- This parameter may be returned back to the caller
Return value
- This call does not return a value
SetColour
Allows for full RGB colour selection
Parameters
- BYTE R
- Colour channel, Range: 0-255
- BYTE G
- Colour channel, Range: 0-255
- BYTE B
- Colour channel, Range: 0-255
Return value
- This call does not return a value
SetColourIdx
Sets the text colour from the properties selection of colours.
Parameters
- BYTE Index
- Range: 0-3
Return value
- This call does not return a value
GetTextLine
Gets the string data from a specific line in the console.
Parameters
- LONG Line
- Line number, -1 for the last line.
Return value
Property reference
Console Name
This property is of type Line of text and can be referenced with the variable name ConsoleName.
Textual name of the console shown as the tab name at the top of the console window.
Colour 0
This property is of type Color picker and can be referenced with the variable name Colour0.
Used to define a colour channel referenced by the SetColourIdx component macro call.
Colour 1
This property is of type Color picker and can be referenced with the variable name Colour1.
Used to define a colour channel referenced by the SetColourIdx component macro call.
Colour 2
This property is of type Color picker and can be referenced with the variable name Colour2.
Used to define a colour channel referenced by the SetColourIdx component macro call.
Colour 3
This property is of type Color picker and can be referenced with the variable name Colour3.
Used to define a colour channel referenced by the SetColourIdx component macro call.
New Line After Data
This property is of type True or false and can be referenced with the variable name NLAfterData.
Automatically append a newline character after any data has been written to the console using the AddString component macro.
Clear On Sim Start
This property is of type True or false and can be referenced with the variable name ClearOnSimStart.
Automatically clear the console tab when the simulation is started.
Add Timestamp
This property is of type True or false and can be referenced with the variable name Timestamp.
Automatically adds a timestamp to the console after a newline character has been received.
Date Format
This property is of type Fixed list of ints and can be referenced with the variable name TimeStamp1::DateFormat.
Specifies the format of the date string.
No - "DD/MM/YY"
Yes - "MM/DD/YY"
Time Separator
This property is of type Line of text and can be referenced with the variable name TimeStamp1::TimeSeperator.
Characters that are used in between the time digits
Date Separator
This property is of type Line of text and can be referenced with the variable name TimeStamp1::DateSeparator.
Characters that are used in between the date digits
TimeStamp Separator
This property is of type Line of text and can be referenced with the variable name TimeStamp1::TimeStampSeparator.
Characters that are used between the time and date strings when returning a full time stamp.
Override Colour
This property is of type True or false and can be referenced with the variable name OverrideColour.
Overrides the current selected colour when writing the timestamp.
Timestamp Colour
This property is of type Color picker and can be referenced with the variable name TimestampColour.
Defines the colour of the time stamp text.
