TimeDivider Class Reference

Helper class to divide time into intervals aligned with wall clock Once object is constructed say with arguments (6, 10, seconds) the time gets divided into 6 intervals each of 10s long. More...

#include <TimeDivider.h>

Collaboration diagram for TimeDivider:

Public Types
enum	unit { seconds, minutes }

Public Member Functions
	TimeDivider (unsigned int intervals, unsigned int duration, unit u)
	construct the TimeDivider More...
bool	isPassed (time_t time, unsigned int &newinterval, unsigned int &oldinterval)
	method to know if one shoudl switch to new interval More...
unsigned int	forcePassed (time_t time, unsigned int &oldinterval)
	method More...

Private Attributes
unsigned int	m_intervals
unsigned int	m_duration
unit	m_unit
unsigned int	m_current_interval
time_t	m_beginning

Detailed Description

Helper class to divide time into intervals aligned with wall clock Once object is constructed say with arguments (6, 10, seconds) the time gets divided into 6 intervals each of 10s long.

If method isPassed is then called say for 17:00:01 it returns false and interval argument is set to 0, When next time function is called at 17:00:09 retult is the same. However if next call happens at 17:00:11 one gets return value == true and new interval == 1.

Definition at line 20 of file TimeDivider.h.

Member Enumeration Documentation

unit

enum TimeDivider::unit

Enumerator
seconds
minutes

Definition at line 22 of file TimeDivider.h.

{seconds, minutes};

Constructor & Destructor Documentation

TimeDivider()

TimeDivider::TimeDivider	(	unsigned int	intervals,
		unsigned int	duration,
		unit	u
	)

construct the TimeDivider

Parameters

intervals	defines number of intervals we want to divide time into
duration	of the time interval
u	is unit (either seconds or minutes)

Definition at line 10 of file TimeDivider.cxx.

  : m_intervals(intervals),
    m_duration(duration), 
    m_unit(u),
    m_current_interval(0) {
  unsigned int temp_iv;
  time_t temp_time = time(0);
  m_beginning = temp_time;
  isPassed(temp_time, temp_iv, temp_iv);
}

Member Function Documentation

forcePassed()

unsigned int TimeDivider::forcePassed	(	time_t	time,
		unsigned int &	oldinterval
	)

method

Parameters

time	time
interval	is interval in which we are now

Returns

true if one needs to switch to new interval

Definition at line 47 of file TimeDivider.cxx.

                                                                          {
   interval = m_current_interval;
   return std::max((time - m_beginning), (long int)1); // never return 0
}

isPassed()

bool TimeDivider::isPassed	(	time_t	time,
		unsigned int &	newinterval,
		unsigned int &	oldinterval
	)

method to know if one shoudl switch to new interval

Parameters

time	time
interval	is interval in which we are now

Returns

true if one needs to switch to new interval

Definition at line 21 of file TimeDivider.cxx.

                                                                                             {
 
  // convert to tm structure for seconds & minutes
  struct tm t;
  gmtime_r(&time, &t);
  unsigned count = 0;
  if (m_unit == seconds) {
    count  = t.tm_sec;
  } else if ( m_unit == minutes ) {
    count  = t.tm_min;
  }
  
  // calculate next interval 
  unsigned int iv = (count % (m_intervals*m_duration))/m_duration;
 
  // is new interval differnt than recently returned? If so signal it.
  if ( m_current_interval != iv ) {
    oldinterval = m_current_interval;
    newinterval = m_current_interval = iv;
    m_beginning = time;
    return true;      
  }
  newinterval = oldinterval = m_current_interval;
  return false;
}

Member Data Documentation

m_beginning

time_t TimeDivider::m_beginning

private

Definition at line 54 of file TimeDivider.h.

m_current_interval

unsigned int TimeDivider::m_current_interval

private

Definition at line 53 of file TimeDivider.h.

m_duration

unsigned int TimeDivider::m_duration

private

Definition at line 51 of file TimeDivider.h.

m_intervals

unsigned int TimeDivider::m_intervals

private

Definition at line 50 of file TimeDivider.h.

m_unit

unit TimeDivider::m_unit

private

Definition at line 52 of file TimeDivider.h.

---

The documentation for this class was generated from the following files:

• TimeDivider.h
• TimeDivider.cxx