C++ counterparts of SPL native functions that deal with time operations. More...

Enumerations

enum TimestampFormat {
YYYYMMDDhhmmss, YYYY_MM_DD_hh_mm_ss, MM_DD_YYYY_hh_mm_ss, DD_MM_YYYY_hh_mm_ss,
YYYY_MM_DD_hh_mm_ss_mmm, MM_DD_YYYY_hh_mm_ss_mmm, DD_MM_YYYY_hh_mm_ss_mmm
}

Functions

SPL::timestamp createTimestamp (int64_t secs, const SPL::uint32 nanos)

SPL::timestamp createTimestamp (int64_t secs, const SPL::uint32 nanos, const SPL::int32 mid)

SPL::int64 diffAsNanos (const SPL::timestamp &ts1, const SPL::timestamp &ts2)

SPL::float64 diffAsSecs (const SPL::timestamp &ts1, const SPL::timestamp &ts2)

SPL::timestamp add (const SPL::timestamp &ts, const SPL::float64 diff)

SPL::timestamp add (const SPL::timestamp &ts, const SPL::int64 diff)

SPL::int64 getSeconds (const SPL::timestamp &t)

SPL::uint32 getNanoseconds (const SPL::timestamp &t)

SPL::int32 getMachineId (const SPL::timestamp &t)

SPL::decimal128 toDecimal128 (const SPL::timestamp &ts)

SPL::timestamp fromDecimal128 (const SPL::decimal128 &t)

SPL::int64 getCPUCounterInNanoSeconds ()

SPL::timestamp getTimestamp ()

SPL::float64 getTimestampInSecs ()

void time (const SPL::timestamp &time, SPL::Tuple &result)

void time (const SPL::timestamp &time, const SPL::rstring &tzone, SPL::Tuple &result)

void gmtime (const SPL::timestamp &time, SPL::Tuple &result)

SPL::timestamp toTimestamp (const SPL::Tuple &time)

SPL::timestamp toTimestamp (const SPL::Tuple &time, bool defaultZone)

SPL::rstring strftime (const SPL::Tuple &time, const SPL::rstring &format)

void strptime (const SPL::rstring &dateTime, const SPL::rstring &format, SPL::Tuple &result, SPL::uint32 &numCharsProcessed)

SPL::uint32 year (const SPL::timestamp &time)

SPL::uint32 month (const SPL::timestamp &time)

SPL::uint32 day (const SPL::timestamp &time)

SPL::uint32 hour (const SPL::timestamp &time)

SPL::uint32 minute (const SPL::timestamp &time)

SPL::uint32 second (const SPL::timestamp &time)

SPL::uint32 dayOfYear (const SPL::timestamp &time)

SPL::uint32 dayOfWeek (const SPL::timestamp &time)

SPL::uint32 gmyear (const SPL::timestamp &time)

SPL::uint32 gmmonth (const SPL::timestamp &time)

SPL::uint32 gmday (const SPL::timestamp &time)

SPL::uint32 gmhour (const SPL::timestamp &time)

SPL::uint32 gmminute (const SPL::timestamp &time)

SPL::uint32 gmsecond (const SPL::timestamp &time)

SPL::uint32 gmdayOfYear (const SPL::timestamp &time)

SPL::uint32 gmdayOfWeek (const SPL::timestamp &time)

SPL::rstring ctime (const SPL::timestamp &time)

SPL::timestamp timeStringToTimestamp (const SPL::rstring &dmy, const SPL::rstring &hmsmilli, bool useLocaleMonth)

SPL::timestamp timeStringToTimestamp (const SPL::ustring &dmy, const SPL::ustring &hmsmilli, bool useLocaleMonth)

SPL::timestamp timeStringToTimestamp (const SPL::rstring &dmy, const SPL::rstring &hmsmilli, const SPL::rstring &tmzone, bool useLocaleMonth)

SPL::timestamp timeStringToTimestamp (const SPL::ustring &dmy, const SPL::ustring &hmsmilli, const SPL::ustring &tmzone, bool useLocaleMonth)

SPL::timestamp toTimestamp (const Enum &ftype, const char *str)

SPL::timestamp toTimestamp (const Enum &ftype, const SPL::rstring &str)

SPL::timestamp toTimestamp (const Enum &ftype, const SPL::ustring &str)

SPL::timestamp toTimestamp (const Enum &ftype, const SPL::BString &str)

