IRISLIB database
PosixTime Class Reference

The <class>PosixTime</class> data type class represents a time stamp value. More...

Static Public Member Functions

_.Library.PosixTime CurrentTimeStamp (_.Library.Integer precision)
 Returns the current logical <class>PosixTime</class> value.
 
_.Library.PosixTime CurrentUTCTimeStamp (_.Library.Integer precision)
 Returns the current logical UTC <class>PosixTime</class> value.
 
_.Library.PosixTime DateToLogical (_, _.Library.Date val)
 Converts a logical <class>Date</class> value to logical <class>PosixTime</class> value.
 
_.Library.PosixTime DisplayToLogical (_, _.Library.RawString val)
 Converts the input value val, which represents a display timestamp value, in a logical <class>PosixTime</class> value.
 
_.Library.Status IsValid (_, _.Library.RawString val)
 Tests if the logical value val, which represents a <class>PosixTime</class> value, is valid. More...
 
_.Library.PosixTime JSONToLogical (_, _.Library.BigInt val)
 Converts the JSON UNIX time to logical PosixTime.
 
_.Library.Date LogicalToDate (_, _.Library.PosixTime val)
 Converts a logical <class>PosixTime</class> value to a logical <class>Date</class> value.
 
_.Library.String LogicalToDisplay (_, _.Library.PosixTime val)
 Converts the value of val, which is in logical format as the encoded number of seconds since Jan 01, 1970 00:00:00, into a display timestamp string.
 
_.Library.BigInt LogicalToJSON (_, _.Library.FilemanTimeStamp val)
 Converts the logical PosixTime value to the JSON integer UNIX time value.
 
_.Library.TimeStamp LogicalToOdbc (_, _.Library.PosixTime val)
 Converts val, which represents a logical <class>PosixTime</class> value into an ODBC format TIMESTAMP value.
 
_.Library.Time LogicalToTime (_, _.Library.PosixTime val)
 Converts a logical <class>PosixTime</class> value to a logical <class>Time</class> value.
 
_.Library.TimeStamp LogicalToTimeStamp (_, _.Library.PosixTime val)
 Converts a logical <class>PosixTime</class> value to a logical <class>TimeStamp</class> value.
 
_.Library.BigInt LogicalToUnixTime (_, _.Library.PosixTime val)
 Converts a logical <class>PosixTime</class> value to a Unix time value (number of seconds before or after 01 Jan 1970 00:00:00.000000).
 
_.Library.String LogicalToXSD (_, _.Library.PosixTime val)
 Converts the <class>PosixTime</class> value to the canonical SOAP encoded value.
 
_.Library.PosixTime Normalize (_, _.Library.RawString val)
 Converts val to a normalized <class>PosixTime</class> value. More...
 
_.Library.PosixTime OdbcToLogical (_, _.Library.RawString val)
 Converts val, which represents either a Timestamp in ODBC format, or a Date in ODBC format, into a logical <class>PosixTime</class> value. More...
 
_.Library.PosixTime TimeStampToLogical (_, _.Library.TimeStamp val)
 Converts a logical <class>TimeStamp</class> value to a logical <class>PosixTime</class> value.
 
_.Library.PosixTime TimeToLogical (_, _.Library.Time val)
 Converts a logical <class>Time</class> value to a logical <class>PosixTime</class> value.
 
_.Library.PosixTime UnixTimeToLogical (_, _.Library.BigInt val)
 Converts a a Unix time value (number of seconds before or after 01 Jan 1970 00:00:00.000000 UTC) to a logical local <class>PosixTime</class> value.
 
_.Library.PosixTime XSDToLogical (_, _.Library.String val)
 Converts the SOAP encoded input datetime value into a <class>PosixTime</class> value.
 

Static Public Attributes

 DATEFORMAT = None
 The <class>PosixTime</class> data type class represents a time stamp value. More...
 
 INDEXNULLMARKER = None
 Declares the default null marker value to use in index subscripts for properties of type PosixTime.
 
 JSONTYPE = None
 JSONTYPE is JSON type used for this datatype.
 
 MAXVAL = None
 The maximum allowed logical value for the data type. More...
 
 MINVAL = None
 The minimum allowed logical value for the data type. More...
 
 TIMEFORMAT = None
 The format specification for the data type's time component display value. More...
 
 XMLTIMEZONE = None
 XMLTIMEZONE specifies the handling of timezone part of the XML format dateTime. More...
 
 XSDTYPE = None
 Declares the XSD type used when projecting XML Schemas.
 

Detailed Description

The <class>PosixTime</class> data type class represents a time stamp value.

The logical value of the <class>PosixTime</class> data type is based on the number of seconds since (or before) January 1, 1970 00:00:00. The logical values will never collide with those of <class>Date</class> in a valid range, and will sort chronologically when stored in globals. PosixTime takes up less disk space and memory than <class>TimeStamp</class> datatype, and is better for performance than TimeStamp.

The earliest date supported by <class>PosixTime</class> is 0001-01-01 00:00:00, which has a logical value of -6979664624441081856.
The last date supported is 9999-12-31 23:59:59.999999, which has a logical value of 1406323805406846975.
Dates prior to 1970-01-01 00:00:00 have a negative logical value. PosixTime values have a 1 microsecond resolution.

