#include <datetime.h>

Detailed Description

Class that represents the Universal date-time (UTC+0000). This class should be used whenever you store date and time data and should be converted to the LocalDateTime for a local output as late as possible. The internal representation is an unsigned 64-Bit integer and contains the standard Unix date-time starting with 01/01/1970-00:00 UTC+0000. The resolution of this date-time class is 1-second.

Public Member Functions
void	Reset ()

Float64	GetJulianDay (JULIANDATE variant) const

LocalDateTime	ConvertToLocalDateTime () const

RemoteDateTime	ConvertToLocalDateTime (const TimeValue &utcOffset, DST dst) const

UInt64	GetUnixTimestamp () const

	MAXON_OPERATOR_EQUALITY_HASHCODE (UniversalDateTime, _timestamp)

Bool	operator< (const UniversalDateTime &x) const

	MAXON_OPERATOR_INEQUALITY (UniversalDateTime)

UniversalDateTime &	operator+= (const TimeValue &t)

UniversalDateTime &	operator-= (const TimeValue &t)

UniversalDateTime	operator+ (const TimeValue &t) const

UniversalDateTime	operator- (const TimeValue &t) const

TimeValue	operator- (const UniversalDateTime &x) const

Bool	IsValid () const

Bool	IsPopulated () const

Bool	IsEmpty () const

String	FormatTime (const Char *formatString) const

String	ToString (const FormatStatement *formatStatement=nullptr) const

Static Public Member Functions
static UniversalDateTime	GetNow ()

static Result< UniversalDateTime >	FromValues (Int32 year, UChar month, UChar day, UChar hour, UChar minute, UChar second)

static UniversalDateTime	FromJulianDay (JULIANDATE variant, Float64 j)

static Float64	ToJulianDay (JULIANDATE variant, Int32 year, UChar month, UChar day, UChar hour, UChar minute, UChar second)

static UniversalDateTime	FromUnixTimestamp (UInt64 timestamp)

static Result< UniversalDateTime >	FromIso8601 (const String &str)

static Result< void >	DescribeIO (const DataSerializeInterface &stream)

static MAXON_ATTRIBUTE_FORCE_INLINE const UniversalDateTime &	DefaultValue ()

Static Public Attributes
static UniversalDateTime	g_defaultValue

Private Attributes
UInt64	_timestamp

Member Function Documentation

◆ Reset()

void Reset ( )

Resets all values to zero.

◆ GetJulianDay()

Float64 GetJulianDay ( JULIANDATE variant ) const

Returns the Julian day unit of the universal date-time object.

Parameters

[in] variant Julian Date Variant.

Returns: The Julian day unit.

◆ ConvertToLocalDateTime() [1/2]

LocalDateTime ConvertToLocalDateTime ( ) const

Converts the universal date-time to a local date-time object in the current timezone.

Returns: The local date-time.

◆ ConvertToLocalDateTime() [2/2]

RemoteDateTime ConvertToLocalDateTime	(	const TimeValue &	utcOffset,
		DST	dst
	)		const

Converts the universal date-time to a remote date-time.

Parameters

[in]	utcOffset	Timezone offset which will be added to the UTC value.
[in]	dst	If set, Daylight Saving Time will be added.

Returns: The remote date-time.

◆ GetUnixTimestamp()

UInt64 GetUnixTimestamp ( ) const

Returns the Unix time stamp.

Returns: The Unix time stamp where the value 0 represents the 01/01/1970-00:00 UTC.

◆ MAXON_OPERATOR_EQUALITY_HASHCODE()

MAXON_OPERATOR_EQUALITY_HASHCODE	(	UniversalDateTime	,
		_timestamp
	)

◆ operator<()

Bool operator< ( const UniversalDateTime & x ) const

Compare for less.

Returns: True if both this is less than x.

◆ MAXON_OPERATOR_INEQUALITY()

MAXON_OPERATOR_INEQUALITY ( UniversalDateTime )

◆ operator+=()

UniversalDateTime& operator+= ( const TimeValue & t )

◆ operator-=()

UniversalDateTime& operator-= ( const TimeValue & t )

◆ operator+()

UniversalDateTime operator+ ( const TimeValue & t ) const

◆ operator-() [1/2]

UniversalDateTime operator- ( const TimeValue & t ) const

◆ operator-() [2/2]

TimeValue operator- ( const UniversalDateTime & x ) const

◆ IsValid()

Bool IsValid ( ) const

Checks if the UniversalDateTime has a timestamp greater than 0. Even 0 is a valid timestamp this function can be used to determine if the time object has a proper value.

Returns: True if some date or time is set in the structure.

◆ IsPopulated()

Bool IsPopulated ( ) const

◆ IsEmpty()

Bool IsEmpty ( ) const

◆ FormatTime()

String FormatTime ( const Char * formatString ) const

Formats the time into a specific format defined be the format string.

Parameters