SPL::timestamp toTimestamp (const Enum &ftype, const char *str, const char *tmzone)

SPL::timestamp toTimestamp (const Enum &ftype, const SPL::rstring &str, const SPL::rstring &tmzone)

SPL::timestamp toTimestamp (const Enum &ftype, const SPL::ustring &str, const SPL::ustring &tmzone)

SPL::timestamp toTimestamp (const Enum &ftype, const SPL::BString &str, const SPL::BString &tmzone)

SPL::timestamp timeStringtoTimestamp (const SPL::ustring &dmy, const SPL::ustring &hmsmilli, const SPL::ustring &tmzone, bool useLocaleMonth)

SPL::timestamp timeStringtoTimestamp (const SPL::rstring &dmy, const SPL::rstring &hmsmilli, bool useLocaleMonth)

SPL::timestamp timeStringtoTimestamp (const SPL::ustring &dmy, const SPL::ustring &hmsmilli, bool useLocaleMonth)

SPL::timestamp timeStringtoTimestamp (const SPL::rstring &dmy, const SPL::rstring &hmsmilli, const SPL::rstring &tmzone, bool useLocaleMonth)

Detailed Description

C++ counterparts of SPL native functions that deal with time operations.

Common operations:

To get POSIX time, that is the number of seconds elapsed since the Epoch (00:00:00 UTC, January 1, 1970), use getTimestamp()
To convert POSIX time to broken-down time (Sys.tm structure), use time() or gmtime()
To convert broken-down time to POSIX time, use toTimestamp()
To convert broken-down time to string representation, use strftime()
To convert string representation to broken-down time to, use strptime()

Enumeration Type Documentation

enum SPL::Functions::Time::TimestampFormat

Time Conversion Types Supported formats:

Enumerator:

YYYYMMDDhhmmss

"YYYYMMDDhhmmss"

YYYY_MM_DD_hh_mm_ss

"YYYY-MM-DD hh:mm:ss" (any separator can be used)

MM_DD_YYYY_hh_mm_ss

"MM-DD-YYYY hh:mm:ss" (any separator can be used)

DD_MM_YYYY_hh_mm_ss

"DD-MM-YYYY hh:mm:ss" (any separator can be used)

YYYY_MM_DD_hh_mm_ss_mmm

"YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)

MM_DD_YYYY_hh_mm_ss_mmm

"MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

DD_MM_YYYY_hh_mm_ss_mmm

"DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Function Documentation

SPL::timestamp SPL::Functions::Time::createTimestamp ( int64_t secs,

const SPL::uint32 nanos

)

inline

Create a timestamp.

Parameters:

secs Number of seconds.

nanos Number of nanoseconds.

Returns:: A timestamp (sec, nanos).

SPL::timestamp SPL::Functions::Time::createTimestamp ( int64_t secs,

const SPL::uint32 nanos,

const SPL::int32 mid

)

inline

Create a timestamp.

Parameters:

secs Number of seconds.

nanos Number of nanoseconds.

mid Machine id.

Returns:: A timestamp (sec, nanos, mid).

SPL::int64 SPL::Functions::Time::diffAsNanos ( const SPL::timestamp & ts1,

const SPL::timestamp & ts2

)

inline

Compute the difference between two timestamps (in nanoseconds as int64).

Note:: Valid for ranges of 2^63 nanoseconds (292.47 years).

Parameters:

ts1 First timestamp.

ts2 Second timestamp.

Returns:: The difference ts1 - ts2 in nanoseconds.

SPL::float64 SPL::Functions::Time::diffAsSecs ( const SPL::timestamp & ts1,

const SPL::timestamp & ts2

)

inline

Compute the difference between two timestamps (in seconds as float64).

Note:: Differences of less than 104.24 days retain nanosecond accuracy. Larger differences retain less accuracy.

Parameters:

ts1 First timestamp.

ts2 Second timestamp.

Returns:: The difference ts1 - ts2 in seconds.

SPL::timestamp SPL::Functions::Time::add ( const SPL::timestamp & ts,

const SPL::float64 diff

)

inline

Add a time difference to a timestamp (in seconds as float64).

Parameters:

ts Start time.

diff Difference to add.

Returns:: The timestamp for ts + diff.

SPL::timestamp SPL::Functions::Time::add ( const SPL::timestamp & ts,

const SPL::int64 diff

)

