GPL_Time

gpl

1998 12-05

CLASS

GPL_Time - C++ time

SYNOPSIS

GPL_Time encapsulates the logical concept of a coordinate along the time axis. As such, it may be used both as an absolute time measured from 0 A.D. and as a relative time measured from another, arbitrary point in time.

PARENTS

GPL_Persistent	public
GPL_Depictable	public

CONSTRUCTORS

GPL_Time(void)

GPL_Time

Zero()

GPL_Time(const long year)
Create a GPL_Time and initialize with Zero() and then SetYear(year).

OPERATORS

GPL_Boolean operator==(const GPL_Time & t) const

TRUE

FALSE

GPL_Boolean operator!=(const GPL_Time & t) const
Returns TRUE if t does not represent the same point in time as this object and FALSE otherwise.

GPL_Boolean operator<(const GPL_Time & t) const
Returns TRUE if t represents a point in time before this object and FALSE otherwise.

GPL_Boolean operator<=(const GPL_Time & t) const
Returns TRUE if t represents a point in time before or equvialent to this object and FALSE otherwise.

GPL_Boolean operator>(const GPL_Time & t) const
Returns TRUE if t represents a point in time after this object and FALSE otherwise.

GPL_Boolean operator>=(const GPL_Time & t) const
Returns TRUE if t represents a point in time after or equvialent to this object and FALSE otherwise.

GPL_Time operator-(const GPL_Time & t) const
Returns the result of Delta(t).

GPL_Time & operator-=(const GPL_Time & t)
Assigns the result of Delta(t) to this object.

MEMBER FUNCTIONS

long GetYear(void) const

char GetMonth(void) const
Return the month.

char GetDay(void) const
Return the day.

char GetHour(void) const
Return the hour.

char GetMinute(void) const
Return the minute.

char GetSecond(void) const
Return the second.

long GetMillisecond(void) const
Return the millisecond.

long Compare(const GPL_Time & t, const GPL_Time & tolerance) const
Compare this object to t, allowing for variance as indicated by tolerance. Returns a negative value if this object is before t, a positive value if this object is after t, and zero if this two are equivalent within tolerance.

GPL_Time Delta(const GPL_Time & t) const
Returns the member-wise difference between t and this object.

void Zero()
Set year to 0, month to 1, day to 1, hour to 0, minute to 0, second to 0, and millisecond to 0.

void SetYear(long year)
Set the year to year.

void SetMonth(char month)
Set the month to month.

void SetDay(char day)
Set the day to day.

void SetHour(char hour)
Set the hours to hour.

void SetMinute(char minute)
Set the minutes to minute.

void SetSecond(char second)
Set the seconds to second.

void SetMillisecond(long millisecond)
Set the milliseconds to millisecond.

void Set(const long year, const char month, const char day, const char hour, const char minute, const char second, const long millisecond)
Convienience function to set all data members of GPL_Time.

void ConvertFromMilliseconds(const unsigned long milliseconds)
Set the time to a duration equivalent to milliseconds milli-seconds.

GPL_Boolean GetFromClock()
Set the time based on the system clock in terms of UTC time.