Merge lp:~chrismurf-bluefin/dccl/variable-time-codec into lp:~dccl-dev/dccl/3.0

[Chris Murphy]

Adding a parameter to allow TimeCodec to encode times outside the +-12 hour window (24 hours centered around receive time) that it supports now. The parameter is currently named num_days - feel free to rename or request a rename. Small test case added.

I also uncovered something that I wasn't aware of - it seems like TimeCodec can't encode partial seconds? Not a problem for me now, but a surprise. See Bug 1214478.

[toby schneider (tes)]

Clean implementation of a sensible feature. I think `num_days` is a fine name for the option extension. The only "better" way we could do it is to add units to DCCL and allow the field and max/min to have different units (e.g. seconds for the field, days for the max/min) and have the conversion done automatically.

But that's a wishlist item, so you have my approval to merge your changes without modification.

review: Approve

=== modified file 'src/field_codec_default.h'
--- src/field_codec_default.h	2013-06-24 17:53:00 +0000
+++ src/field_codec_default.h	2013-08-20 16:47:34 +0000
@@ -234,21 +234,23 @@
     {
       public:
         int32 pre_encode(const TimeType& time_of_day) {
-            return static_cast<int64>(time_of_day / conversion_factor) % SECONDS_IN_DAY;
+            int32 max_secs = static_cast<int32>(max());
+            return static_cast<int64>(time_of_day / conversion_factor) % max_secs;
         }
 
         TimeType post_decode(const int32& encoded_time) {
+            int32 max_secs = static_cast<int32>(max());
             timeval t;
             gettimeofday(&t, 0);
             int64 now = t.tv_sec;
-            int64 daystart = now - (now % SECONDS_IN_DAY);
+            int64 daystart = now - (now % max_secs);
             int64 today_time = now - daystart;
 
             // If time is more than 12 hours ahead of now, assume it's yesterday.
-            if ((encoded_time - today_time) > (SECONDS_IN_DAY/2)) {
-                daystart -= SECONDS_IN_DAY;
-            } else if ((today_time - encoded_time) > (SECONDS_IN_DAY/2)) {
-                daystart += SECONDS_IN_DAY;
+            if ((encoded_time - today_time) > (max_secs/2)) {
+                daystart -= max_secs;
+            } else if ((today_time - encoded_time) > (max_secs/2)) {
+                daystart += max_secs;
             }
 
             return conversion_factor * (daystart + encoded_time);
@@ -257,7 +259,10 @@
       private:
         void validate() { }
 
-        double max() { return SECONDS_IN_DAY; }
+        double max() { 
+            return FieldCodecBase::dccl_field_options().num_days() * SECONDS_IN_DAY;
+        }
+
         double min() { return 0; }
         enum { SECONDS_IN_DAY = 86400 };
     };

=== modified file 'src/protobuf/option_extensions.proto'
--- src/protobuf/option_extensions.proto	2012-10-24 15:24:12 +0000
+++ src/protobuf/option_extensions.proto	2013-08-20 16:47:34 +0000
@@ -38,6 +38,9 @@
   optional double min = 5 [default = 0];
   optional double max = 6 [default = 0];
 
+  // time ("1 day" can encode times 12h before or after the receiver's time)
+  optional uint32 num_days = 7 [default = 1];
+
   // static
   optional string static_value = 8 [default = ""];
   

=== modified file 'src/test/dccl_header/header.proto'
--- src/test/dccl_header/header.proto	2013-06-24 17:53:00 +0000
+++ src/test/dccl_header/header.proto	2013-08-20 16:47:34 +0000
@@ -16,7 +16,12 @@
                                    (dccl.field).in_head=true];
   optional double time_double = 21 [(dccl.field).codec="_time",
                                     (dccl.field).in_head=true];
-  
+  optional double pasttime_double = 22 [(dccl.field).codec="_time",
+                                          (dccl.field).num_days=6,
+                                          (dccl.field).in_head=true];  
+  optional double futuretime_double = 23 [(dccl.field).codec="_time",
+                                          (dccl.field).num_days=6,
+                                          (dccl.field).in_head=true];  
   
   //
   // source

=== modified file 'src/test/dccl_header/test.cpp'
--- src/test/dccl_header/test.cpp	2013-06-24 17:53:00 +0000
+++ src/test/dccl_header/test.cpp	2013-08-20 16:47:34 +0000
@@ -53,6 +53,12 @@
     msg_in1.mutable_header()->set_time_signed(now);
     msg_in1.mutable_header()->set_time_double(now / 1000000);
 
+    dccl::int64 past = now / 1000000.0 - 200000; // Pick a time 2+ days in the past.
+    dccl::int64 future = now / 1000000.0 + 200000; // Pick a time 2+ days in the future.
+    msg_in1.mutable_header()->set_pasttime_double(past);
+    msg_in1.mutable_header()->set_futuretime_double(future);
+
+
     msg_in1.mutable_header()->set_source_platform(1);
     msg_in1.mutable_header()->set_dest_platform(3);
     msg_in1.mutable_header()->set_dest_type(Header::PUBLISH_OTHER);