Output operator now prints optional information.

The output operator of OFDateTime and OFTime now also prints optional
information such as seconds, fraction of seconds and time zone (if
available).

Author: jriesmeier

dcmdata/tests/tvrdatim.cc

@@ -137,11 +137,11 @@ OFTEST(dcmdata_dateTime)
     OFCHECK(DcmTime::getTimeZoneFromString("+100", timeZone).bad());
     OFCHECK(DcmTime::getTimeZoneFromString("UTC+1", timeZone).bad());
 
-    dcmDateTime.putString("200204101203+0500");
+    dcmDateTime.putString("20020410120315+0500");
     dcmDateTime.print(strstream);
-    CHECK_EQUAL("(0040,a120) DT [200204101203+0500]                      #  18, 1 DateTime\n");
+    CHECK_EQUAL("(0040,a120) DT [20020410120315+0500]                    #  20, 1 DateTime\n");
     OFCHECK(dcmDateTime.getOFDateTime(dateTime).good());
-    CHECK_STREAM_EQUAL(dateTime, "2002-04-10 12:03");
+    CHECK_STREAM_EQUAL(dateTime, "2002-04-10 12:03:15 +05:00");
 
     dcmDateTime.putString("20020410");
     dcmDateTime.print(strstream);

ofstd/include/dcmtk/ofstd/ofdatime.h

@@ -252,7 +252,7 @@ class DCMTK_OFSTD_EXPORT OFDateTime
      *    if OFTrue. The time zone indicates the offset from the Coordinated Universal Time (UTC)
      *    in hours and minutes. The time zone is only added if a value is specified.
      *  @param showDelimiter flag, indicating whether to use delimiters ("-", ":" and " ") or not
-     *  @param createMissingPart if OFTrue create optional parts (seconds and fractional part of a
+     *  @param createMissingPart if OFTrue, create optional parts (seconds and fractional part of a
      *    second) even if not specified (see OFTime::hasSecond() and OFTime::hasFractionOfSecond())
      *  @param dateTimeSeparator separator between ISO date and time value, e.g. " " (default) or
      *    "T" (for ISO 8601 format). Only used if 'showDelimiter' is true.
@@ -293,7 +293,8 @@ class DCMTK_OFSTD_EXPORT OFDateTime
 
 
 /** put the given date/time in ISO format on the output stream.
- *  If an error occurs nothing is printed.
+ *  The output format is "YYYY-MM-DD HH:MM[:SS[.FFFFFF]] [&ZZ:ZZ]". Optional parts are not
+ *  created if missing. If an error occurs nothing is printed.
  *  @param stream output stream
  *  @param time OFDateTime object to print
  *  @return reference to the output stream

ofstd/include/dcmtk/ofstd/oftime.h

@@ -145,11 +145,11 @@ class DCMTK_OFSTD_EXPORT OFTime
      */
     virtual void clear();
 
-    /** clear the second value, i.e.\ set it to "unspecified".
+    /** clear the second value, i.e.\ set it to "unspecified"
      */
     void clearSecond();
 
-    /** clear the time zone value, i.e.\ set it to "unspecified".
+    /** clear the time zone value, i.e.\ set it to "unspecified"
      */
     void clearTimeZone();
 
@@ -241,7 +241,7 @@ class DCMTK_OFSTD_EXPORT OFTime
     /** set the time to the specified number of seconds
      *  @param seconds number of seconds since "00:00:00" specifying time to set
      *  @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
-     *  @param normalize if OFTrue the 'seconds' value is normalized to the valid range
+     *  @param normalize if OFTrue, the 'seconds' value is normalized to the valid range
      *    [0.0,86400.0[ otherwise the value is checked as is
      *  @return OFTrue if the new value is valid and has been set, OFFalse otherwise
      */
@@ -252,7 +252,7 @@ class DCMTK_OFSTD_EXPORT OFTime
     /** set the time to the specified number of hours
      *  @param hours number of hours since "00:00:00" specifying time to set
      *  @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
-     *  @param normalize if OFTrue the 'hours' value is normalized to the valid range
+     *  @param normalize if OFTrue, the 'hours' value is normalized to the valid range
      *    [0.0,24.0[ otherwise the value is checked as is
      *  @return OFTrue if the new value is valid and has been set, OFFalse otherwise
      */
@@ -339,7 +339,7 @@ class DCMTK_OFSTD_EXPORT OFTime
 
     /** get the currently stored time in seconds
      *  @param useTimeZone use the currently set time zone to correct the result
-     *  @param normalize if OFTrue results larger than or equal 86400.0 (seconds)
+     *  @param normalize if OFTrue, results larger than or equal 86400.0 (seconds)
      *    are normalized to a valid range
      *  @return number of seconds since "00:00:00"
      */
@@ -348,7 +348,7 @@ class DCMTK_OFSTD_EXPORT OFTime
 
     /** get the currently stored time in hours.
      *  @param useTimeZone use the currently set time zone to correct the result
-     *  @param normalize if OFTrue results larger than or equal 24.0 (hours) are
+     *  @param normalize if OFTrue, results larger than or equal 24.0 (hours) are
      *     normalized to a valid range
      *  @return number of hours since "00:00:00" (including fraction of hours)
      */
@@ -388,8 +388,8 @@ class DCMTK_OFSTD_EXPORT OFTime
      *    if OFTrue. The time zone indicates the offset from the Coordinated Universal Time (UTC)
      *    in hours and minutes. The time zone is only added if a value is specified.
      *  @param showDelimiter flag, indicating whether to use delimiters (":" and " ") or not
-     *  @param createMissingPart if OFTrue create optional parts (seconds and fractional part of a
-     *    second) even if not specified (see hasSecond() and hasFractionOfSecond())
+     *  @param createMissingPart if OFTrue, create optional parts (seconds and fractional part of
+     *    a second) even if not specified (see hasSecond() and hasFractionOfSecond())
      *  @param timeZoneSeparator separator between ISO time value and time zone, e.g. " " (default)
      *    or "" (for ISO 8601 format). Only used if 'showDelimiter' is true.
      *  @return OFTrue if result variable has been set, i.e. the time is valid, OFFalse otherwise
@@ -487,7 +487,7 @@ class DCMTK_OFSTD_EXPORT OFTime
      *  @param minute minute value of the given time
      *  @param second second value of the given time
      *  @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
-     *  @param normalize if OFTrue results larger than or equal 86400.0 (seconds)
+     *  @param normalize if OFTrue, results larger than or equal 86400.0 (seconds)
      *    are normalized to a valid range
      *  @return number of seconds since "00:00:00"
      */
@@ -502,7 +502,7 @@ class DCMTK_OFSTD_EXPORT OFTime
      *  @param minute minute value of the given time
      *  @param second second value of the given time
      *  @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
-     *  @param normalize if OFTrue results larger than or equal 24.0 (hours)
+     *  @param normalize if OFTrue, results larger than or equal 24.0 (hours)
      *    are normalized to a valid range
      *  @return number of hours since "00:00:00" (including fraction of hours)
      */
@@ -530,7 +530,8 @@ class DCMTK_OFSTD_EXPORT OFTime
 
 
 /** put the given time in ISO format on the output stream.
- *  If an error occurs, nothing is printed.
+ *  The output format is "HH:MM[:SS[.FFFFFF]] [&ZZ:ZZ]". Optional parts are not created
+ *  if missing. If an error occurs nothing is printed.
  *  @param stream output stream
  *  @param timeVal OFTime object to print
  *  @return reference to the output stream

ofstd/libsrc/ofdatime.cc

@@ -330,7 +330,7 @@ STD_NAMESPACE ostream &operator<<(STD_NAMESPACE ostream &stream,
 {
     OFString string;
     /* print the given date and time in ISO format to the stream */
-    if (dateTime.getISOFormattedDateTime(string))
+    if (dateTime.getISOFormattedDateTime(string, OFTrue /*showSeconds*/, OFTrue /*showFraction*/, OFTrue /*showTimeZone*/))
         stream << string;
     return stream;
 }

