a_util::datetime Namespace Reference

Serves as component for date and time handling. More...

Classes
class	Date
class	DateTime
	DateTime class representing both Date and Time. More...
class	Time

Enumerations
enum	TimestampReference { MicroSecondsSinceJulianDateOrigin = 0 , MicroSecondsSinceUnixTimeOrigin = 1 }

Functions
bool	operator== (const Date &lhs, const Date &rhs)
bool	operator!= (const Date &lhs, const Date &rhs)
Date	getCurrentLocalDate ()
Date	getCurrentSystemDate ()
bool	operator== (const Time &lhs, const Time &rhs)
bool	operator!= (const Time &lhs, const Time &rhs)
Time	getCurrentLocalTime ()
Time	getCurrentSystemTime ()
bool	operator== (const DateTime &lhs, const DateTime &rhs)
bool	operator!= (const DateTime &lhs, const DateTime &rhs)
DateTime	getCurrentLocalDateTime ()
DateTime	getCurrentSystemDateTime ()

Detailed Description

Serves as component for date and time handling.

Enumeration Type Documentation

TimestampReference

enum a_util::datetime::TimestampReference

The reference point in time.

With this enum we define the reference point of a timestamp. Since the internal data structure uses Julian day as the starting point when counting the elapsed microseconds, with the help of this enum the reference can be changed when receiving a timestamp (i.e. DateTime::toTimestamp()) and be converted back to Julian day reference point when setting a timestamp (i.e. DateTime::set(timestamp_t, TimestampReference))

Enumerator
MicroSecondsSinceJulianDateOrigin	Reference point in time is noon on Monday, January 1, 4713 BC (Julian day)
MicroSecondsSinceUnixTimeOrigin	Reference point in time is midnight on Thursday, 1 January 1970 AC (Unix time)

Function Documentation

getCurrentLocalDate()

Date a_util::datetime::getCurrentLocalDate

(

)

Retrieves the current date (hardware clock with respect to timezone).

Returns

The current date.

getCurrentLocalDateTime()

DateTime a_util::datetime::getCurrentLocalDateTime

(

)

Get the current date and time (hardware clock with respect to timezone).

Returns

The current date and time.

getCurrentLocalTime()

Time a_util::datetime::getCurrentLocalTime

(

)

Get the current time (hardware clock with respect to timezone).

Returns

The current time.

getCurrentSystemDate()

Date a_util::datetime::getCurrentSystemDate

(

)

Retrieves the current system date (in UTC format).

Returns

The current date.

getCurrentSystemDateTime()

DateTime a_util::datetime::getCurrentSystemDateTime

(

)

Get the current date and time (in UTC format).

Returns

The current date and time.

getCurrentSystemTime()

Time a_util::datetime::getCurrentSystemTime

(

)

Get the current time (in UTC format).

Returns

The current time.

operator!=() [1/3]

bool a_util::datetime::operator!=	(	const Date &	lhs,
		const Date &	rhs )

Compare two dates for inequality

Parameters

[in]	lhs	Left-hand side object
[in]	rhs	Right-hand side object

Returns

true if the date representations are not equal, false otherwise

operator!=() [2/3]

bool a_util::datetime::operator!=	(	const DateTime &	lhs,
		const DateTime &	rhs )

Compare two date-time representations for inequality

Parameters

[in]	lhs	Left-hand side object
[in]	rhs	Right-hand side object

Returns

true if the date-time representations are not equal, false otherwise

operator!=() [3/3]

bool a_util::datetime::operator!=	(	const Time &	lhs,
		const Time &	rhs )

Compare two times for inequality

Parameters

[in]	lhs	Left-hand side object
[in]	rhs	Right-hand side object

Returns

true if the time representations are not equal, false otherwise

operator==() [1/3]

bool a_util::datetime::operator==	(	const Date &	lhs,
		const Date &	rhs )

Compare two dates for equality

Parameters

[in]	lhs	Left-hand side object
[in]	rhs	Right-hand side object

Returns

true if both date representations are equal, false otherwise

operator==() [2/3]

bool a_util::datetime::operator==	(	const DateTime &	lhs,
		const DateTime &	rhs )

Compare two date-time representations for equality

Parameters

[in]	lhs	Left-hand side object
[in]	rhs	Right-hand side object

Returns

true if both date-time representations are equal, false otherwise

operator==() [3/3]

bool a_util::datetime::operator==	(	const Time &	lhs,
		const Time &	rhs )

Compare two times for equality

Parameters

[in]	lhs	Left-hand side object
[in]	rhs	Right-hand side object

Returns

true if both time representations are equal, false otherwise