This class provides basic functionalities for date and time handling. More...

#include <DateTime.h>

Static Public Member Functions
static double	timestamp ()
	Returns the seconds since 1970.01.01 00::00::00 to current UTC time.

static long long	microseconds ()
	Returns the microseconds since 1970.01.01 00::00::00 to current UTC time.

static std::string	string (const bool addMilliseconds=false)
	Returns the string of the UTC date and time.

static std::string	string (const double timestamp, const bool addMilliseconds=false)
	Returns the string of a given unix timestamp.

static std::string	stringDate (const char delimiter='.')
	Returns the string of the UTC date.

static std::string	stringDate (const double timestamp, const bool nameMonths=false)
	Returns the string of a given unix timestamp.

static std::string	stringTime (const bool addMilliseconds=false, const char delimiter='-')
	Returns the string of the UTC time.

static std::string	stringTime (const double timestamp, const bool addMilliseconds=false, const char delimiter='-')
	Returns the string of a given unix timestamp.

static double	localTimestamp ()
	Returns the seconds since 1970.01.01 00::00::00 to current local time.

static long long	localMicroseconds ()
	Returns the microseconds since 1970.01.01 00::00::00 to current local time.

static std::string	localString ()
	Returns the string of the local date and time suitable for a text/log output.

static std::string	localStringForFile ()
	Returns the string of the local date and time suitable for a filename.

static std::string	localStringDate (const char delimiter='.')
	Returns the string of the local date.

static double	date2timestamp (const unsigned int year, const unsigned int month, const unsigned int day, const unsigned int hour, const unsigned int minute, const unsigned int second, const unsigned int millisecond=0u)
	Converts a date to the seconds since 1970.01.01 00:00:00.

static void	timestamp2date (const double timestamp, unsigned int &year, unsigned int &month, unsigned int &day, unsigned int &hour, unsigned int &minute, unsigned int &second, unsigned int *millisecond=nullptr)
	Converts a unix timestamp (the seconds since 1970.01.01 00:00:00) to a date.

static std::string	seconds2string (const double totalSeconds, const bool addDescription, const bool addMilliseconds=false)
	Converts value of seconds to a time string showing the hours, minutes and seconds.

static std::string	localStringTime (const bool addMilliseconds=false, const char delimiter=':')
	Returns the string of the local time.

static unsigned int	isLeapYear (const unsigned int year)
	Returns whether a given year is a leap year.

static bool	isDateValid (const unsigned int year, const unsigned int month, const unsigned int day)
	Returns whether a given date is a valid date (e.g., in no leap years the 29th February is an invalid date)

Detailed Description

This class provides basic functionalities for date and time handling.

All functions are available for UTC and local time.

Member Function Documentation

◆ date2timestamp()

static double Ocean::DateTime::date2timestamp	(	const unsigned int	year,
		const unsigned int	month,
		const unsigned int	day,
		const unsigned int	hour,
		const unsigned int	minute,
		const unsigned int	second,
		const unsigned int	millisecond = `0u`
	)

static

Converts a date to the seconds since 1970.01.01 00:00:00.

Parameters

year	The year, with range [1970, 2037)
month	The month, with range [1, 12]
day	The day, with range [1, 31]
hour	The hour, with range [0, 23]
minute	The minute, with range [0, 59]
second	The second, with range [0, 59]
millisecond	The millisecond, with range [0, 999]

Returns: The unix timestamp, -1 if the given date is invalid

◆ isDateValid()

static bool Ocean::DateTime::isDateValid	(	const unsigned int	year,
		const unsigned int	month,
		const unsigned int	day
	)

static

Returns whether a given date is a valid date (e.g., in no leap years the 29th February is an invalid date)

Parameters

year	The year of the date, with range [0, infinity)
month	The month of the date, with range [1, 12]
day	The day of the date, with range [1, 31]

Returns: True, if so

◆ isLeapYear()

unsigned int Ocean::DateTime::isLeapYear ( const unsigned int year )

inlinestatic

Returns whether a given year is a leap year.

Parameters

year	The year to check

◆ localMicroseconds()

static long long Ocean::DateTime::localMicroseconds ( )

static

Returns the microseconds since 1970.01.01 00::00::00 to current local time.

Returns: Microseconds

◆ localString()

static std::string Ocean::DateTime::localString ( )

static

Returns the string of the local date and time suitable for a text/log output.

The format of the resulting string is YYYY.MM.DD HH:MM:SS.

Returns: The resulting date and time string

See also: localStringForFile().

◆ localStringDate()

static std::string Ocean::DateTime::localStringDate ( const char delimiter = '.' )

static

Returns the string of the local date.

Parameters

delimiter The delimiter to be used

Returns: Date string of local date, with format YYYY.MM.DD, if delimiter is '.'

◆ localStringForFile()

static std::string Ocean::DateTime::localStringForFile ( )

static

Returns the string of the local date and time suitable for a filename.

The format of the resulting string is YYYY-MM-DD_HH-MM-SS.

Returns: The resulting date and time string

See also: localString().

◆ localStringTime()

static std::string Ocean::DateTime::localStringTime	(	const bool	addMilliseconds = `false`,
		const char	delimiter = `':'`
	)

static

Returns the string of the local time.

The resulting string has the following format: HH:MM:SS, or HH:MM:SS:mmmm if the milliseconds are added.