To convert between <class>PosixTime</class> and <class>TimeStamp</class> format, call <method>LogicalToTimeStamp</method>(posixtime_value) To convert between <class>TimeStamp</class> and <class>PosixTime</class> format, call <method>TimeStampToLogical</method>(timestamp_value) To convert between <class>PosixTime</class> and <class>Date</class> format, call <method>LogicalToDate</method>(posixtime_value). To convert between <class>Date</class> and <class>PosixTime</class> format, call <method>DateToLogical</method>(date_value). A time of 00:00:00 is used. To convert between <class>PosixTime</class> and <class>Time</class> format, call <method>LogicalToTime</method>(posixtime_value). To convert between <class>Time</class> and <class>PosixTime</class> format, call <method>TimeToLogical</method>(time_value). The current date is used. To determine if a value is a valid logical <class>PosixTime</class> value, call <method>IsValid</method>(posixtime_value). To get the current, local datetime <class>PosixTime</class> logical value, call <method>CurrentTimeStamp</method>(precision). To get the current, UTC datetime <class>PosixTime</class> logical value, call <method>CurrentUTCTimeStamp</method>(precision). To get a Unix Timestamp value from a <class>PosixTime</class> logical (local time) value, call <method>LogicalToUnixTime</method>(posixtime_value). To get a <class>PosixTime</class> logical value from a Unix Timestamp value, call <method>UnixTimeToLogical</method>(unix_timestamp_value).

Member Function Documentation

◆ IsValid()

_.Library.Status IsValid (   _,
_.Library.RawString  val 
)
static

Tests if the logical value val, which represents a <class>PosixTime</class> value, is valid.

Input value of a valid <class>TimeStamp</class> logical value or <class>Date</class> ODBC value is also allowed. If <class>TimeStamp</class> logical value or <class>Date</class> ODBC value is given, it will first be converted to a <class>PosixTime</class> value The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MAXVAL and MINVAL.

◆ Normalize()

_.Library.PosixTime Normalize (   _,
_.Library.RawString  val 
)
static

Converts val to a normalized <class>PosixTime</class> value.

Input value of a valid <class>TimeStamp</class> logical value, <class>Date</class> ODBC value, or <class>Date</class> logical value is also allowed. If <class>TimeStamp</class> logical value , <class>Date</class> ODBC value, or <class>Date</class> logical value is given, it will first be converted to a <class>PosixTime</class> value

◆ OdbcToLogical()

_.Library.PosixTime OdbcToLogical (   _,
_.Library.RawString  val 
)
static

Converts val, which represents either a Timestamp in ODBC format, or a Date in ODBC format, into a logical <class>PosixTime</class> value.

Returns the logical <class>PosixTime</class> value of the ODBC Timestamp string val.

Member Data Documentation

◆ DATEFORMAT

DATEFORMAT = None
static

The <class>PosixTime</class> data type class represents a time stamp value.

The logical value of the <class>PosixTime</class> data type is based on the number of seconds since (or before) January 1, 1970 00:00:00. The logical values will never collide with those of <class>Date</class> in a valid range, and will sort chronologically when stored in globals. PosixTime takes up less disk space and memory than <class>TimeStamp</class> datatype, and is better for performance than TimeStamp.

The earliest date supported by <class>PosixTime</class> is 0001-01-01 00:00:00, which has a logical value of -6979664624441081856.
The last date supported is 9999-12-31 23:59:59.999999, which has a logical value of 1406323805406846975.
Dates prior to 1970-01-01 00:00:00 have a negative logical value. PosixTime values have a 1 microsecond resolution.

To convert between <class>PosixTime</class> and <class>TimeStamp</class> format, call <method>LogicalToTimeStamp</method>(posixtime_value) To convert between <class>TimeStamp</class> and <class>PosixTime</class> format, call <method>TimeStampToLogical</method>(timestamp_value) To convert between <class>PosixTime</class> and <class>Date</class> format, call <method>LogicalToDate</method>(posixtime_value). To convert between <class>Date</class> and <class>PosixTime</class> format, call <method>DateToLogical</method>(date_value). A time of 00:00:00 is used. To convert between <class>PosixTime</class> and <class>Time</class> format, call <method>LogicalToTime</method>(posixtime_value). To convert between <class>Time</class> and <class>PosixTime</class> format, call <method>TimeToLogical</method>(time_value). The current date is used. To determine if a value is a valid logical <class>PosixTime</class> value, call <method>IsValid</method>(posixtime_value). To get the current, local datetime <class>PosixTime</class> logical value, call <method>CurrentTimeStamp</method>(precision). To get the current, UTC datetime <class>PosixTime</class> logical value, call <method>CurrentUTCTimeStamp</method>(precision). To get a Unix Timestamp value from a <class>PosixTime</class> logical (local time) value, call <method>LogicalToUnixTime</method>(posixtime_value). To get a <class>PosixTime</class> logical value from a Unix Timestamp value, call <method>UnixTimeToLogical</method>(unix_timestamp_value).

The format specification for the data type's date component display value.

The value of the DATEFORMAT parameter corresponds to the available parameters of the $ZDATETIME and $ZDATETIMEH function's fformat value, which is used to perform the formatting of the time component of the timestamp value.

◆ MAXVAL

MAXVAL = None
static

The maximum allowed logical value for the data type.

By default, a Logical value of 1406323805406846975, which is 9999-12-31 23:59:59.999999.

◆ MINVAL

MINVAL = None
static

The minimum allowed logical value for the data type.

By default, a logical value of -6979664624441081856, which is 0001-01-01 00:00:00.

◆ TIMEFORMAT

TIMEFORMAT = None
static

The format specification for the data type's time component display value.

The value of the TIMEFORMAT parameter corresponds to the available parameters of the $ZDATETIME and $ZDATETIMEH function's tformat value, which is used to perform the formatting of the time component of the timestamp value.

◆ XMLTIMEZONE

XMLTIMEZONE = None
static

XMLTIMEZONE specifies the handling of timezone part of the XML format dateTime.

"UTC" means convert to UTC on input. "IGNORE means ignore the timezone.