[in] formatString Optional. OS depending C lib format string (see strftime). "%Y-%m-%d %H:%M:%S" is used if formatString is nullptr.

Returns: Formated String of the date-time.

◆ ToString()

String ToString ( const FormatStatement * formatStatement = nullptr ) const

Returns a readable string of the content.

Parameters

[in] formatStatement Nullptr or additional formatting instruction. See also Formatting Floating point values.

Returns: The converted result.

◆ GetNow()

static UniversalDateTime GetNow ( )

static

Returns the current date-time object of the current time zone.

Returns: The current date-time.

◆ FromValues()

static Result<UniversalDateTime> FromValues	(	Int32	year,
		UChar	month,
		UChar	day,
		UChar	hour,
		UChar	minute,
		UChar	second
	)

static

Creates a universal date-time object by the passed date values. The passed parameters will be checked for validity. That includes the year.

Parameters

[in]	year	Year value [1970-3000]
[in]	month	Month value value [1-12]
[in]	day	Day value [1-31]
[in]	hour	Hour value [0-23]
[in]	minute	Minute value [0-59]
[in]	second	Second value [0-59]

Returns: Date-time object.

◆ FromJulianDay()

static UniversalDateTime FromJulianDay	(	JULIANDATE	variant,
		Float64	j
	)

static

Creates a date-time object by the passed Julian day.

Parameters

[in]	variant	Julian Date Variant.
[in]	j	The Julian day value.

Returns: See LocalDateTime.

◆ ToJulianDay()

static Float64 ToJulianDay	(	JULIANDATE	variant,
		Int32	year,
		UChar	month,
		UChar	day,
		UChar	hour,
		UChar	minute,
		UChar	second
	)

static

Creates a Julian date value from single date components. Prefer using this function when you need to convert date-components to julian date, because UniversalDateTime cannot cover years older than 1970 so UniversalDateTime::GetJulianDay would fail.

Parameters

[in]	variant	Julian Date Variant.
[in]	year	Year value [1970-3000]
[in]	month	Month value value [1-12]
[in]	day	Day value [1-31]
[in]	hour	Hour value [0-23]
[in]	minute	Minute value [0-59]
[in]	second	Second value [0-59]

Returns: The Julian date.

◆ FromUnixTimestamp()

static UniversalDateTime FromUnixTimestamp ( UInt64 timestamp )

static

Create a universal date-time object by passing a Unix time stamp.

Parameters

[in] timestamp The Unix time stamp where value 0 represents the 01/01/1970-00:00 UTC.

Returns: The universal date-time object.

◆ FromIso8601()

static Result<UniversalDateTime> FromIso8601 ( const String & str )

static

Create a universal date-time object by passing an ISO 8601 conformant string. This implementation is based on a subset of the ISO 8601 specification as described e.g. here: https://en.wikipedia.org/wiki/ISO_8601. When only year and month are given, this will result in a value that represents the beginning (00:00) of the first day of that month in UTC. All dates are assumed to be gregorian. Unnecessary whitespace at the beginning and end of the string will be trimmed. Every time information more granular than seconds will be accepted but quietly discarded (not rounded). When no time zone information is given, the time is assumed to be in the current local time zone of the machine the code is run on.

Warning: Only the core standard is supported, extensions that are only allowed by agreement between sender and receiver (such as negative years) are not supported. Week numbering and ordinal dates are also not yet supported.

Parameters

[in] str The ISO 8601 conformant string

Returns: The universal date-time object.

◆ DescribeIO()

static Result<void> DescribeIO ( const DataSerializeInterface & stream )

static

Describes all elements of this class for I/O operations.

Parameters

[in] stream The stream that is used to register the class members.

Returns: OK on success.

◆ DefaultValue()

static MAXON_ATTRIBUTE_FORCE_INLINE const UniversalDateTime& DefaultValue ( )

static

Returns a default value of the UniversalDateTime (see defaultvalue.h for more details).

Returns: A default value of the UniversalDateTime.

Member Data Documentation

◆ g_defaultValue

UniversalDateTime g_defaultValue

static

◆ _timestamp

UInt64 _timestamp

private

Detailed Description

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Member Function Documentation

◆ Reset()

◆ GetJulianDay()

◆ ConvertToLocalDateTime() [1/2]

◆ ConvertToLocalDateTime() [2/2]

◆ GetUnixTimestamp()

◆ MAXON_OPERATOR_EQUALITY_HASHCODE()

◆ operator<()

◆ MAXON_OPERATOR_INEQUALITY()

◆ operator+=()

◆ operator-=()

◆ operator+()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ IsValid()

◆ IsPopulated()

◆ IsEmpty()

◆ FormatTime()

◆ ToString()

◆ GetNow()

◆ FromValues()

◆ FromJulianDay()

◆ ToJulianDay()

◆ FromUnixTimestamp()

◆ FromIso8601()

◆ DescribeIO()

◆ DefaultValue()

Member Data Documentation

◆ g_defaultValue

◆ _timestamp