Parameters

addMilliseconds	True, to add the milliseconds to the string
delimiter	The delimiter to be used

Returns: Time string of local time

◆ localTimestamp()

static double Ocean::DateTime::localTimestamp ( )

static

Returns the seconds since 1970.01.01 00::00::00 to current local time.

Returns: Seconds

◆ microseconds()

static long long Ocean::DateTime::microseconds ( )

static

Returns the microseconds since 1970.01.01 00::00::00 to current UTC time.

Returns: Microseconds

◆ seconds2string()

static std::string Ocean::DateTime::seconds2string	(	const double	totalSeconds,
		const bool	addDescription,
		const bool	addMilliseconds = `false`
	)

static

Converts value of seconds to a time string showing the hours, minutes and seconds.

The resulting string has the following format: HH:MM:SS, or HH:MM:SS:mmmm if the milliseconds are added; or H hours, M minutes, S seconds or H hours, M minutes, S seconds, m milliseconds if the description is added.

Parameters

totalSeconds	The number of seconds to convert, with range [0, infinity)
addDescription	True, to add the description text to the string
addMilliseconds	True, to add the milliseconds to the string

Returns: Time string of local time

◆ string() [1/2]

static std::string Ocean::DateTime::string ( const bool addMilliseconds = false )

static

Returns the string of the UTC date and time.

Parameters

addMilliseconds True, to add the milliseconds to the string

Returns: Date and time string

◆ string() [2/2]

static std::string Ocean::DateTime::string	(	const double	timestamp,
		const bool	addMilliseconds = `false`
	)

static

Returns the string of a given unix timestamp.

Parameters

timestamp	The unix timestamp (seconds since 1970.01.01 00:00:00) to be converted, with range [0, infinity)
addMilliseconds	True, to add the milliseconds to the string

Returns: Date and time string

◆ stringDate() [1/2]

static std::string Ocean::DateTime::stringDate ( const char delimiter = '.' )

static

Returns the string of the UTC date.

Parameters

delimiter The delimiter to be used

Returns: Date string, with pattern YYYY.MM.DD, if delimiter is '.'

◆ stringDate() [2/2]

static std::string Ocean::DateTime::stringDate	(	const double	timestamp,
		const bool	nameMonths = `false`
	)

static

Returns the string of a given unix timestamp.

Parameters

timestamp	The unix timestamp (seconds since 1970.01.01 00:00:00) to be converted, with range [0, infinity)
nameMonths	True, to receive a date with named months; False, to receive a date with digits only (but with constant length)

Returns: Date string, with pattern YYYY.MM.DD (2016.08.05) for nameMonths=false; or MMMMMMMMMM D/DD, YYYY (May 5, 2016) for nameMonths=true

◆ stringTime() [1/2]

static std::string Ocean::DateTime::stringTime	(	const bool	addMilliseconds = `false`,
		const char	delimiter = `'-'`
	)

static

Returns the string of the UTC time.

The resulting string has the following format: HH-MM-SS, or HH-MM-SS-mmmm if the milliseconds are added.

Parameters

addMilliseconds	True, to add the milliseconds to the string
delimiter	The delimiter to be used

Returns: Time string of UTC time

◆ stringTime() [2/2]

static std::string Ocean::DateTime::stringTime	(	const double	timestamp,
		const bool	addMilliseconds = `false`,
		const char	delimiter = `'-'`
	)

static

Returns the string of a given unix timestamp.

The resulting string has the following format: HH-MM-SS, or HH-MM-SS-mmmm if the milliseconds are added.

Parameters

timestamp	The unix timestamp (seconds since 1970.01.01 00:00:00) to be converted, with range [0, infinity)
addMilliseconds	True, to add the milliseconds to the string
delimiter	The delimiter to be used

Returns: Time string of the UTC time

◆ timestamp()

static double Ocean::DateTime::timestamp ( )

static

Returns the seconds since 1970.01.01 00::00::00 to current UTC time.

Returns: Seconds

◆ timestamp2date()

static void Ocean::DateTime::timestamp2date	(	const double	timestamp,
		unsigned int &	year,
		unsigned int &	month,
		unsigned int &	day,
		unsigned int &	hour,
		unsigned int &	minute,
		unsigned int &	second,
		unsigned int *	millisecond = `nullptr`
	)

static

Converts a unix timestamp (the seconds since 1970.01.01 00:00:00) to a date.

Parameters

timestamp	The unix timestamp to convert
year	The resulting year, with range [1970, 2037)
month	The resulting month, with range [1, 12]
day	The resulting date, with range [1, 31]
hour	The resulting hour, with range [0, 23]
minute	The resulting minute, with range [0, 59]
second	The resulting second, with range [0, 59]
millisecond	Optional resulting millisecond, with range [0, 999]

The documentation for this class was generated from the following file:

DateTime.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ date2timestamp()

◆ isDateValid()

◆ isLeapYear()

◆ localMicroseconds()

◆ localString()

◆ localStringDate()

◆ localStringForFile()

◆ localStringTime()

◆ localTimestamp()

◆ microseconds()

◆ seconds2string()

◆ string() [1/2]

◆ string() [2/2]

◆ stringDate() [1/2]

◆ stringDate() [2/2]

◆ stringTime() [1/2]

◆ stringTime() [2/2]

◆ timestamp()

◆ timestamp2date()