getUTC documentation

Table of contents

• Description section:
• • Description
• Matlab/Octave section:
• • Syntax
• • Output arguments
• • Compatibility, version info, and licence

Description

For some applications it is necessary to know the current UTC time. This function has three methods to determine the UTC timestamp: an implementation written in C (which will be compiled), a call to a website, and a system call.

There are several methods implemented in this function:

• An implementation that requires a C mex function (which will be compiled).
  This method requires write access to a folder and a working C compiler. The compilation result will be stored to a subdirectory of a folder similar to the AddOn path, or the tempdir, or the current folder. Write permission is tested in that order.
• An implementation using https://www.utctime.net/utc-timestamp.
  The NIST has a server that returns the time, but it currently blocks API access, hence this replacement.
  This method requires internet access.
• The local time and timezone offset can be determined with the wmic command or the get-date Powershell function (Windows) or the date command (Linux and Mac).
  On Windows an NTP query is also implemented (internet connectivity is checked prior to this call).

To speed up the usage of this method, you can cache the difference with now() in a persistent variable, that way you avoid the need for a slow system call.

Matlab/Octave

Syntax

atomTime = getUTC

Output arguments

Compatibility, version info, and licence

Compatibility considerations:

• Some older releases don't support the web implementation.
• The normal system call hangs on ML7.1 on XP. Since ML6.5 works fine on Windows 10, it seems reasonable to assume that the OS is the cause of the hang. For XP (and older) there is an alternative strategy in place, but this has a higher likelihood to fail.
• Similarly, as wmic has been deprecated, a Powershell alternative should be used on newer versions of Windows. The need for this is automatically detected.

Version: 2.2.0
Date:    2023-11-21
Author:  H.J. Wisselink
Licence: CC by-nc-sa 4.0 ( https://creativecommons.org/licenses/by-nc-sa/4.0 )
Email = 'h_j_wisselink*alumnus_utwente_nl';
Real_email = regexprep(Email,{'*','_'},{'@','.'})

Test suite

The tester is included so you can test if your own modifications would introduce any bugs. These tests form the basis for the compatibility table above. Note that functions may be different between the tester version and the normal function. Make sure to apply any modifications to both.