Feature

src/mtime_eventHandling.c

@@ -539,6 +539,7 @@ deallocateEvent(struct _event* e)
 
 
 /* INTERNAL FUNCTION. */
+//Get if trigger is true. Trigger true in [T-allowedMinusdelta,T+allowedPlusdelta].
 static 
 compare_return_val
 isTriggerTimeInRange(struct _datetime* current_dt, struct _datetime* triggerNextEventDateTime, struct _timedelta* allowedPlusdelta, struct _timedelta* allowedMinusdelta)
@@ -580,7 +581,7 @@ isTriggerTimeInRange(struct _datetime* current_dt, struct _datetime* triggerNext
       deallocateDateTime(dt_upperbound);
       deallocateDateTime(dt_lowerbound);
     }
-  else /* If alloweddelta is not defined or is malformed (negative sign is not permitted), return as normal (follow exact match for equal).  */
+  else /* If slack is malformed (negative sign is not permitted), return as normal (follow exact match for equal).  */
     {
       cmp_val_flag = compareDatetime(current_dt,triggerNextEventDateTime);
     }
@@ -592,7 +593,9 @@ isTriggerTimeInRange(struct _datetime* current_dt, struct _datetime* triggerNext
 /**
  * @brief Check if this event is active by comparing event's trigger time with current_dt.
  *
- *        The current_dt must EXACTLY match event's trigger time. The lib has no builtin clock but relies on isCurrentEventActive(.) 
+ *        The current_dt must EXACTLY match event's trigger time 
+ *        (subject to optional specified slack: [Trigger_time - minus_slack, Trigger_time + plus_slack]. Slacks can be NULL. Always inclusive.)
+ *        The lib has no builtin clock but relies on isCurrentEventActive(.) 
  *        being called (polled) from the application at fixed interals.
  *
  * @param  event
@@ -601,12 +604,18 @@ isTriggerTimeInRange(struct _datetime* current_dt, struct _datetime* triggerNext
  * @param  current_dt
  *         A pointer to struct _datetime. This is the 'current' datetime of the system.
  *
+ * @param  plus_slack
+ *         A pointer to struct _timedelta. Events are triggered between [actual_trigger_time, actual_trigger_time + plus_slack]. 
+ * 	   Can be NULL; logically 0. Sign MUST be '+'
+ *
+ * @param  minus_slack
+ *         A pointer to struct _timedelta. Events are triggered between [actual_trigger_time - minus_slack, actual_trigger_time]. 
+ *         Can be NULL; logically 0. Sign MUST be '+'
+ *
  * @return bool
  *         true/false indicating if the event is active.
  */
 
-//bool
-//isCurrentEventActive(struct _event* event, struct _datetime* current_dt, struct _timedelta* allowed_slack, struct _timedelta* add_slack, struct _timedelta* substract_slack)
 bool
 isCurrentEventActive(struct _event* event, struct _datetime* current_dt, struct _timedelta* plus_slack, struct _timedelta* minus_slack)
 {
@@ -623,6 +632,9 @@ isCurrentEventActive(struct _event* event, struct _datetime* current_dt, struct
 
   int cmp_val_flag = -128;
 
+
+
+  /* Make a local copy of slack to avoid updating the user supplied timedeltas. */
   struct _timedelta* plus_slack_local  = NULL;
   struct _timedelta* minus_slack_local = NULL;
   if (plus_slack)
@@ -635,6 +647,8 @@ isCurrentEventActive(struct _event* event, struct _datetime* current_dt, struct
   else
 	  minus_slack_local = newTimeDelta(initDummyTDString);
 
+
+
   /* In case the current_dt starts ahead of event->triggerNextEventDateTime, we need to update the event->triggerNextEventDateTime 
      to the next possible trigger time or else the events will never trigger. */
   if (