ucc::Time Class Reference

The Time class uses a integer representation of the current time. More...

#include <datetime.h>

Inheritance diagram for ucc::Time:
Inheritance graph
[legend]

Public Types

enum  index_t { hour = 20, minute, second }
 

Component access index.


Public Member Functions

char * get (char *buffer)
 Get a hh:mm:ss formatted string for current time.
long get (void)
 Get current time in seconds from midnight.
int getHour (void)
 Get hours from midnight.
int getMinute (void)
 Get minutes from current hour.
int getSecond (void)
 Get seconds from current minute.
bool isValid (void)
 Check if time object had valid value.
 operator bool ()
 Check if time object has valid value for is() operator.
 operator long ()
 Get time in seconds.
bool operator! ()
 Check if time object has valid value for ! operator.
bool operator!= (Time &time)
 Compare time with another time to see if not same time.
String operator() ()
 Convert to standard 24 hour time string.
long operator* ()
 Get object time in seconds.
Time operator+ (long seconds)
 Add seconds to the current time, wrap if 24 hours.
Timeoperator++ ()
 Incrememnt time by 1 second, wrap on 24 hour period.
Timeoperator+= (long seconds)
 Increment time by specified seconds.
Time operator- (long seconds)
 Subtract seconds to the current time, wrap if 24 hours.
long operator- (Time &reference)
 Get difference (in seconds) between two times.
Timeoperator-- ()
 Decrement time by 1 second, wrap on 24 hour period.
Timeoperator-= (long seconds)
 Decrement time by specified seconds.
bool operator< (Time &time)
 Compare time if earlier than another time.
bool operator<= (Time &time)
 Compare time if earlier than or equal to another time.
Timeoperator= (Time &time)
 Assign a time as a copy of another time.
bool operator== (Time &time)
 Compare time with another time to see if same time.
bool operator> (Time &time)
 Compare time if later than another time.
bool operator>= (Time &time)
 Compare time if later than or equal to another time.
int operator[] (index_t component)
 Get component of time object.
void set (char *pointer, size_t size=0)
 Set time from a hh:mm:ss formatted string.
void set (void)
 Set (update) the time with current time.
 Time ()
 Create a time from current time.
 Time (Time &object)
 Create a time object from another object.
 Time (int hour, int minute, int second)
 Create a time from hours (0-23), minutes (0-59), and seconds (0-59).
 Time (char *pointer, size_t size=0)
 Create a time from a hh:mm:ss formatted time string.
 Time (struct tm *object)
 Create a time from the time portion of a date and time object.
 Time (time_t value)
 Create a time from the time portion of a time_t.
virtual ~Time ()
 Destroy time object.

Static Public Attributes

static size_t sz_string
 Size of time string field.

Protected Member Functions

void fromSeconds (char *buf)
void toSeconds (int hour, int minute=0, int second=0)
virtual void update (void)

Protected Attributes

long seconds

Detailed Description

The Time class uses a integer representation of the current time.

This is then manipulated in several forms and may be exported as needed. The time object can represent an instance in time (hours, minutes, and seconds) in a 24 hour period or can represent a duration. Millisecond accuracy can be offered.

Author:
Marcelo Dalmas <mad@brasmap.com.br> and David Sugar <dyfet@gnutelephony.org> Integer based time class.

Definition at line 353 of file datetime.h.


Constructor & Destructor Documentation

ucc::Time::Time ( time_t  value  ) 

Create a time from the time portion of a time_t.

Parameters:
value of time_t to use.
ucc::Time::Time ( struct tm *  object  ) 

Create a time from the time portion of a date and time object.

Parameters:
object from DateTime::glt() or gmt().
ucc::Time::Time ( char *  pointer,
size_t  size = 0 
)

Create a time from a hh:mm:ss formatted time string.

Parameters:
pointer to formatted time field.
size of field if not null terminated.
ucc::Time::Time ( int  hour,
int  minute,
int  second 
)

Create a time from hours (0-23), minutes (0-59), and seconds (0-59).

Parameters:
hour of time.
minute of time.
second of time.
ucc::Time::Time ( Time object  ) 

Create a time object from another object.

Parameters:
object to copy.

Member Function Documentation

char* ucc::Time::get ( char *  buffer  ) 

Get a hh:mm:ss formatted string for current time.

Parameters:
buffer to store time string in.
Returns:
time string buffer or NULL if invalid.

Reimplemented in ucc::DateTime.