ofstd/libsrc/oftime.cc

@@ -750,11 +750,11 @@ OFBool OFTime::getISOFormattedTime(OFString &formattedTime,
         /* format: HHMM */
         else
             OFStandard::snprintf(buf, sizeof(buf), "%02u%02u", Hour, Minute);
-        /* only show seconds if requested and a value is specified (or a value is created) */
+        /* only show seconds if requested and a value is specified (or should be created) */
         if (showSeconds && (hasSecond() || createMissingPart))
         {
             const double secondValue = isSecondSpecified(Second) ? Second : 0;
-            /* only show fractional part of a second if requested and a value is specified (or a value is created) */
+            /* only show fractional part of a second if requested and a value is specified (or should be created) */
             if (showFraction && (hasFractionOfSecond() || createMissingPart))
             {
                 char buf2[12];
@@ -902,7 +902,7 @@ STD_NAMESPACE ostream &operator<<(STD_NAMESPACE ostream &stream,
 {
     OFString tmpString;
     /* print the given time in ISO format to the stream */
-    if (timeVal.getISOFormattedTime(tmpString))
+    if (timeVal.getISOFormattedTime(tmpString, OFTrue /*showSeconds*/, OFTrue /*showFraction*/, OFTrue /*showTimeZone*/))
         stream << tmpString;
     return stream;
 }

ofstd/tests/tofdatim.cc

@@ -309,6 +309,7 @@ OFTEST(ofstd_OFDateTime)
     COUT << "current date/time (default): " << dateTime1 << OFendl;
     dateTime1.getISOFormattedDateTime(tmpString, OFTrue /*showSeconds*/, OFFalse /*showFraction*/, OFTrue /*showTimeZone*/);
     COUT << "current date/time (YYYY-MM-DD HH:MM:SS&ZZ:ZZ): " << tmpString << OFendl;
-    dateTime1.getISOFormattedDateTime(tmpString, OFTrue /*showSeconds*/, OFTrue /*showFraction*/, OFTrue /*showTimeZone*/, OFFalse /*showDelimiter*/, OFFalse /*showDelimiter*/, "" /*dateTimeSeparator*/);
+    dateTime1.getISOFormattedDateTime(tmpString, OFTrue /*showSeconds*/, OFTrue /*showFraction*/, OFTrue /*showTimeZone*/,
+        OFFalse /*showDelimiter*/, OFTrue /*createMissingPart*/, /*showDelimiter*/, "" /*dateTimeSeparator*/);
     COUT << "current date/time (YYYYMMDDHHMMSS.FFFFFF&ZZZZ): " << tmpString << OFendl;
 #endif