CL_DateTime Class Reference
[clanCore System]

Date/Time class. More...

#include <datetime.h>

List of all members.

Construction

enum  TimeZone { local_timezone, utc_timezone }
 CL_DateTime ()
 Constructs a date/time object.
 CL_DateTime (int year, int month, int day, int hour=0, int minute=0, int seconds=0, int nanoseconds=0, TimeZone timezone=utc_timezone)
 ~CL_DateTime ()
static CL_DateTime get_current_local_time ()
 Get current system time in local time zone.
static CL_DateTime get_current_utc_time ()
 Get current system time in UTC.
static CL_DateTime get_local_time_from_ticks (cl_int64 ticks)
 Converts a time tick value (number of 100-nanosecond intervals since January 1, 1601 UTC) to a date time in the local time zone.
static CL_DateTime get_utc_time_from_ticks (cl_int64 ticks)
 Converts a time tick value (number of 100-nanosecond intervals since January 1, 1601 UTC) to a date time in UTC.
static CL_DateTime from_short_date_string (const CL_String &value)

Public Member Functions

Attributes
bool is_null () const
unsigned short get_year () const
unsigned char get_month () const
unsigned char get_day () const
unsigned char get_hour () const
unsigned char get_minutes () const
unsigned char get_seconds () const
unsigned int get_nanoseconds () const
TimeZone get_timezone () const
unsigned int get_day_of_week () const
 Get the day of the week.
Operations
void set_null ()
void set_date (int year, int month, int day, int hour=0, int minute=0, int seconds=0, int nanoseconds=0, TimeZone timezone=utc_timezone)
void set_year (int year)
void set_month (int month)
void set_day (int day)
void set_hour (int hour)
void set_minutes (int minutes)
void set_seconds (int seconds)
void set_nanoseconds (int nanoseconds)
void set_timezone (TimeZone timezone)
CL_DateTime to_utc () const
CL_DateTime to_local () const
cl_int64 to_ticks () const
 Converts the date to the number of 100-nanosecond intervals since January 1, 1601 UTC.
CL_String to_long_date_string () const
 Mon Mar 3 2007.
CL_String to_short_date_string () const
 yyyy-mm-dd
CL_String to_short_datetime_string () const
 yyyy-mm-dd hh:mm:ss
CL_String to_long_time_string () const
 hh:mm:ss
CL_String to_short_time_string () const
 hh:mm
CL_String to_string () const
 Mon Feb 3 12:32:54 2008.
bool operator< (const CL_DateTime &other) const
bool operator<= (const CL_DateTime &other) const
bool operator> (const CL_DateTime &other) const
bool operator>= (const CL_DateTime &other) const
bool operator== (const CL_DateTime &other) const
bool operator!= (const CL_DateTime &other) const


Detailed Description

Date/Time class.


Member Enumeration Documentation

enum CL_DateTime::TimeZone
 

Enumerator:
local_timezone 
utc_timezone 


Constructor & Destructor Documentation

CL_DateTime::CL_DateTime  ) 
 

Constructs a date/time object.

CL_DateTime::CL_DateTime int  year,
int  month,
int  day,
int  hour = 0,
int  minute = 0,
int  seconds = 0,
int  nanoseconds = 0,
TimeZone  timezone = utc_timezone
 

CL_DateTime::~CL_DateTime  ) 
 


Member Function Documentation

static CL_DateTime CL_DateTime::from_short_date_string const CL_String value  )  [static]
 

static CL_DateTime CL_DateTime::get_current_local_time  )  [static]
 

Get current system time in local time zone.

static CL_DateTime CL_DateTime::get_current_utc_time  )  [static]
 

Get current system time in UTC.

unsigned char CL_DateTime::get_day  )  const
 

unsigned int CL_DateTime::get_day_of_week  )  const
 

Get the day of the week.

Returns:
0 = Sunday ... 6 = Saturday

unsigned char CL_DateTime::get_hour  )  const
 

static CL_DateTime CL_DateTime::get_local_time_from_ticks cl_int64  ticks  )  [static]
 

Converts a time tick value (number of 100-nanosecond intervals since January 1, 1601 UTC) to a date time in the local time zone.

unsigned char CL_DateTime::get_minutes  )  const
 

unsigned char CL_DateTime::get_month  )  const
 

unsigned int CL_DateTime::get_nanoseconds  )  const
 

unsigned char CL_DateTime::get_seconds  )  const
 

TimeZone CL_DateTime::get_timezone  )  const
 

static CL_DateTime CL_DateTime::get_utc_time_from_ticks cl_int64  ticks  )  [static]
 

Converts a time tick value (number of 100-nanosecond intervals since January 1, 1601 UTC) to a date time in UTC.

unsigned short CL_DateTime::get_year  )  const
 

bool CL_DateTime::is_null  )  const
 

bool CL_DateTime::operator!= const CL_DateTime other  )  const
 

bool CL_DateTime::operator< const CL_DateTime other  )  const
 

bool CL_DateTime::operator<= const CL_DateTime other  )  const
 

bool CL_DateTime::operator== const CL_DateTime other  )  const
 

bool CL_DateTime::operator> const CL_DateTime other  )  const
 

bool CL_DateTime::operator>= const CL_DateTime other  )  const
 

void CL_DateTime::set_date int  year,
int  month,
int  day,
int  hour = 0,
int  minute = 0,
int  seconds = 0,
int  nanoseconds = 0,
TimeZone  timezone = utc_timezone
 

void CL_DateTime::set_day int  day  ) 
 

void CL_DateTime::set_hour int  hour  ) 
 

void CL_DateTime::set_minutes int  minutes  ) 
 

void CL_DateTime::set_month int  month  ) 
 

void CL_DateTime::set_nanoseconds int  nanoseconds  ) 
 

void CL_DateTime::set_null  ) 
 

void CL_DateTime::set_seconds int  seconds  ) 
 

void CL_DateTime::set_timezone TimeZone  timezone  ) 
 

void CL_DateTime::set_year int  year  ) 
 

CL_DateTime CL_DateTime::to_local  )  const
 

CL_String CL_DateTime::to_long_date_string  )  const
 

Mon Mar 3 2007.

CL_String CL_DateTime::to_long_time_string  )  const
 

hh:mm:ss

CL_String CL_DateTime::to_short_date_string  )  const
 

yyyy-mm-dd

CL_String CL_DateTime::to_short_datetime_string  )  const
 

yyyy-mm-dd hh:mm:ss

CL_String CL_DateTime::to_short_time_string  )  const
 

hh:mm

CL_String CL_DateTime::to_string  )  const
 

Mon Feb 3 12:32:54 2008.

cl_int64 CL_DateTime::to_ticks  )  const
 

Converts the date to the number of 100-nanosecond intervals since January 1, 1601 UTC.

CL_DateTime CL_DateTime::to_utc  )  const
 


The documentation for this class was generated from the following file:
Generated on Thu Dec 3 02:39:35 2009 for ClanLib by  doxygen 1.4.6