namespace Akenti class UtcTime

A UtcTime object provides the operations for utctime objects

Public Methods

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

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

~UtcTime()
Destroy this object

string toString(const string format = string("YYMMDDHHMMSSZ")) const
Converts the utctime to a string
Returns:
the utctime in either format

void 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

UtcTime operator+(int offset) const
Provides an operation to add an offset to the utctime
Returns:
the new utctime
Parameters:
offset - int the specified offset in seconds

UtcTime& operator+=(int offset)
Provides an operation to add an offset to the utctime
Returns:
the new utctime
Parameters:
offset - int the specified offset

bool operator==(const UtcTime &utcTime) const
Checks if utctime object is equal to the input time
Returns:
true if the utctimes are equal, false if they are not
Parameters:
utcTime - const UtcTime & the utctime to compare with

bool operator<(const UtcTime &utcTime) const
Checks If the utcTime object is less than the input time.
Returns:
true if the uctTime in the object is less than the input time
Parameters:
utcTime - const UtcTime & the utctime to compare with

bool operator<=(const UtcTime &utcTime) const
Checks If the utcTime object is less than or equal to the input time.
Returns:
true if the uctTime in the object is less than or equal to the input time
Parameters:
utcTime - const UtcTime & the utctime to compare with

bool operator>(const UtcTime &utcTime) const
Checks If the utcTime object is greater than the input time.
Returns:
true if the uctTime in the object is greater than the input time
Parameters:
utcTime - const UtcTime & the utctime to compare with

bool operator>=(const UtcTime &utcTime) const
Checks If the utcTime object is greater than or equal to the input time.
Returns:
true if the uctTime in the object is greater than or equal to the input time
Parameters:
utcTime - const UtcTime & the utctime to compare with

string 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 hierarchy of classes


this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de