inline

Add a time difference to a timestamp (in nanoseconds as int64).

Parameters:

ts Start time.

diff Difference to add.

Returns:: The timestamp for ts + diff.

SPL::int64 SPL::Functions::Time::getSeconds ( const SPL::timestamp & t )

inline

Extract the seconds from a timestamp.

Parameters:

t Input timestamp.

Returns:: The 'seconds' part of the timestamp.

SPL::uint32 SPL::Functions::Time::getNanoseconds ( const SPL::timestamp & t )

inline

Extract the nanoseconds from a timestamp.

Parameters:

t Input timestamp.

Returns:: The 'nanoseconds' part of the timestamp.

SPL::int32 SPL::Functions::Time::getMachineId ( const SPL::timestamp & t )

inline

Extract the machine id from a timestamp.

Parameters:

t Input timestamp.

Returns:: The 'machineId' part of the timestamp.

SPL::decimal128 SPL::Functions::Time::toDecimal128 ( const SPL::timestamp & ts )

Convert a timestamp to a decimal128 value.

Parameters:

ts Timestamp.

Returns:: Timestamp as a decimal128 value (preserve all bits).

SPL::timestamp SPL::Functions::Time::fromDecimal128 ( const SPL::decimal128 & t )

Convert a decimal128 value to a timestamp.

Parameters:

t Time in seconds.

Returns:: A timestamp that represents the same time.

SPL::int64 SPL::Functions::Time::getCPUCounterInNanoSeconds ( )

Obtain the CPU counter, which is an indication of relative time in nanoseconds.

Note:: This function cannot be used for reliable time measurements across multiple processors.

Returns:: The current processor CPU counter in nanoseconds.

SPL::timestamp SPL::Functions::Time::getTimestamp ( )

Get the current wall clock time.

Returns:: Time since the Epoch (00:00:00 UTC, January 1, 1970).

Note:: This function uses gettimeofday system call on Linux.

Exceptions:

SPLRuntimeException If unable to create timestamp.

SPL::float64 SPL::Functions::Time::getTimestampInSecs ( )

Get the current wall clock time in seconds (fractional).

Returns:: Time since the Epoch (00:00:00 UTC, January 1, 1970).

Note:: This function uses gettimeofday system call on Linux.

Exceptions:

SPLRuntimeException If unable to create timestamp.

void SPL::Functions::Time::time ( const SPL::timestamp & time,

SPL::Tuple & result

)

Convert a timestamp to broken-down time (Sys.tm), using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

result Output tuple (see Sys.tm) representing broken down time.

void SPL::Functions::Time::time ( const SPL::timestamp & time,

const SPL::rstring & tzone,

SPL::Tuple & result

)

Convert a timestamp to broken-down time (Sys.tm), using a specified timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

tzone Timezone to use for conversion.

result Output tuple (see Sys.tm) representing broken down time in the specified timezone.

void SPL::Functions::Time::gmtime ( const SPL::timestamp & time,

SPL::Tuple & result

)

Convert a timestamp to broken-down time (Sys.tm) using UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

result Output tuple (see Sys.tm) representing broken down time in UTC.

SPL::timestamp SPL::Functions::Time::toTimestamp ( const SPL::Tuple & time )

Convert a broken-down time (Sys.tm) into a timestamp containing the time since the Epoch.

Parameters:

time Broken-down time tuple.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const SPL::Tuple & time,

bool defaultZone

)

Convert a broken-down time (Sys.tm) into a timestamp containing the time since the Epoch. Additional parameter to specify using default time zone

Parameters:

time Broken-down time tuple.

defaultZone If 'true', then use default time zone.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::rstring SPL::Functions::Time::strftime ( const SPL::Tuple & time,

const SPL::rstring & format

)

Convert broken-down time (Sys.tm) to a date and time string.

Parameters:

time Broken-down time (Sys.tm) representing the desired time.

format Date and time format string (see man page for strptime).

Returns:: String representation of date and time.

Note:: This function is POSIX compliant, and uses the current locale.

void SPL::Functions::Time::strptime ( const SPL::rstring & dateTime,

const SPL::rstring & format,

SPL::Tuple & result,

SPL::uint32 & numCharsProcessed

)

Convert a date and time string to broken-down time (Sys.tm).

Parameters:

dateTime String representation of date/time.

format Date and time format string (see man page for strptime).

