Component: Time Stamp (Runtime Tools): Difference between revisions

Latest revision as of 14:23, 13 July 2026

Author	Matrix TSL
Version	1.2
Category	Runtime Tools

Time Stamp component

A simple simulation component to collect the current system timestamp as a string.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_TimeStamp.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetDate

	GetDate
Returns the current system date as a string in the selected format.
- STRING	Return

GetStr

	GetStr
Allows a single time or date value to be returned as a two character string.
- BYTE	Index
0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year
- STRING	Return

GetTime

	GetTime
Returns the current system time as a string in the format of "HH MM SS"
- STRING	Return

GetTimeStamp

	GetTimeStamp
Returns the current system date and time combined into a single string.
- STRING	Return

GetValue

	GetValue
Allows a single time or date value to be returned.
- BYTE	Index
0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year, 6: Millisecs
- UINT	Return

Property reference

	Properties
	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.
	Include Milliseconds
Allows milliseconds to be included in the timestamp

@@ Line 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 85: / Line 91: @@
 ==Macro reference==
-===GetValue===
+===GetDate===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
+| width="90%" class="mtx-class-macrohead" | '''GetDate'''
 |-
-| colspan="2" | Allows a single time or date value to be returned.&nbsp;
+| colspan="2" | Returns the current system date as a string in the selected format.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | Index
-|-
-| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year, 6: Millisecs&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===GetTimeStamp===
+===GetStr===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetStr'''
+|-
+| colspan="2" | Allows a single time or date value to be returned as a two character string.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTimeStamp'''
 |-
-| colspan="2" | Returns the current system date and  time combined into a single string.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Index
 |-
+| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
@@ Line 119: / Line 125: @@
 ===GetTime===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTime'''
+| width="90%" class="mtx-class-macrohead" | '''GetTime'''
 |-
 | colspan="2" | Returns the current system time as a string in the format of "HH MM SS"&nbsp;
@@ Line 132: / Line 138: @@
-===GetDate===
+===GetTimeStamp===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDate'''
+| width="90%" class="mtx-class-macrohead" | '''GetTimeStamp'''
 |-
-| colspan="2" | Returns the current system date as a string in the selected format.&nbsp;
+| colspan="2" | Returns the current system date and  time combined into a single string.&nbsp;
 |-
 |-
@@ Line 146: / Line 152: @@
-===GetStr===
+===GetValue===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStr'''
+| width="90%" class="mtx-class-macrohead" | '''GetValue'''
 |-
-| colspan="2" | Allows a single time or date value to be returned as a two character string.&nbsp;
+| colspan="2" | Allows a single time or date value to be returned.&nbsp;
 |-
 |-
@@ Line 158: / Line 164: @@
 | width="90%" | Index
 |-
-| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year&nbsp;
+| colspan="2" | 0: Sec, 1: Min, 2: Hour, 3: Day, 4: Month, 5: Year, 6: Millisecs&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)