class Akenti::UtcTime

A UtcTime object provides the operations for utctime objects.

Public Methods

[more] UtcTime (const string& date, const string format = string("YYMMDDHHMMSSZ"))
Construct this object based on the string date
[more] UtcTime (int offset = 0)
Construct this object based on the offset in seconds from the Epoch.
[more] ~UtcTime ()
Destroy this object
[more]string toString (const string format = string("YYMMDDHHMMSSZ")) const
Converts the utctime to a string
[more]void toCharArray (char buffer[], const string format = string("YYMMDDHHMMSSZ")) const
Formats the utctime into a char array
[more]UtcTime operator+ (int offset) const
Provides an operation to add an offset to the utctime
[more]UtcTime& operator+= (int offset)
Provides an operation to add an offset to the utctime
[more]bool operator== (const UtcTime &utcTime) const
Checks if utctime object is equal to the input time
[more]bool operator< (const UtcTime &utcTime) const
Checks If the utcTime object is less than the input time.
[more]bool operator<= (const UtcTime &utcTime) const
Checks If the utcTime object is less than or equal to the input time.
[more]bool operator> (const UtcTime &utcTime) const
Checks If the utcTime object is greater than the input time.
[more]bool operator>= (const UtcTime &utcTime) const
Checks If the utcTime object is greater than or equal to the input time.
[more]string paramString () const
Shows the utctime fields in the format [nameOfDataMember=valueOfDataMember,stringValue].


Documentation

A UtcTime object provides the operations for utctime objects. utctime is date and time in Coordinated Universal Time (aka Greenwich Mean Time).

o UtcTime(const string& date, const string format = string("YYMMDDHHMMSSZ"))
Construct this object based on the string date

Parameters:
date - const string& the utctime in either YYMMDDHHMMSSZ or YYYY-MM-DDTHH:MM:SS format must end with a "Z"

o UtcTime(int offset = 0)
Construct this object based on the offset in seconds from the Epoch. On UNIX systems the Epoch is 00:00:00 Jan 1, 1970.

Parameters:
offset - int utctime based on the offset

o ~UtcTime()
Destroy this object

ostring toString(const string format = string("YYMMDDHHMMSSZ")) const
Converts the utctime to a string

Returns:
the utctime in either format

ovoid toCharArray(char buffer[], const string format = string("YYMMDDHHMMSSZ")) const
Formats the utctime into a char array

Parameters:
buffer - [] char the char array to which the utctime string was written. The format either string format

oUtcTime operator+(int offset) const
Provides an operation to add an offset to the utctime

Parameters:
offset - int the specified offset in seconds
Returns:
the new utctime

oUtcTime& operator+=(int offset)
Provides an operation to add an offset to the utctime

Parameters:
offset - int the specified offset
Returns:
the new utctime

obool operator==(const UtcTime &utcTime) const
Checks if utctime object is equal to the input time

Parameters:
utcTime - const UtcTime & the utctime to compare with
Returns:
true if the utctimes are equal, false if they are not

obool operator<(const UtcTime &utcTime) const
Checks If the utcTime object is less than the input time.

Parameters:
utcTime - const UtcTime & the utctime to compare with
Returns:
true if the uctTime in the object is less than the input time

obool operator<=(const UtcTime &utcTime) const
Checks If the utcTime object is less than or equal to the input time.

Parameters:
utcTime - const UtcTime & the utctime to compare with
Returns:
true if the uctTime in the object is less than or equal to the input time

obool operator>(const UtcTime &utcTime) const
Checks If the utcTime object is greater than the input time.

Parameters:
utcTime - const UtcTime & the utctime to compare with
Returns:
true if the uctTime in the object is greater than the input time

obool operator>=(const UtcTime &utcTime) const
Checks If the utcTime object is greater than or equal to the input time.

Parameters:
utcTime - const UtcTime & the utctime to compare with
Returns:
true if the uctTime in the object is greater than or equal to the input time

ostring paramString() const
Shows the utctime fields in the format [nameOfDataMember=valueOfDataMember,stringValue]. There is no nameOfDataMember for the second value shown above becuase the other value is just a string representation of the data member.

Returns:
the time_t and the string format of utctime.


This class has no child classes.
Author:
Srilekha Mudumbai Abdelilah Essiari
Version:
1.1 00/05/01

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.