Difference between revisions of "Component: Time Stamp (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimeStamp.fcfx FC_Comp_Source_TimeStamp.fcfx] |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 40: | Line 42: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 62: | Line 66: | ||
==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;" | '''GetValue''' | ||
| + | |- | ||
| + | | colspan="2" | Allows a single time or date value to be returned. | ||
| + | |- | ||
| + | |- | ||
| + | | 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, 6: Millisecs | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''GetTimeStamp''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the current system date and time combined into a single string. | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''GetTime''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the current system time as a string in the format of "HH MM SS" | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''GetDate''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the current system date as a string in the selected format. | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| 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;" | '''GetStr''' | ||
| + | |- | ||
| + | | colspan="2" | Allows a single time or date value to be returned as a two character string. | ||
| + | |- | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==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-16-icon.png]] | ||
| + | | width="90%" | Date Format | ||
| + | |- | ||
| + | | colspan="2" | Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY" | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Time Separator | ||
| + | |- | ||
| + | | colspan="2" | Characters that are used in between the time digits | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Date Separator | ||
| + | |- | ||
| + | | colspan="2" | Characters that are used in between the date digits | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | TimeStamp Separator | ||
| + | |- | ||
| + | | colspan="2" | Characters that are used between the time and date strings when returning a full time stamp. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Include Milliseconds | ||
| + | |- | ||
| + | | colspan="2" | Allows milliseconds to be included in the timestamp | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:17, 20 January 2023
| Author | Matrix TSL |
| Version | 1.2 |
| Category | Runtime Tools |
Contents
Time Stamp component
A simple simulation component to collect the current system timestamp as a string.
Component Source Code
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
|
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 |
|
|
GetTimeStamp |
| Returns the current system date and time combined into a single string. | |
 - STRING
|
Return |
|
|
GetTime |
| Returns the current system time as a string in the format of "HH MM SS" | |
| - STRING
|
Return |
|
|
GetDate |
| Returns the current system date as a string in the selected format. | |
| - STRING
|
Return |
|
|
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 |
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 | |
==Macro reference==
|
|
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 |
|
|
GetTimeStamp |
| Returns the current system date and time combined into a single string. | |
| - STRING
|
Return |
|
|
GetTime |
| Returns the current system time as a string in the format of "HH MM SS" | |
| - STRING
|
Return |
|
|
GetDate |
| Returns the current system date as a string in the selected format. | |
| - STRING
|
Return |
|
|
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 |
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 | |