long ucc::Time::get ( void   ) 

Get current time in seconds from midnight.

Returns:
seconds from midnight.

Reimplemented in ucc::DateTime.

int ucc::Time::getHour ( void   ) 

Get hours from midnight.

Returns:
hours from midnight.
int ucc::Time::getMinute ( void   ) 

Get minutes from current hour.

Returns:
minutes from current hour.
int ucc::Time::getSecond ( void   ) 

Get seconds from current minute.

Returns:
seconds from current minute.
bool ucc::Time::isValid ( void   ) 

Check if time object had valid value.

Returns:
true if object is valid.

Reimplemented in ucc::DateTime.

ucc::Time::operator bool (  )  [inline]

Check if time object has valid value for is() operator.

Returns:
true if object is valid.

Reimplemented in ucc::DateTime.

Definition at line 470 of file datetime.h.

ucc::Time::operator long (  )  [inline]

Get time in seconds.

Returns:
seconds.

Reimplemented in ucc::DateTime.

Definition at line 505 of file datetime.h.

bool ucc::Time::operator! (  )  [inline]

Check if time object has valid value for ! operator.

Returns:
true if object is not valid.

Reimplemented in ucc::DateTime.

Definition at line 477 of file datetime.h.

bool ucc::Time::operator!= ( Time time  ) 

Compare time with another time to see if not same time.

Parameters:
time to compare with.
Returns:
true if not same time.
String ucc::Time::operator() (  ) 

Convert to standard 24 hour time string.

Returns:
time string.
long ucc::Time::operator* (  )  [inline]

Get object time in seconds.

Returns:
time in seconds.

Definition at line 512 of file datetime.h.

Time ucc::Time::operator+ ( long  seconds  ) 

Add seconds to the current time, wrap if 24 hours.

Parameters:
seconds to add.
Returns:
new time object with modified value.

Reimplemented in ucc::DateTime.

Time& ucc::Time::operator++ (  ) 

Incrememnt time by 1 second, wrap on 24 hour period.

Returns:
modified instance of current time object.

Reimplemented in ucc::DateTime.

Time& ucc::Time::operator+= ( long  seconds  ) 

Increment time by specified seconds.

Wraps on 24 hour period.

Parameters:
seconds to add to current time.
Returns:
modified instance of current time object.

Reimplemented in ucc::DateTime.

Time ucc::Time::operator- ( long  seconds  ) 

Subtract seconds to the current time, wrap if 24 hours.

Parameters:
seconds to subtract.
Returns:
new time object with modified value.

Reimplemented in ucc::DateTime.

long ucc::Time::operator- ( Time reference  ) 

Get difference (in seconds) between two times.

Parameters:
reference time to get difference from.
Returns:
difference in seconds.
Time& ucc::Time::operator-- (  ) 

Decrement time by 1 second, wrap on 24 hour period.

Returns:
modified instance of current time object.

Reimplemented in ucc::DateTime.

Time& ucc::Time::operator-= ( long  seconds  ) 

Decrement time by specified seconds.

Wraps on 24 hour period.

Parameters:
seconds to subtract from current time.
Returns:
modified instance of current time object.

Reimplemented in ucc::DateTime.

bool ucc::Time::operator< ( Time time  ) 

Compare time if earlier than another time.

Parameters:
time object to compare with.
Returns:
true if earlier than object.
bool ucc::Time::operator<= ( Time time  ) 

Compare time if earlier than or equal to another time.

Parameters:
time object to compare with.
Returns:
true if earlier or same as object.
Time& ucc::Time::operator= ( Time time  ) 

Assign a time as a copy of another time.

Parameters:
time to assign from.
Returns:
time object that was assigned.
bool ucc::Time::operator== ( Time time  ) 

Compare time with another time to see if same time.

Parameters:
time to compare with.
Returns:
true if same time.
bool ucc::Time::operator> ( Time time  ) 

Compare time if later than another time.

Parameters:
time object to compare with.
Returns:
true if later than object.
bool ucc::Time::operator>= ( Time time  ) 

Compare time if later than or equal to another time.

Parameters:
time object to compare with.
Returns:
true if later than or same as object.
int ucc::Time::operator[] ( index_t  component  ) 

Get component of time object.

Parameters:
component index.
Returns:
value of component.
void ucc::Time::set ( char *  pointer,
size_t  size = 0 
)

Set time from a hh:mm:ss formatted string.

Parameters:
pointer to time field.
size of field if not null terminated.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2-20100208