The class contains date and time informations. More...

#include <DateTime.hpp>

Public Member Functions
	DateTime (void)
	Constructs an zero'ed DateTime instance. More...

	DateTime (int64 ticks, DateTimeKind kind=DateTimeKind::Unspecified)
	Constructs an DateTime instance. More...

	DateTime (int year, int month, int day, int hour, int minute, int second, int millisecond, int microsecond, DateTimeKind kind=DateTimeKind::Unspecified)
	Initializes a new instance of the T:System.DateTime structure to the specified year, month, day, hour, minute, second, and millisecond. More...

	DateTime (const DateTime &arg)=default
	The default copy constructor. More...

DateTime &	operator= (const DateTime &arg)=default
	The default assignment operator. More...

	~DateTime (void)=default
	Destructs this instance and frees all resources. More...

bool	operator== (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...

bool	operator!= (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...

bool	operator> (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...

bool	operator< (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...

bool	operator>= (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...

bool	operator<= (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...

int64	GetTicks (void) const
	Gets the number of ticks that represent the date and time of this instance. More...

DateTimeKind	GetKind (void) const
	Gets a value that indicates whether the time represented by this instance is based on local time, Coordinated Universal Time (UTC), or neither. More...

int	GetYear (void) const
	Gets the year component of the date represented by this instance. More...

int	GetMonth (void) const
	Gets the month component of the date represented by this instance. More...

int	GetDay (void) const
	Gets the day of the month component of the date represented by this instance. More...

int	GetHour (void) const
	Gets the hour component of the date represented by this instance. More...

int	GetMinute (void) const
	Gets the minute component of the date represented by this instance. More...

int	GetSecond (void) const
	Gets the second component of the date represented by this instance. More...

int	GetMillisecond (void) const
	Gets the millisecond component of the date represented by this instance. More...

int	GetMicrosecond (void) const
	Gets the microsecond component of the date represented by this instance. More...

time_t	ToUnixTime (void) const
	Converts this instance to unix time (UTC). More...

uint64	ToUnixMicrosecondTicks (void) const
	Converts this instance to unix time (UTC) in microseconds. More...

int64	ToUnixTimeMicroseconds (void) const
	Converts this instance to unix time (UTC) in microseconds. More...

uint64	ToBinary (void) const
	Converts this instance to a binary representation. More...

int64	ToOpcUaTime (void) const
	Converts this instance to OPC time (UTC). More...

String	ToIso8601String (void) const
	Converts this instance to an ISO8601 string . More...

Static Public Member Functions
static DateTime	Now (void)
	Gets the current time as DateTime, expressed as the UTC time. More...

static DateTime	FromUnixTime (time_t unixTime)
	Creates a DateTime from the as argument passed unix time. More...

static DateTime	FromUnixMicrosecondTicks (uint64 microseconds)
	Creates a DateTime from the as argument passed unix time in microseconds. More...

static DateTime	FromUnixTimeMicroseconds (int64 microseconds)
	Creates a DateTime from the as argument passed unix time in microseconds. More...

static DateTime	FromOpcUaTime (int64 opcUaTime)
	Creates a DateTime from the argument passed in OpcUA time. More...

static DateTime	FromIso8601String (const String &value)
	Creates a DateTime from the as argument passed ISO8601 string. More...

static DateTime	FromBinary (uint64 data)
	Creates a DateTime from the as argument passed binary representation. More...

static bool	IsLeapYear (int year)
	Returns an indication whether the specified year is a leap year. More...

Static Public Attributes
static const int64	MinTicks = 0
	The minimal tick count. More...

static const int64	MaxTicks = daysTo10000 * ticksPerDay - 1
	The maximal tick count. More...

Friends
std::ostream &	operator<< (std::ostream &os, const DateTime &dateTime)
	The ostream operator is used for logging and string formatting and formats the DateTime value in ISO-8601 format. More...

std::istream &	operator>> (std::istream &is, DateTime &dateTime)
	The istream operator is used for string parsing and expects the ISO-8601 format. More...

Detailed Description

The class contains date and time informations.

The granularity of the time values is 100 nanosecods units called ticks. The origin of the dates is 01.01.0001 at 00:00:00. Thus a particular date and time values is the number of ticks from 01.01.0001 at 00:00:00 o'clock.

The implementation and internal representation complies to the .NET DateTime class, see https://docs.microsoft.com/de-de/dotnet/api/system.datetime?view=netframework-4.7.2.

Constructor & Destructor Documentation

◆ DateTime() [1/3]

Arp::DateTime::DateTime	(	int64	ticks,
		DateTimeKind	kind = `DateTimeKind::Unspecified`
	)

explicit

Constructs an DateTime instance.

Parameters

ticks	The ticks to initialize the DateTime with.
kind	The DateTimeKind to initialize the DateTime with.

◆ DateTime() [2/3]

Arp::DateTime::DateTime	(	int	year,
		int	month,
		int	day,
		int	hour,
		int	minute,
		int	second,
		int	millisecond,
		int	microsecond,
		DateTimeKind	kind = `DateTimeKind::Unspecified`
	)

Initializes a new instance of the T:System.DateTime structure to the specified year, month, day, hour, minute, second, and millisecond.

Parameters

year	The year (1 through 9999).
month	The month (1 through 12).
day	The day (1 through the number of days in `month`).
hour	The hours (0 through 23).
minute	The minutes (0 through 59).
second	The seconds (0 through 59).
millisecond	The milliseconds (0 through 999).
microsecond	The milliseconds (0 through 999).
kind	The DateTimeKind to initialize the DateTime with.

◆ DateTime() [3/3]

Arp::DateTime::DateTime ( const DateTime & arg )

default

The default copy constructor.

Parameters

arg	The argument to copy.

◆ ~DateTime()

Arp::DateTime::~DateTime ( void )

default

Destructs this instance and frees all resources.

Member Function Documentation

◆ FromBinary()

static DateTime Arp::DateTime::FromBinary ( uint64 data )

static

Creates a DateTime from the as argument passed binary representation.

Returns: The a new DateTime representing the given binary representation.

Parameters

data	The binary representation to convert to DateTime.

◆ FromIso8601String()

static DateTime Arp::DateTime::FromIso8601String ( const String & value )

static

Creates a DateTime from the as argument passed ISO8601 string.

Returns: The a new DateTime representing the given string.

Parameters

value The ISO8601 time string to convert to DateTime.

◆ FromOpcUaTime()

static DateTime Arp::DateTime::FromOpcUaTime ( int64 opcUaTime )

static

Creates a DateTime from the argument passed in OpcUA time.

Parameters

opcUaTime The OpcUA time in 100ns ticks since 01.01.1601.

Returns: The a new DateTime representing the given unix time.

◆ FromUnixTime()

static DateTime Arp::DateTime::FromUnixTime ( time_t unixTime )

static

Creates a DateTime from the as argument passed unix time.

Returns: The a new DateTime representing the given unix time.

Parameters

unixTime The unix time to convert to DateTime.

◆ FromUnixTimeMicroseconds()

static DateTime Arp::DateTime::FromUnixTimeMicroseconds ( int64 microseconds )

static

Creates a DateTime from the as argument passed unix time in microseconds.

Parameters

microseconds The unix time in microseconds to convert to DateTime.

Returns: The a new DateTime representing the given unix time.

◆ GetDay()

int Arp::DateTime::GetDay ( void ) const

Gets the day of the month component of the date represented by this instance.

◆ GetHour()

int Arp::DateTime::GetHour ( void ) const

Gets the hour component of the date represented by this instance.

◆ GetMicrosecond()

int Arp::DateTime::GetMicrosecond ( void ) const

Gets the microsecond component of the date represented by this instance.

◆ GetMillisecond()

int Arp::DateTime::GetMillisecond ( void ) const

Gets the millisecond component of the date represented by this instance.

◆ GetMinute()

int Arp::DateTime::GetMinute ( void ) const

Gets the minute component of the date represented by this instance.

◆ GetMonth()

int Arp::DateTime::GetMonth ( void ) const

Gets the month component of the date represented by this instance.

◆ GetSecond()

int Arp::DateTime::GetSecond ( void ) const

Gets the second component of the date represented by this instance.

◆ GetYear()

int Arp::DateTime::GetYear ( void ) const

Gets the year component of the date represented by this instance.

◆ IsLeapYear()

static bool Arp::DateTime::IsLeapYear ( int year )

static

Returns an indication whether the specified year is a leap year.

Parameters

year	A 4-digit year.

Returns: true if year is a leap year; otherwise, false.

◆ Now()

static DateTime Arp::DateTime::Now ( void )

static

Gets the current time as DateTime, expressed as the UTC time.

Returns: The current time, expressed as the UTC time.

◆ operator=()

DateTime& Arp::DateTime::operator= ( const DateTime & arg )

default

The default assignment operator.

Parameters

arg	The argument to assign to this instance.

Returns: This instance as reference.

◆ ToBinary()

uint64 Arp::DateTime::ToBinary ( void ) const

Converts this instance to a binary representation.

Returns: The binary representation of this instance.

◆ ToIso8601String()

String Arp::DateTime::ToIso8601String ( void ) const

Converts this instance to an ISO8601 string .

Returns: The ISO8601 string representing this instance.

◆ ToOpcUaTime()

int64 Arp::DateTime::ToOpcUaTime ( void ) const

Converts this instance to OPC time (UTC).

Returns: The unix time in microseconds representing this instance.

◆ ToUnixMicrosecondTicks()

uint64 Arp::DateTime::ToUnixMicrosecondTicks ( void ) const

Converts this instance to unix time (UTC) in microseconds.

Returns: The unix time in microseconds representing this instance.

◆ ToUnixTime()

time_t Arp::DateTime::ToUnixTime ( void ) const

Converts this instance to unix time (UTC).

Returns: The unix time representing this instance.

◆ ToUnixTimeMicroseconds()

int64 Arp::DateTime::ToUnixTimeMicroseconds ( void ) const

Converts this instance to unix time (UTC) in microseconds.

Returns: The unix time in microseconds representing this instance.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const DateTime &	dateTime
	)

friend

The ostream operator is used for logging and string formatting and formats the DateTime value in ISO-8601 format.

◆ operator>>

std::istream& operator>>	(	std::istream &	is,
		DateTime &	dateTime
	)

friend

The istream operator is used for string parsing and expects the ISO-8601 format.

Member Data Documentation

◆ MaxTicks

const int64 Arp::DateTime::MaxTicks = daysTo10000 * ticksPerDay - 1

static

The maximal tick count.

The maximal tick count is equivalent to 23:59:59.9999999 UTC, December 31, 9999.

◆ MinTicks

const int64 Arp::DateTime::MinTicks = 0

static

The minimal tick count.

The minimal tick count is zero and is equivalent to 00:00:00.0000000 UTC, January 1, 0001.

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

Arp/System/Core/DateTime.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ DateTime() [1/3]

◆ DateTime() [2/3]

◆ DateTime() [3/3]

◆ ~DateTime()

Member Function Documentation

◆ FromBinary()

◆ FromIso8601String()

◆ FromOpcUaTime()

◆ FromUnixTime()

◆ FromUnixTimeMicroseconds()

◆ GetDay()

◆ GetHour()

◆ GetMicrosecond()

◆ GetMillisecond()

◆ GetMinute()

◆ GetMonth()

◆ GetSecond()

◆ GetYear()

◆ IsLeapYear()

◆ Now()

◆ operator=()

◆ ToBinary()

◆ ToIso8601String()

◆ ToOpcUaTime()

◆ ToUnixMicrosecondTicks()

◆ ToUnixTime()

◆ ToUnixTimeMicroseconds()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ MaxTicks

◆ MinTicks