TypeSystem

Classes
class	Arp::DateTime
	The class contains date and time informations. More...
struct	Arp::Timeout
	Defines some predefined timeouts. More...

Typedefs
using	Arp::boolean = bool
	The Arp boolean type.
using	Arp::byte = unsigned char
	The Arp character type.
using	Arp::sbyte = signed char
	The Arp signed byte type.
using	Arp::uint8 = std::uint8_t
	The Arp unsigned integer type of 1 byte size.
using	Arp::int8 = std::int8_t
	The Arp integer type of 1 byte size.
using	Arp::uint16 = std::uint16_t
	The Arp unsigned integer type of 2 byte size.
using	Arp::int16 = std::int16_t
	The Arp integer type of 2 byte size.
using	Arp::uint32 = std::uint32_t
	The Arp unsigned integer type of 4 byte size.
using	Arp::int32 = std::int32_t
	The Arp integer type of 4 byte size.
using	Arp::uint64 = std::uint64_t
	The Arp unsigned integer type of 8 byte size.
using	Arp::int64 = std::int64_t
	The Arp integer type of 8 byte size.
using	Arp::float32 = float
	The Arp floating point numbers type of 4 byte size.
using	Arp::float64 = double
	The Arp floating point numbers type of 8 byte size.
using	Arp::char8 = char
	The Arp character type of 1 byte size.
using	Arp::char16 = char16_t
	The Arp character type of 2 byte size.
using	Arp::String = Arp::BasicString< char8 >
	The Arp String class.
using	Arp::Version = Arp::BasicVersion
	The Arp Version class.
using	Arp::SteadyClock = std::chrono::steady_clock
	Represents the monotonic clock.
using	Arp::SystemClock = std::chrono::system_clock
	Represents the system-wide real time wall clock.
using	Arp::SteadyTimePoint = SteadyClock::time_point
	Represents the type of a monotonic clock timepoint.
using	Arp::SystemTimePoint = SystemClock::time_point
	Represents the type of a system clock timepoint.
using	Arp::Nanoseconds = std::chrono::nanoseconds
	The Arp Nanoseconds unit class.
using	Arp::Microseconds = std::chrono::microseconds
	The Arp Microseconds unit class.
using	Arp::Milliseconds = std::chrono::milliseconds
	The Arp Milliseconds unit class.
using	Arp::Seconds = std::chrono::seconds
	The Arp Seconds unit class.
using	Arp::Minutes = std::chrono::minutes
	The Arp Minutes unit class.
using	Arp::Hours = std::chrono::hours
	The Arp Hours unit class.
using	Arp::Duration = Nanoseconds
	Represents a duration in arbitary units like ns, ms, s and more. The duration unit might not be ommitted. More...
using	Arp::uintx = uint32
	The Arp unsigned integer type matching CPU width.
using	Arp::intx = int32
	The Arp integer type matching CPU width.
using	Arp::intptr = uint32
	The Arp integer type matching pointer size.

Enumerations
enum class	Arp::DateTimeKind { Arp::DateTimeKind::Unspecified = 0 , Arp::DateTimeKind::Utc = 1 }
	Specifies whether a DateTime object represents a local time, a Coordinated Universal Time (UTC), or is not specified. More...

Functions
std::ostream &	Arp::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.
std::istream &	Arp::operator>> (std::istream &is, DateTime &dateTime)
	The istream operator is used for string parsing and expects the ISO-8601 format.
	Arp::DateTime::DateTime (void)
	Constructs an zero'ed DateTime instance.
bool	Arp::DateTime::operator== (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...
bool	Arp::DateTime::operator!= (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...
bool	Arp::DateTime::operator> (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...
bool	Arp::DateTime::operator< (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...
bool	Arp::DateTime::operator>= (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...
bool	Arp::DateTime::operator<= (const DateTime &arg) const
	Compares the ticks of this instance to arg . More...
int64	Arp::DateTime::GetTicks (void) const
	Gets the number of ticks that represent the date and time of this instance. More...
DateTimeKind	Arp::DateTime::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...
static DateTime	Arp::DateTime::FromUnixMicrosecondTicks (uint64 microseconds)
	Deprecated! Creates a DateTime from the as argument passed unix time in microseconds. More...

Detailed Description

Typedef Documentation

Duration

using Arp::Duration = typedef Nanoseconds

Represents a duration in arbitary units like ns, ms, s and more. The duration unit might not be ommitted.

Use std::chrono::literals to specify an instance of this type, e.g. 100ns, 10ms or 1s. Another approach is to use explicit cast, e.g Nanoseconds(100), Milliseconds(10) or Seconds(1). /remarks>

Enumeration Type Documentation

DateTimeKind

enum class Arp::DateTimeKind

strong

Specifies whether a DateTime object represents a local time, a Coordinated Universal Time (UTC), or is not specified.

Enumerator
Unspecified	Kind of time in not specified
Utc	Time is in UTC.

Function Documentation

FromUnixMicrosecondTicks()

DateTime Arp::DateTime::FromUnixMicrosecondTicks ( uint64  microseconds )

inlinestatic

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

Returns

The a new DateTime representing the given unix time.

Parameters

microseconds

The unix time in microseconds to convert to DateTime.

Deprecated:

Use FromUnixTimeMicroseconds instead

GetKind()

DateTimeKind Arp::DateTime::GetKind ( void  ) const

inline

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

Returns

The kind that represent the date and time of this instance.

GetTicks()

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

inline

Gets the number of ticks that represent the date and time of this instance.

Returns

The number of ticks that represent the date and time of this instance.

operator!=()

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

inline

Compares the ticks of this instance to arg .

Parameters

arg	The DateTime object to compare this instance to.

Returns

true if this instance is not equal to arg , otherwise false.

operator<()

bool Arp::DateTime::operator< ( const DateTime &  arg ) const

inline

Compares the ticks of this instance to arg .

Parameters

arg	The DateTime object to compare this instance to.

Returns

true if this instance is less than arg , otherwise false.

operator<=()

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

inline

Compares the ticks of this instance to arg .

Parameters

arg	The DateTime object to compare this instance to.

Returns

true if this instance is less or equal than arg , otherwise false.

operator==()

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

inline

Compares the ticks of this instance to arg .

Parameters

arg	The DateTime object to compare this instance to.

Returns

true if this instance is equal to arg , otherwise false.

operator>()

bool Arp::DateTime::operator> ( const DateTime &  arg ) const

inline

Compares the ticks of this instance to arg .

Parameters

arg	The DateTime object to compare this instance to.

Returns

true if this instance is greater than arg , otherwise false.

operator>=()

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

inline

Compares the ticks of this instance to arg .

Parameters

arg	The DateTime object to compare this instance to.

Returns

true if this instance is greater or equal than arg , otherwise false.