result Broken-down time (Sys.tm) corresponding to the date and time string.

numCharsProcessed Number of characters successfully consumed from dateTime.

Note:: This function is POSIX compliant, and uses the current locale.

SPL::uint32 SPL::Functions::Time::year ( const SPL::timestamp & time )

Extract the year from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The year component of the time.

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::month ( const SPL::timestamp & time )

Extract the month from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The month component of the time (in the range [0,11]).

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::day ( const SPL::timestamp & time )

Extract the day of month from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The day component of the time (in the range [1,31]).

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::hour ( const SPL::timestamp & time )

Extract the hour from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The hour component of the time (in the range [0,23]).

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::minute ( const SPL::timestamp & time )

Extract the minute from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The minute component of the time (in the range [0,59]).

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::second ( const SPL::timestamp & time )

Extract the second from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The second component of the time (in the range [0,61]).

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::dayOfYear ( const SPL::timestamp & time )

Extract the day of year from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The day component of the time (in the range [0,365]).

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::dayOfWeek ( const SPL::timestamp & time )

Extract the day of week from the time, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The day component of the time (in the range [0,6], 0 = Sunday).

Note:: This function uses the POSIX localtime_r routine.

SPL::uint32 SPL::Functions::Time::gmyear ( const SPL::timestamp & time )

Extract the year from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The year component of the time.

Note:: This function uses the POSIX gmtime_r routine.

SPL::uint32 SPL::Functions::Time::gmmonth ( const SPL::timestamp & time )

Extract the month from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The month component of the time (in the range [0,11]).

Note:: This function uses the POSIX gmtime_r routine.

SPL::uint32 SPL::Functions::Time::gmday ( const SPL::timestamp & time )

Extract the day of month from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The day component of the time (in the range [1,31]).

Note:: This function uses the POSIX gmtime_r routine.

SPL::uint32 SPL::Functions::Time::gmhour ( const SPL::timestamp & time )

Extract the hour from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The hour component of the time (in the range [0,23]).

Note:: This function uses the POSIX gmtime_r routine.

SPL::uint32 SPL::Functions::Time::gmminute ( const SPL::timestamp & time )

Extract the minute from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The minute component of the time (in the range [0,59]).

Note:: This function uses the POSIX gmtime_r routine.

SPL::uint32 SPL::Functions::Time::gmsecond ( const SPL::timestamp & time )

Extract the second from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The second component of the time (in the range [0,61]).

Note:: This function uses the POSIX gmtime_r routine.

SPL::uint32 SPL::Functions::Time::gmdayOfYear ( const SPL::timestamp & time )

Extract the day of year from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The day component of the time (in the range [0,365]).

Note:: This function uses the POSIX gmtime_r routine.

SPL::uint32 SPL::Functions::Time::gmdayOfWeek ( const SPL::timestamp & time )

Extract the day of week from the time, using the UTC timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: The day component of the time (in the range [0,6], 0 = Sunday).

Note:: This function uses the POSIX gmtime_r routine.

SPL::rstring SPL::Functions::Time::ctime ( const SPL::timestamp & time )

Convert a time value to a date and time string, using the current timezone.

Parameters:

time Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

Returns:: String representation of date and time in the form "Wed Jun 30 21:49:08 1993\n", using the C locale.

SPL::timestamp SPL::Functions::Time::timeStringToTimestamp ( const SPL::rstring & dmy,

const SPL::rstring & hmsmilli,

bool useLocaleMonth

)

Converts date and time strings into a timestamp containing the time since the Epoch, using the current timezone.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp() is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::timeStringToTimestamp ( const SPL::ustring & dmy,

const SPL::ustring & hmsmilli,

bool useLocaleMonth

)

Converts date and time strings into a timestamp containing the time since the Epoch, using the current timezone.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::timeStringToTimestamp ( const SPL::rstring & dmy,

const SPL::rstring & hmsmilli,

const SPL::rstring & tmzone,

bool useLocaleMonth

)

Converts date and time strings into a timestamp containing the time since the Epoch, using the specified timezone.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

tmzone Time zone (e.g., "UTC").

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::timeStringToTimestamp ( const SPL::ustring & dmy,

const SPL::ustring & hmsmilli,

const SPL::ustring & tmzone,

bool useLocaleMonth

)

Converts date and time strings into a timestamp containing the time since the Epoch, using the specified timezone.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

