GSDate Class Reference

Class that handles all date related (calculation) functions. More...

Inheritance diagram for GSDate:

Public Types
enum	Date { DATE_INVALID }
	Date data type is an integer value. More...

Static Public Member Functions
static bool	IsValidDate (Date date)
	Validates if a date value represent a valid date. More...
static Date	GetCurrentDate ()
	Get the current date. More...
static SQInteger	GetYear (Date date)
	Get the year of the given date. More...
static SQInteger	GetMonth (Date date)
	Get the month of the given date. More...
static SQInteger	GetDayOfMonth (Date date)
	Get the day (of the month) of the given date. More...
static Date	GetDate (SQInteger year, SQInteger month, SQInteger day_of_month)
	Get the date given a year, month and day of month. More...
static SQInteger	GetSystemTime ()
	Get the time of the host system. More...

Detailed Description

Class that handles all date related (calculation) functions.

Note

Months and days of month are 1-based; the first month of the year is 1 and the first day of the month is also 1.

Years are zero based; they start with the year 0.

Dates can be used to determine the number of days between two different moments in time because they count the number of days since the year 0.

Member Enumeration Documentation

Date

enum GSDate::Date

Date data type is an integer value.

Use GSDate::GetDate to compose valid date values for a known year, month and day.

Enumerator
DATE_INVALID	A value representing an invalid date.

Member Function Documentation

GetCurrentDate()

static Date GSDate::GetCurrentDate ( )

static

Get the current date.

This is the number of days since epoch under the assumption that there is a leap year every 4 years, except when dividable by 100 but not by 400.

Returns

The current date.

GetDate()

static Date GSDate::GetDate ( SQInteger  year, SQInteger  month, SQInteger  day_of_month  )

static

Get the date given a year, month and day of month.

Parameters

year	The year of the to-be determined date.
month	The month of the to-be determined date.
day_of_month	The day of month of the to-be determined date.

Returns

The date.

GetDayOfMonth()

static SQInteger GSDate::GetDayOfMonth ( Date  date )

static

Get the day (of the month) of the given date.

Parameters

date	The date to get the day of.

Returns

The day.

GetMonth()

static SQInteger GSDate::GetMonth ( Date  date )

static

Get the month of the given date.

Parameters

date	The date to get the month of.

Returns

The month.

GetSystemTime()

static SQInteger GSDate::GetSystemTime ( )

static

Get the time of the host system.

Returns

The amount of seconds passed since 1 Jan 1970.

Note

This uses the clock of the host system, which can skew or be set back. Use with caution.

GetYear()

static SQInteger GSDate::GetYear ( Date  date )

static

Get the year of the given date.

Parameters

date	The date to get the year of.

Returns

The year.

IsValidDate()

static bool GSDate::IsValidDate ( Date  date )

static

Validates if a date value represent a valid date.

Parameters

date	The date to validate.

Returns

True if the date is valid, otherwise false