Hendrik Lipka / TimeZone

This library takes the current time (which must be set to UTC, e.g. via an NTP call), and applies a timezone definition (loaded at startup) to calculate the local time. This includes the handling of daylight saving. See http://mbed.org/users/hlipka/notebook/time-zone-handling/ for more information (esp. how to get a time zone definition file).

Dependents:   CubiScan 000-FIN_youcef 005_ESSAI_youcef

Diff: Time.h

Revision:
2:7946f902f2d4
Parent:
1:81f7dd124217
Child:
3:2ad51ec5ef6e
--- a/Time.h	Wed Dec 22 23:08:57 2010 +0000
+++ b/Time.h	Wed Dec 22 23:20:43 2010 +0000
@@ -122,11 +122,24 @@
 
 class TimeZoneEntry;
 
+/**
+    This class handles the time zone calculation, and is used for creating time stamp objects.
+*/
 class Time {
 public:
+    /**
+        creates a new Time instance. On the first call, it reads the file 'timezone.csv' from the USB disk (local file system).
+    */
     Time();
     ~Time();
+    /**
+        creates a new TimeStamp instance. The caller is responsible for deleting it afterwards!
+        @returns the time stamp
+    */
     TimeStamp* getTime();
+    /**
+        @returns the current time stamp (UTC) in UNIX format, without time zone correction.
+    */
     long getUnixTime();
 private:
     static std::list<TimeZoneEntry*> *_timeZoneEntries;