tmzone Time zone (e.g., "UTC").

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const char * str

)

Converts a date and time string into a timestamp containing the time since the Epoch, using the current time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const SPL::rstring & str

)

inline

Converts a date and time string into a timestamp containing the time since the Epoch, using the current time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const SPL::ustring & str

)

inline

Converts a date and time string into a timestamp containing the time since the Epoch, using the current time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const SPL::BString & str

)

inline

Converts a date and time string into a timestamp containing the time since the Epoch, using the current time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const char * str,

const char * tmzone

)

Converts a date and time string into a timestamp containing the time since the Epoch, using the specified time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

tmzone A string with the timezone.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const SPL::rstring & str,

const SPL::rstring & tmzone

)

inline

Converts a date and time string into a timestamp containing the time since the Epoch, using the specified time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

tmzone A string with the timezone.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const SPL::ustring & str,

const SPL::ustring & tmzone

)

inline

Converts a date and time string into a timestamp containing the time since the Epoch, using the specified time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

tmzone A string with the timezone.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::toTimestamp ( const Enum & ftype,

const SPL::BString & str,

const SPL::BString & tmzone

)

inline

Converts a date and time string into a timestamp containing the time since the Epoch, using the specified time zone. Supported formats:

Sys.YYYYMMDDhhmmss: "YYYYMMDDhhmmss"
Sys.YYYY_MM_DD_hh_mm_ss: "YYYY-MM-DD hh:mm:ss" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss: "MM-DD-YYYY hh:mm:ss" (any separator can be used)
Sys.DD_MM_YYYY_hh_mm_ss: "DD-MM-YYYY hh:mm:ss" (any separator can be used)
Sys.YYYY_MM_DD_hh_mm_ss_mmm: "YYYY-MM-DD hh:mm:ss.mmm" (any separator can be used)
Sys.MM_DD_YYYY_hh_mm_ss_mmm: "MM-DD-YYYY hh:mm:ss.mmm" (any separator can be used)

Sys.DD_MM_YYYY_hh_mm_ss_mmm: "DD-MM-YYYY hh:mm:ss.mmm" (any separator can be used)

Parameters:

ftype The format of the string (e.g., Sys.YYYY_MM_DD_hh_mm_ss_mmm).

str A string with the specified format.

tmzone A string with the timezone.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::timeStringtoTimestamp ( const SPL::ustring & dmy,

const SPL::ustring & hmsmilli,

const SPL::ustring & tmzone,

bool useLocaleMonth

)

DEPRECATED. Please replace with timeStringToTimestamp. Converts date and time strings into a timestamp containing the time since the Epoch, using the specified timezone.

Note:: DEPRECATED. Please replace with timeStringToTimestamp.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

tmzone Time zone (e.g., "UTC").

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::timeStringtoTimestamp ( const SPL::rstring & dmy,

const SPL::rstring & hmsmilli,

bool useLocaleMonth

)

DEPRECATED. Please replace with timeStringToTimestamp. Converts date and time strings into a timestamp containing the time since the Epoch, using the current timezone.

Note:: DEPRECATED. Please replace with timeStringToTimestamp.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::timeStringtoTimestamp ( const SPL::ustring & dmy,

const SPL::ustring & hmsmilli,

bool useLocaleMonth

)

DEPRECATED. Please replace with timeStringToTimestamp. Converts date and time strings into a timestamp containing the time since the Epoch, using the current timezone.

Note:: DEPRECATED. Please replace with timeStringToTimestamp.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).

SPL::timestamp SPL::Functions::Time::timeStringtoTimestamp ( const SPL::rstring & dmy,

const SPL::rstring & hmsmilli,

const SPL::rstring & tmzone,

bool useLocaleMonth

)

DEPRECATED. Please replace with timeStringToTimestamp. Converts date and time strings into a timestamp containing the time since the Epoch, using the specified timezone.

Note:: DEPRECATED. Please replace with timeStringToTimestamp.

Parameters:

dmy A string with a format of the form "04-OCT-2005".

hmsmilli A string with a format of the form "14:18:19.324".

tmzone Time zone (e.g., "UTC").

useLocaleMonth If 'true', current locale is used for month names. If 'false', C locale is assumed. Performance of timeStringToTimestamp is greater with useLocaleMonth == 'false'.

Returns:: Seconds since the Epoch (00:00:00 UTC, January 1, 1970).