PLCnext API Documentation  21.0.0.35466
Classes | Typedefs | Enumerations | Functions
TypeSystem

Classes

class  Arp::DateTime
 The class contains date and time informations. More...
 

Typedefs

typedef bool Arp::boolean
 The Arp boolean type. More...
 
typedef unsigned char Arp::byte
 The Arp character type. More...
 
typedef signed char Arp::sbyte
 The Arp signed byte type. More...
 
typedef std::uint8_t Arp::uint8
 The Arp unsigned integer type of 1 byte size. More...
 
typedef std::int8_t Arp::int8
 The Arp integer type of 1 byte size. More...
 
typedef std::uint16_t Arp::uint16
 The Arp unsigned integer type of 2 byte size. More...
 
typedef std::int16_t Arp::int16
 The Arp integer type of 2 byte size. More...
 
typedef std::uint32_t Arp::uint32
 The Arp unsigned integer type of 4 byte size. More...
 
typedef std::int32_t Arp::int32
 The Arp integer type of 4 byte size. More...
 
typedef std::uint64_t Arp::uint64
 The Arp unsigned integer type of 8 byte size. More...
 
typedef std::int64_t Arp::int64
 The Arp integer type of 8 byte size. More...
 
typedef float Arp::float32
 The Arp floating point numbers type of 4 byte size. More...
 
typedef double Arp::float64
 The Arp floating point numbers type of 8 byte size. More...
 
typedef char Arp::char8
 The Arp character type of 1 byte size. More...
 
typedef uint16 Arp::char16
 The Arp character type of 2 byte size. More...
 
typedef Arp::BasicString< char8Arp::String
 The Arp String class. More...
 
typedef Arp::BasicVersion Arp::Version
 The Arp Version class. More...
 
typedef std::chrono::nanoseconds Arp::Nanoseconds
 The Arp Nanoseconds unit class. More...
 
typedef std::chrono::microseconds Arp::Microseconds
 The Arp Microseconds unit class. More...
 
typedef std::chrono::milliseconds Arp::Milliseconds
 The Arp Milliseconds unit class. More...
 
typedef std::chrono::seconds Arp::Seconds
 The Arp Seconds unit class. More...
 
typedef std::chrono::minutes Arp::Minutes
 The Arp Minutes unit class. More...
 
typedef std::chrono::hours Arp::Hours
 The Arp Hours unit class. More...
 
typedef uint32 Arp::uintx
 The Arp unsigned integer type matching CPU width. More...
 
typedef int32 Arp::intx
 The Arp integer type matching CPU width. More...
 
typedef uint32 Arp::intptr
 The Arp integer type matching pointer size. More...
 

Enumerations

enum  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. More...
 
std::istream & Arp::operator>> (std::istream &is, DateTime &dateTime)
 The istream operator is used for string parsing and expects the ISO-8601 format. More...
 
 Arp::DateTime::DateTime (void)
 Constructs an zero'ed DateTime instance. 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...
 
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)
 Creates a DateTime from the as argument passed unix time in microseconds. More...
 

Detailed Description

Typedef Documentation

◆ boolean

typedef bool Arp::boolean

The Arp boolean type.

◆ byte

typedef unsigned char Arp::byte

The Arp character type.

◆ char16

The Arp character type of 2 byte size.

◆ char8

typedef char Arp::char8

The Arp character type of 1 byte size.

◆ float32

typedef float Arp::float32

The Arp floating point numbers type of 4 byte size.

◆ float64

typedef double Arp::float64

The Arp floating point numbers type of 8 byte size.

◆ Hours

typedef std::chrono::hours Arp::Hours

The Arp Hours unit class.

◆ int16

typedef std::int16_t Arp::int16

The Arp integer type of 2 byte size.

◆ int32

typedef std::int32_t Arp::int32

The Arp integer type of 4 byte size.

◆ int64

typedef std::int64_t Arp::int64

The Arp integer type of 8 byte size.

◆ int8

typedef std::int8_t Arp::int8

The Arp integer type of 1 byte size.

◆ intptr

The Arp integer type matching pointer size.

◆ intx

typedef int32 Arp::intx

The Arp integer type matching CPU width.

◆ Microseconds

typedef std::chrono::microseconds Arp::Microseconds

The Arp Microseconds unit class.

◆ Milliseconds

typedef std::chrono::milliseconds Arp::Milliseconds

The Arp Milliseconds unit class.

◆ Minutes

typedef std::chrono::minutes Arp::Minutes

The Arp Minutes unit class.

◆ Nanoseconds

typedef std::chrono::nanoseconds Arp::Nanoseconds

The Arp Nanoseconds unit class.

◆ sbyte

typedef signed char Arp::sbyte

The Arp signed byte type.

◆ Seconds

typedef std::chrono::seconds Arp::Seconds

The Arp Seconds unit class.

◆ String

The Arp String class.

◆ uint16

typedef std::uint16_t Arp::uint16

The Arp unsigned integer type of 2 byte size.

◆ uint32

typedef std::uint32_t Arp::uint32

The Arp unsigned integer type of 4 byte size.

◆ uint64

typedef std::uint64_t Arp::uint64

The Arp unsigned integer type of 8 byte size.

◆ uint8

typedef std::uint8_t Arp::uint8

The Arp unsigned integer type of 1 byte size.

◆ uintx

typedef uint32 Arp::uintx

The Arp unsigned integer type matching CPU width.

◆ Version

The Arp Version class.

Enumeration Type Documentation

◆ DateTimeKind

enum 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

◆ DateTime()

Arp::DateTime::DateTime ( void  )
inline

Constructs an zero'ed DateTime instance.

◆ FromUnixMicrosecondTicks()

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

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

Returns
The a new DateTime representing the given unix time.
Parameters
microsecondsThe unix time in microseconds to convert to DateTime.

◆ 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
argThe 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
argThe DateTime object to compare this instance to.
Returns
true if this instance is less than arg , otherwise false.

◆ operator<<()

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

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

◆ operator<=()

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

Compares the ticks of this instance to arg .

Parameters
argThe 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
argThe 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
argThe 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
argThe DateTime object to compare this instance to.
Returns
true if this instance is greater or equal than arg , otherwise false.

◆ operator>>()

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

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