datetime::DateTime Interface Reference

Date and time configuration methods. More...

import"DateTime.idl";

Classes
struct	Cfg
	Device date and time configuration. More...
struct	NtpCfg
	Static NTP server configuration. More...
struct	ZoneCfg
	Time zone configuration. More...
struct	ZoneInfo
	Time zone information (see also ZoneCfg) More...

Public Types
enum	Protocol { STATIC , NTP }
	Time synchronization protocol. More...

Public Member Functions
void	getZoneInfos (out vector< ZoneInfo > zoneInfos, in boolean useOlson)
	List all supported time zones. More...
boolean	checkNtpServer (in string ntpServer)
	Check if a specified NTP server is usable. More...
vector< string >	getActiveNtpServers ()
	Get active NTP servers. More...
void	getCfg (out Cfg cfg)
	Retrieve the device date and time configuration. More...
int	setCfg (in Cfg cfg)
	Set the device date and time configuration. More...
void	getTime (in boolean useOlson, out ZoneInfo zone, out boolean dstEnabled, out int utcOffset, out time currentTime)
	Retrieve the current device date and time. More...

Public Attributes
valueobject	ConfigurationChangedEvent: idl::Event { }
	Event that is sent when the configuration changes.
valueobject	ClockChangedEvent: idl::Event { time oldTime
	Event that is sent when the device time is changed. More...
time	newTime
	Device time after change (UNIX timestamp, UTC)

Detailed Description

Date and time configuration methods.

Example to set timezone (id-based approach):

zoneinfos = getZoneInfos(False)
cfg = getCfg()
cfg.zoneCfg.id = ... # choose zone id from returned zoneinfos
status = setCfg(cfg)
if status != 0: ... # error handling

Member Enumeration Documentation

Protocol

enum datetime::DateTime::Protocol

Time synchronization protocol.

Enumerator
STATIC	Device time is configured locally.
NTP	Device time is synchronized via NTP.

Member Function Documentation

checkNtpServer()

boolean datetime::DateTime::checkNtpServer

(

in string

ntpServer

)

Check if a specified NTP server is usable.

Parameters

ntpServer

NTP server to be checked

Returns

true if the NTP server is usable

getActiveNtpServers()

vector<string> datetime::DateTime::getActiveNtpServers

(

)

Get active NTP servers.

Returns

List of currently active NTP servers (IP addresses and/or hostnames)

getCfg()

void datetime::DateTime::getCfg

(

out Cfg

cfg

)

Retrieve the device date and time configuration.

Parameters

cfg	Result: Current date and time configration

getTime()

void datetime::DateTime::getTime	(	in boolean	useOlson,
		out ZoneInfo	zone,
		out boolean	dstEnabled,
		out int	utcOffset,
		out time	currentTime
	)

Retrieve the current device date and time.

Parameters

useOlson	Use Olson timezone name (see also ZoneCfg)
zone	Result: Active time zone
dstEnabled	if false, the time zone daylight saving time flag is not used
utcOffset	Result: Offset (in minutes) between local time and UTC
currentTime	Result: Device date and time (UNIX timestamp, UTC)

getZoneInfos()

void datetime::DateTime::getZoneInfos	(	out vector< ZoneInfo >	zoneInfos,
		in boolean	useOlson
	)

List all supported time zones.

Parameters

zoneInfos	Result: List of time zones
useOlson	Use Olson timezone names (see also ZoneCfg)

setCfg()

int datetime::DateTime::setCfg

(

in Cfg

cfg

)

Set the device date and time configuration.

Depending on the value of the protocol field either deviceTime or ntpCfg will be used from the cfg parameter.

Specific example to set timezone.

Parameters

cfg	New date and time configuration.

Returns

0 if OK

1 if the configuration is invalid

Member Data Documentation

ClockChangedEvent

valueobject datetime::DateTime::ClockChangedEvent

Event that is sent when the device time is changed.

Device time before change (UNIX timestamp, UTC)

---

The documentation for this interface was generated from the following file:

• DateTime.idl