C++ counterparts of SPL native functions that provide general utilities. More...

Functions

void abort (const std::string &file, uint32_t line)

a unique name generation for parameters and files.

SPL::boolean isTraceable (const Enum &traceLevel)

void appTrc (const Enum &traceLevel, const std::string &message, const std::string &aspect, const std::string &file, uint32_t line)

void appTrc (const Enum &traceLevel, const SPL::ustring &message, const SPL::ustring &aspect, const std::string &file, uint32_t line)

void appTrc (const Enum &traceLevel, const SPL::BString &message, const SPL::BString &aspect, const std::string &file, uint32_t line)

void appTrc (const Enum &traceLevel, const SPL::rstring &message, const std::string &file, uint32_t line)

void appTrc (const Enum &traceLevel, const SPL::ustring &message, const std::string &file, uint32_t line)

SPL::boolean isLoggable (const Enum &logLevel)

void appLog (const Enum &logLevel, const std::string &message, const std::string &aspect, const std::string &file, uint32_t line)

void appLog (const Enum &logLevel, const SPL::ustring &message, const SPL::ustring &aspect, const std::string &file, uint32_t line)

void appLog (const Enum &logLevel, const SPL::BString &message, const SPL::BString &aspect, const std::string &file, uint32_t line)

void appLog (const Enum &logLevel, const SPL::rstring &message, const std::string &file, uint32_t line)

void appLog (const Enum &logLevel, const SPL::ustring &message, const std::string &file, uint32_t line)

void log (const Enum &logLevel, const std::string &message, const std::string &aspect, const std::string &file, uint32_t line)

void log (const Enum &logLevel, const SPL::ustring &message, const SPL::ustring &aspect, const std::string &file, uint32_t line)

void log (const Enum &logLevel, const SPL::BString &message, const SPL::BString &aspect, const std::string &file, uint32_t line)

void log (const Enum &logLevel, const SPL::rstring &message, const std::string &file, uint32_t line)

void log (const Enum &logLevel, const SPL::ustring &message, const std::string &file, uint32_t line)

void shutdownPE ()

Shutdown the current processing element (PE).

SPL::boolean isShutdown ()

void block (double const time)

SPL::int32 getChannel ()

SPL::int32 getMaxChannels ()

SPL::rstring getThisOperatorName ()

SPL::rstring getThisOperatorLogicalName ()

SPL::rstring getEnvironmentVariable (SPL::rstring const &name)

SPL::rstring getEnvironmentVariable (SPL::rstring const &name, SPL::rstring const &defaultValue)

SPL::rstring getEnvironmentVariable (SPL::rstring const &name, SPL::boolean &isSet)

void getInputPortMetricValue (SPL::uint32 port, int name, SPL::int64 &value)

void getInputPortMetricValue (SPL::uint32 port, const SPL::Enum &name, SPL::int64 &value)

void getOutputPortMetricValue (SPL::uint32 port, int name, SPL::int64 &value)

void getOutputPortMetricValue (SPL::uint32 port, const SPL::Enum &name, SPL::int64 &value)

void getCustomMetricValue (SPL::rstring const &name, SPL::int64 &value)

void getCustomMetricValue (SPL::ustring const &name, SPL::int64 &value)

void setCustomMetricValue (SPL::rstring const &name, SPL::int64 value)

void setCustomMetricValue (SPL::ustring const &name, SPL::int64 value)

void createCustomMetric (SPL::rstring const &name, SPL::rstring const &description, const Enum &kind, SPL::int64 value)

void createCustomMetric (SPL::ustring const &name, SPL::ustring const &description, const Enum &kind, SPL::int64 value)

bool hasCustomMetric (SPL::rstring const &name)

bool hasCustomMetric (SPL::ustring const &name)

SPL::list< SPL::rstring > getCustomMetricNames ()

SPL::rstring formatNumber (const SPL::int64 value)

SPL::rstring formatNumber (const SPL::int64 value, SPL::uint32 width)

SPL::rstring formatNumber (const SPL::float64 value)

SPL::rstring formatNumber (const SPL::float64 value, SPL::uint32 width, SPL::uint32 precision, bool scientific)

SPL::int32 parseNumber (SPL::int64 &number, SPL::rstring const &text, SPL::int32 base)

SPL::int32 parseNumber (SPL::int64 &number, SPL::rstring const &text)

SPL::int32 parseNumber (SPL::int64 &number, SPL::ustring const &text)

SPL::int32 parseNumber (SPL::float64 &number, SPL::rstring const &text)

SPL::int32 parseNumber (SPL::float64 &number, SPL::ustring const &text)

SPL::rstring strerror (const SPL::int32 errnum)

SPL::uint64 strtoull (const SPL::rstring &value, SPL::int32 base)

SPL::uint64 strtoull (const SPL::rstring &value, SPL::int32 base, SPL::int32 &numCharsProcessed)

SPL::int64 strtoll (const SPL::rstring &value, SPL::int32 base)

SPL::int64 strtoll (const SPL::rstring &value, SPL::int32 base, SPL::int32 &numCharsProcessed)

SPL::float64 strtod (const SPL::rstring &value)

SPL::float64 strtod (const SPL::rstring &value, SPL::int32 &numCharsProcessed)

template<class T >

void print (const T &t)

void printStringLn (const SPL::rstring &s)

void printStringLn (const SPL::BString &s)

void printStringLn (const SPL::ustring &s)

void printString (const SPL::rstring &s)

void printString (const SPL::BString &s)

void printString (const SPL::ustring &s)

template<class T >

void println (const T &t)

void flushStdio ()

void assignFrom (SPL::Tuple &lhs, SPL::Tuple const &rhs)

template<class T >

SPL::uint64 hashCode (const T &v)

template<class T >

SPL::list< SPL::uint64 > hashCodeForEach (const SPL::list< T > &l)

template<class T , int32_t N>

SPL::list< SPL::uint64 > hashCodeForEach (const SPL::blist< T, N > &l)

SPL::rstring dataDirectory ()

Miscellaneous.

template<class T >

void swap (T &s1, T &s2)

SPL::rstring mktemp (const SPL::rstring &templat)

SPL::uint64 jobID ()

SPL::rstring getJobName ()

SPL::rstring getJobGroup ()

SPL::rstring getApplicationName ()

SPL::uint64 PEID ()

SPL::rstring instanceID ()

SPL::rstring domainID ()

SPL::uint32 getRelaunchCount ()

SPL::boolean isControlInputPort (uint32 port)

SPL::boolean isConsistentInputPort (uint32 port)

SPL::boolean isInConsistentRegion ()

SPL::boolean isStartOfConsistentRegion ()

SPL::boolean isEndOfConsistentRegion ()

SPL::boolean isTriggerOfConsistentRegion ()

SPL::int32 getConsistentRegionIndex ()

SPL::int64 getSequenceId ()

SPL::float64 getDrainTimeout ()

SPL::float64 getResetTimeout ()

SPL::int32 getResetAttempt ()

void resetConsistentRegion ()

SPL::boolean evalPredicate (const SPL::rstring &splExpr, const Tuple &tuple, SPL::int32 &error)

SPL::rstring getHostName ()

SPL::rstring getShortHostName ()

SPL::rstring getConfiguredHostName ()

SPL::rstring getIPAddress ()

SPL::int32 getOutputPortExportProperties (List &properties, uint32 port)

SPL::int32 setOutputPortExportProperties (const List &properties, uint32 port)

SPL::int32 setOutputPortExportProperties (const Tuple &properties, uint32 port)

SPL::rstring getInputPortImportSubscription (uint32 port, SPL::int32 &error)

SPL::int32 setInputPortImportSubscription (const SPL::rstring &subscription, uint32 port)

SPL::rstring getInputPortImportFilterExpression (uint32 port, SPL::int32 &error)

SPL::int32 setInputPortImportFilterExpression (const SPL::rstring &filter, uint32 port)

SPL::rstring loadAndFormatResource (const SPL::rstring &toolkitName, const SPL::rstring &bundleName, const SPL::rstring &resourceID, const Tuple &substitutionValues)

SPL::rstring loadAndFormatResource (const SPL::rstring &toolkitName, const SPL::rstring &bundleName, const SPL::rstring &resourceID, const Tuple &substitutionValues, const SPL::rstring &locale)

SPL::rstring loadAndFormatResource (const SPL::rstring &toolkitName, const SPL::rstring &bundleName, const SPL::rstring &resourceID)

SPL::rstring loadAndFormatResource (const SPL::rstring &toolkitName, const SPL::rstring &bundleName, const SPL::rstring &resourceID, const SPL::rstring &locale)

SPL::int32 getPEOutputPortConnections (uint32 port, SPL::List &connections)

SPL::int32 getOutputPortCongestionFactor (uint32 port)

Detailed Description

C++ counterparts of SPL native functions that provide general utilities.

Function Documentation

void SPL::Functions::Utility::abort ( const std::string & file,

uint32_t line

)

inline

a unique name generation for parameters and files.

Abort program execution.

Parameters:

file SPL filename at abort call.

line SPL line number at abort call.

SPL::boolean SPL::Functions::Utility::isTraceable ( const Enum & traceLevel )

Determine whether a message at the given level would be traced.

Parameters:

traceLevel Classification of log level (error/warn/info/debug/trace). Use the Level enumeration in the spl::Trace composite to specify the trace level.

Returns:: The value 'true' if a message at the given traceLevel would be traced.

void SPL::Functions::Utility::appTrc ( const Enum & traceLevel,

const std::string & message,

const std::string & aspect,

const std::string & file,

uint32_t line

)

Log a message in the tracing system.

Parameters:

traceLevel Classification of log level (error/warn/info/debug/trace). Use the Level enumeration in the spl::Trace composite to specify the trace level.

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at appTrc call.

line SPL line number at appTrc call.

void SPL::Functions::Utility::appTrc ( const Enum & traceLevel,

const SPL::ustring & message,

const SPL::ustring & aspect,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Parameters:

traceLevel Classification of log level (error/warn/info/debug/trace). Use the Level enumeration in the spl::Trace composite to specify the trace level.

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at appTrc call.

line SPL line number at appTrc call.

void SPL::Functions::Utility::appTrc ( const Enum & traceLevel,

const SPL::BString & message,

const SPL::BString & aspect,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Parameters:

traceLevel Classification of log level (error/warn/info/debug/trace). Use the Level enumeration in the spl::Trace composite to specify the trace level.

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at appTrc call.

line SPL line number at appTrc call.

void SPL::Functions::Utility::appTrc ( const Enum & traceLevel,

const SPL::rstring & message,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Parameters:

traceLevel Classification of log level (error/warn/info/debug/trace). Use the Level enumeration in the spl::Trace composite to specify the trace level.

message Message to be logged.

file SPL filename at appTrc call.

line SPL line number at appTrc call.

void SPL::Functions::Utility::appTrc ( const Enum & traceLevel,

const SPL::ustring & message,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Parameters:

traceLevel Classification of appTrc level (error/warn/info/debug/trace). Use the Level enumeration in the spl::Trace composite to specify the trace level.

message Message to be logged.

file SPL filename at appTrc call.

line SPL line number at appTrc call.

SPL::boolean SPL::Functions::Utility::isLoggable ( const Enum & logLevel )

Determine whether a message at the given level would be logged.

Parameters:

logLevel Classification of log level (error/warn/info). Use the Level enumeration in the spl::Log composite to specify the log level.

Returns:: The value 'true' if a message at the given logLevel would be logged.

void SPL::Functions::Utility::appLog ( const Enum & logLevel,

const std::string & message,

const std::string & aspect,

const std::string & file,

uint32_t line

)

Log a message in the logging system.

Parameters:

logLevel Classification of log level (error/warn/info). Use the Level enumeration in the spl::Log composite to specify the log level.

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at appLog call.

line SPL line number at appLog call.

void SPL::Functions::Utility::appLog ( const Enum & logLevel,

const SPL::ustring & message,

const SPL::ustring & aspect,

const std::string & file,

uint32_t line

)

inline

Log a message in the logging system.

Parameters:

logLevel Classification of log level (error/warn/info). Use the Level enumeration in the spl::Log composite to specify the log level.

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at appLog call.

line SPL line number at appLog call.

void SPL::Functions::Utility::appLog ( const Enum & logLevel,

const SPL::BString & message,

const SPL::BString & aspect,

const std::string & file,

uint32_t line

)

inline

Log a message in the logging system.

Parameters:

logLevel Classification of log level (error/warn/info). Use the Level enumeration in the spl::Log composite to specify the log level.

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at appLog call.

line SPL line number at appLog call.

void SPL::Functions::Utility::appLog ( const Enum & logLevel,

const SPL::rstring & message,

const std::string & file,

uint32_t line

)

inline

Log a message in the logging system.

Parameters:

logLevel Classification of log level (error/warn/info). Use the Level enumeration in the spl::Log composite to specify the log level.

message Message to be logged.

file SPL filename at appLog call.

line SPL line number at appLog call.

void SPL::Functions::Utility::appLog ( const Enum & logLevel,

const SPL::ustring & message,

const std::string & file,

uint32_t line

)

inline

Log a message in the logging system.

Parameters:

logLevel Classification of log level (error/warn/info). Use the Level enumeration in the spl::Log composite to specify the log level.

message Message to be logged.

file SPL filename at appLog call.

line SPL line number at appLog call.

void SPL::Functions::Utility::log ( const Enum & logLevel,

const std::string & message,

const std::string & aspect,

const std::string & file,

uint32_t line

)

Log a message in the tracing system.

Note:: Deprecated - use appTrc.

Parameters:

logLevel Classification of log level (error/info/debug/trace).

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at log call.

line SPL line number at log call.

void SPL::Functions::Utility::log ( const Enum & logLevel,

const SPL::ustring & message,

const SPL::ustring & aspect,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Note:: Deprecated - use appTrc.

Parameters:

logLevel Classification of log level (error/info/debug/trace).

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at log call.

line SPL line number at log call.

void SPL::Functions::Utility::log ( const Enum & logLevel,

const SPL::BString & message,

const SPL::BString & aspect,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Note:: Deprecated - use appTrc.

Parameters:

logLevel Classification of log level (error/info/debug/trace).

message Message to be logged.

aspect Message category (for filtering).

file SPL filename at log call.

line SPL line number at log call.

void SPL::Functions::Utility::log ( const Enum & logLevel,

const SPL::rstring & message,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Note:: Deprecated - use appTrc.

Parameters:

logLevel Classification of log level (error/info/debug/trace).

message Message to be logged.

file SPL filename at log call.

line SPL line number at log call.

void SPL::Functions::Utility::log ( const Enum & logLevel,

const SPL::ustring & message,

const std::string & file,

uint32_t line

)

inline

Log a message in the tracing system.

Note:: Deprecated - use appTrc.

Parameters:

logLevel Classification of log level (error/info/debug/trace).

message Message to be logged.

file SPL filename at log call.

line SPL line number at log call.

void SPL::Functions::Utility::shutdownPE ( )

Shutdown the current processing element (PE).

SPL::boolean SPL::Functions::Utility::isShutdown ( )

Check if shutdown is requested.

Returns:: The value 'true' if the system is shutting down.

void SPL::Functions::Utility::block ( double const time )

Block until shutdown is requested, or the specified amount of time has elapsed, whichever comes first.

Parameters:

time Maximum wait time in seconds (could be fractional).

SPL::int32 SPL::Functions::Utility::getChannel ( )

Get the parallel channel index.

Returns:: The index of the parallel channel.

SPL::int32 SPL::Functions::Utility::getMaxChannels ( )

Get the maximum number of parallel channels.

Returns:: The maximum number of parallel channels.

SPL::rstring SPL::Functions::Utility::getThisOperatorName ( )

Get the physical name of the operator.

Returns:: The physical name of the operator.

SPL::rstring SPL::Functions::Utility::getThisOperatorLogicalName ( )

Get the logical name of the operator.

Returns:: The logical name of the operator.

SPL::rstring SPL::Functions::Utility::getEnvironmentVariable ( SPL::rstring const & name )

Get the value of an environment variable.

Parameters:

name Environment variable name.

Returns:: The value for the environment variable, or empty string if not set.

SPL::rstring SPL::Functions::Utility::getEnvironmentVariable ( SPL::rstring const & name,

SPL::rstring const & defaultValue

)

Get the value of an environment variable.

Parameters:

name Environment variable name.

defaultValue Default value for the environment variable.

Returns:: The value for the environment variable if set, otherwise the default value.

SPL::rstring SPL::Functions::Utility::getEnvironmentVariable ( SPL::rstring const & name,

SPL::boolean & isSet

)

Get the value of an environment variable.

Parameters:

name Environment variable name.

isSet This parameter is set to 'true' if the environment variable is found, otherwise to 'false'. This parameter can be used to differentiate between an empty value and an unset variable.

Returns:: The value for the environment variable, or empty string if not set.

void SPL::Functions::Utility::getInputPortMetricValue ( SPL::uint32 port,

int name,

SPL::int64 & value

)

Get the specified input port metric value for the current operator.

Parameters:

port Input port index.

name The name of the metric.

value Value of the specified input port metric for the current operator.

Exceptions:

SPLRuntimeInvalidIndexException If the port is out of bounds.

void SPL::Functions::Utility::getInputPortMetricValue ( SPL::uint32 port,

const SPL::Enum & name,

SPL::int64 & value

)

inline

void SPL::Functions::Utility::getOutputPortMetricValue ( SPL::uint32 port,

int name,

SPL::int64 & value

)

Get the specified output port metric value for the current operator.

Parameters:

port Input port index.

name The name of the metric.

value Value of the specified input port metric for the current operator.

Exceptions:

SPLRuntimeInvalidIndexException If the port is out of bounds.

void SPL::Functions::Utility::getOutputPortMetricValue ( SPL::uint32 port,

const SPL::Enum & name,

SPL::int64 & value

)

inline

void SPL::Functions::Utility::getCustomMetricValue ( SPL::rstring const & name,

SPL::int64 & value

)

Get the specified custom metric value for the current operator.

Parameters:

name The name of the metric.

value Value of the specified custom metric for the current operator.

Exceptions:

SPLRuntimeInvalidMetricException If the metric does not exist.

void SPL::Functions::Utility::getCustomMetricValue ( SPL::ustring const & name,

SPL::int64 & value

)

inline

Get the specified custom metric value for the current operator.

Parameters:

name The name of the metric.

value Value of the specified custom metric for the current operator.

Exceptions:

SPLRuntimeInvalidMetricException If the metric does not exist.

void SPL::Functions::Utility::setCustomMetricValue ( SPL::rstring const & name,

SPL::int64 value

)

Set the specified custom metric value for the current operator.

Parameters:

name The name of the metric.

value Value to use.

Exceptions:

SPLRuntimeInvalidMetricException If the metric does not exist.

void SPL::Functions::Utility::setCustomMetricValue ( SPL::ustring const & name,

SPL::int64 value

)

inline

Set the specified custom metric value for the current operator.

Parameters:

name The name of the metric.

value Value to use.

Exceptions:

SPLRuntimeInvalidMetricException If the metric does not exist.

void SPL::Functions::Utility::createCustomMetric ( SPL::rstring const & name,

SPL::rstring const & description,

const Enum & kind,

SPL::int64 value

)

Create the specified custom metric for the current operator and set its initial value.

Parameters:

name The name of the metric.

value The initial value for the metric.

description A description of the metric.

kind The kind of the metric (Metric::Gauge, Metric::Counter, or Metric::Time).

Exceptions:

SPLRuntimeInvalidMetricException If the metric already exists.

void SPL::Functions::Utility::createCustomMetric ( SPL::ustring const & name,

SPL::ustring const & description,

const Enum & kind,

SPL::int64 value

)

inline

Create the specified custom metric for the current operator and set its initial value.

Parameters:

name The name of the metric.

value The initial value for the metric.

description A description of the metric.

kind The kind of the metric (Gauge, Counter, or Time).

Exceptions:

SPLRuntimeInvalidMetricException If the metric already exists.

bool SPL::Functions::Utility::hasCustomMetric ( SPL::rstring const & name )

Check if the specified custom metric exists.

Parameters:

name The name of the metric.

Returns:: The value 'true' if the custom metric exists, otherwise 'false'.

bool SPL::Functions::Utility::hasCustomMetric ( SPL::ustring const & name )

inline

Check if the specified custom metric exists.

Parameters:

name The name of the metric.

Returns:: The value 'true' if the custom metric exists, otherwise 'false'.

SPL::list<SPL::rstring> SPL::Functions::Utility::getCustomMetricNames ( )

Return the names of the custom metrics for the current operator.

Returns:: List of names of custom metrics.

SPL::rstring SPL::Functions::Utility::formatNumber ( const SPL::int64 value )

Format an integer using locale specific format. The number is returned as a string with the locale specific grouping.

Parameters:

value Value to be formatted.

Returns:: The input value as a string using locale specific number format.

SPL::rstring SPL::Functions::Utility::formatNumber ( const SPL::int64 value,

SPL::uint32 width

)

Format an integer using locale specific format. The number is returned as a string with the locale specific grouping.

Parameters:

value Value to be formatted.

width Minimal field width.

Returns:: The input value as a string using locale specific number format.

SPL::rstring SPL::Functions::Utility::formatNumber ( const SPL::float64 value )

Format a float using locale specific format. The number is returned as a string with the locale specific grouping and decimal point.

Parameters:

value Value to be formatted.

Returns:: The input value as a string using locale specific number format.

SPL::rstring SPL::Functions::Utility::formatNumber ( const SPL::float64 value,

SPL::uint32 width,

SPL::uint32 precision,

bool scientific

)

Format a float using locale specific format. The number is returned as a string with the locale specific grouping and decimal point.

Parameters:

value Value to be formatted.

width Minimal field width.

precision Number of digits of precision.

scientific Set to 'true' if scientific form should be used.

Returns:: The input value as a string using locale specific number format.

SPL::int32 SPL::Functions::Utility::parseNumber ( SPL::int64 & number,

SPL::rstring const & text,

SPL::int32 base

)

Parse a string that represents a number, using the current locale. This function exposes the full capability of the underlying strtoll function.

Parameters:

text String to parse.

number Variable to store the result.

base 0, or a number between 2 and 36 inclusive.

Returns:: The number of bytes read on success, -1 otherwise.

SPL::int32 SPL::Functions::Utility::parseNumber ( SPL::int64 & number,

SPL::rstring const & text

)

Parse a string that represents a base 10 number, using the current locale.

Parameters:

text String to parse.

number Variable to store the result.

Returns:: The number of bytes read on success, -1 otherwise.

SPL::int32 SPL::Functions::Utility::parseNumber ( SPL::int64 & number,

SPL::ustring const & text

)

Parse a string that represents a number, using the current locale.

Parameters:

text String to parse.

number Variable to store the result.

Returns:: The number of bytes read on success, -1 otherwise.

SPL::int32 SPL::Functions::Utility::parseNumber ( SPL::float64 & number,

SPL::rstring const & text

)

Parse a string that represents a number, using the current locale.

Note:: This function is implemented using ICU and does not accept 'e' as the exponent character. Use 'E' instead (e.g. 1.05E+3).

Parameters:

text String to parse.

number Variable to store the result.

Returns:: The number of bytes read on success, -1 otherwise.

SPL::int32 SPL::Functions::Utility::parseNumber ( SPL::float64 & number,

SPL::ustring const & text

)

Parse a string that represents a number, using the current locale.

Note:: This function is implemented using ICU and does not accept 'e' as the exponent character. Use 'E' instead (e.g. 1.05E+3).

Parameters:

text String to parse.

number Variable to store the result.

Returns:: The number of bytes read on success, -1 otherwise.

SPL::rstring SPL::Functions::Utility::strerror ( const SPL::int32 errnum )

Convert an errno value to a string for intelligent printing.

Parameters:

errnum Error number to convert to a string description.

Returns:: String description of errnum.

SPL::uint64 SPL::Functions::Utility::strtoull ( const SPL::rstring & value,

SPL::int32 base

)

inline

Convert a string in base 2 to 36 to an unsigned number. See POSIX strtoull.

Parameters:

value String to convert.

base Conversion base. If 0, use leading characters to decide. Otherwise must be 2>= base <= 36.

Returns:: String converted to a uint64.

SPL::uint64 SPL::Functions::Utility::strtoull ( const SPL::rstring & value,

SPL::int32 base,

SPL::int32 & numCharsProcessed

)

inline

Convert a string in base 2 to 36 to an unsigned number. See POSIX strtoull.

Parameters:

value String to convert.

base Conversion base. If 0, use leading characters to decide. Otherwise must be 2>= base <= 36.

numCharsProcessed Number of characters consumed from value during the conversion, or -1 if the conversion failed (invalid base or result out of range).

Returns:: String converted to a uint64.

SPL::int64 SPL::Functions::Utility::strtoll ( const SPL::rstring & value,

SPL::int32 base

)

inline

Convert a string in base 2 to 36 to an signed number. See POSIX strtoll.

Parameters:

value String to convert.

base Conversion base. If 0, use leading characters to decide. Otherwise must be 2>= base <= 36.

Returns:: String converted to an int64.

SPL::int64 SPL::Functions::Utility::strtoll ( const SPL::rstring & value,

SPL::int32 base,

SPL::int32 & numCharsProcessed

)

inline

Convert a string in base 2 to 36 to an signed number. See POSIX strtoll.

Parameters:

value String to convert.

base Conversion base. If 0, use leading characters to decide. Otherwise must be 2>= base <= 36.

numCharsProcessed Number of characters consumed from value during the conversion, or -1 if the conversion failed (invalid base or result out of range).

Returns:: String converted to a int64.

SPL::float64 SPL::Functions::Utility::strtod ( const SPL::rstring & value )

inline

Convert a string to a floating point number. See POSIX strtod.

Parameters:

value String to convert.

Returns:: String converted to a float64.

SPL::float64 SPL::Functions::Utility::strtod ( const SPL::rstring & value,

SPL::int32 & numCharsProcessed

)

inline

Convert a string to a floating point number. See POSIX strtod.

Parameters:

value String to convert.

numCharsProcessed Number of characters consumed from value during the conversion, or -1 if the conversion failed (result out of range).

Returns:: String converted to a float64.

template<class T >

void SPL::Functions::Utility::print ( const T & t )

inline

Write any SPL type to stdout as an SPL literal. For example, strings are quoted, and characters escaped. If you want to print strings without using the string literal format, use the printString function instead. The output is not flushed.

Parameters:

t Value to print.

void SPL::Functions::Utility::printStringLn ( const SPL::rstring & s )

inline

Write a string to stdout, followed by a newline, and then the output is flushed.

Parameters:

s String to print.

void SPL::Functions::Utility::printStringLn ( const SPL::BString & s )

inline

Write a string to stdout, followed by a newline, and then the output is flushed.

Parameters:

s String to print.

void SPL::Functions::Utility::printStringLn ( const SPL::ustring & s )

inline

Write a string to stdout, followed by a newline, and then the output is flushed.

Parameters:

s String to print.

void SPL::Functions::Utility::printString ( const SPL::rstring & s )

inline

Write a string to stdout. The output is not flushed.

Parameters:

s String to print.

void SPL::Functions::Utility::printString ( const SPL::BString & s )

inline

Write a string to stdout. The output is not flushed.

Parameters:

s String to print.

void SPL::Functions::Utility::printString ( const SPL::ustring & s )

inline

Write a string to stdout. The output is not flushed.

Parameters:

s String to print.

template<class T >

void SPL::Functions::Utility::println ( const T & t )

inline

Write any SPL type to stdout, in serialized form, followed by a newline. For example, strings are quoted, and characters escaped. The output is then flushed.

Parameters:

t Value to print.

void SPL::Functions::Utility::flushStdio ( )

inline

Flush all stdio output streams. Will ensure printString and print output is written to standard output.

void SPL::Functions::Utility::assignFrom ( SPL::Tuple & lhs,

SPL::Tuple const & rhs

)

inline

Assign matching fields of a tuple from another one.

Parameters:

lhs Destination tuple.

rhs Source tuple.

template<class T >

SPL::uint64 SPL::Functions::Utility::hashCode ( const T & v )

inline

Compute the hash of a value.

The hash function is designed to return a fixed output value for a given input value, and to reduce the likelihood of returning the same output value for different input values. The hash function can be used to map a set of input values to a smaller range of output values, for example, by performing a modulo operation on the returned hash value and the size of the desired range. In cases where there may be patterns in the input values (such as all even numbers), a more even distribution of output values may be possible by using a prime number as the modulus.

The current hash function uses the C++ standard library std::tr1::hash function.

Parameters:

v Value.

Returns:: Hash of the value.

template<class T >

SPL::list<SPL::uint64> SPL::Functions::Utility::hashCodeForEach ( const SPL::list< T > & l )

inline

Compute hashes of a list of values, using the same hashing method as hashCode().

Parameters:

l List of values.

Returns:: List of the hashes of the values.

template<class T , int32_t N>

SPL::list<SPL::uint64> SPL::Functions::Utility::hashCodeForEach ( const SPL::blist< T, N > & l )

inline

Compute hashes of a list of values, using the same hashing method as hashCode().

Parameters:

l List of values.

Returns:: List of the hashes of the values.

SPL::rstring SPL::Functions::Utility::dataDirectory ( )

inline

Miscellaneous.

Return the absolute pathname to the data directory for the Processing Element.

Returns:: Data directory (absolute path).

template<class T >

void SPL::Functions::Utility::swap ( T & s1,

T & s2

)

Swap any two SPL values

Parameters:

s1 Value to swap.

s2 Value to swap.

SPL::rstring SPL::Functions::Utility::mktemp ( const SPL::rstring & templat )

Return the name of a temporary file created using a template. The POSIX mkstemp function is used to create the file, and the file is closed.

Parameters:

templat A pathname for the temporary file. The last six characters of templat must be "XXXXXX".

Returns:: The generated temporary file, or the empty string if there were errors. Note that since the file is closed before returning, there is a brief window that another process might use to create the same file.

SPL::uint64 SPL::Functions::Utility::jobID ( )

inline

Return the Job ID for the current job that this operator is executing in.

Returns:: The job ID for the current job.

SPL::rstring SPL::Functions::Utility::getJobName ( )

inline

Return the name of the current job that this operator is executing in.

Returns:: The name of the current job.

SPL::rstring SPL::Functions::Utility::getJobGroup ( )

inline

Return the name of the job group for the current job that this operator is executing in.

Returns:: The name of the job group.

SPL::rstring SPL::Functions::Utility::getApplicationName ( )

inline

Return the name of the application that is executing this operator.

Returns:: The name of the application.

SPL::uint64 SPL::Functions::Utility::PEID ( )

inline

Return the PE ID for the current processing element that this operator is executing in.

Returns:: The PE ID for the current processing element.

SPL::rstring SPL::Functions::Utility::instanceID ( )

inline

Return the instance ID that the PE is running in.

Returns:: The instance ID for the current processing element (username if running standalone).

SPL::rstring SPL::Functions::Utility::domainID ( )

inline

Return the domain ID that the PE is running in.

Returns:: The domain ID for the current processing element (username if running standalone).

SPL::uint32 SPL::Functions::Utility::getRelaunchCount ( )

inline

Return the number of times the PE that the operator is executing in has been relaunched.

Returns:: The relaunch count of the PE.

SPL::boolean SPL::Functions::Utility::isControlInputPort ( uint32 port )

Check if the input port is a control port.

Parameters:

port Input port index.

Returns:: The value 'true' if the port is a control port, 'false' otherwise.

SPL::boolean SPL::Functions::Utility::isConsistentInputPort ( uint32 port )

Check if the input port is consistent. An input port is consistent if all its input streams are produced by operators that belong to the same consistent region.

Parameters:

port Input port index.

Returns:: The value 'true' if the input port is consistent, 'false' otherwise.

SPL::boolean SPL::Functions::Utility::isInConsistentRegion ( )

Check if the operator is in a consistent region.

Returns:: The value 'true' if the operator is in a consistent region, 'false' otherwise.

SPL::boolean SPL::Functions::Utility::isStartOfConsistentRegion ( )

Check if the operator is a start operator of a consistent region.

Returns:: The value 'true' if the operator is a start operator of a consistent region, 'false' otherwise.

SPL::boolean SPL::Functions::Utility::isEndOfConsistentRegion ( )

Check if the operator is an end operator of a consistent region.

Returns:: The value 'true' if the operator is an end operator in a consistent region, 'false' otherwise.

SPL::boolean SPL::Functions::Utility::isTriggerOfConsistentRegion ( )

Check if the operator the trigger operator of an operator-driven consistent region.

Returns:: The value 'true' if the operator is the trigger operator of a consistent region, 'false' otherwise.

SPL::int32 SPL::Functions::Utility::getConsistentRegionIndex ( )

Gets the index of the consistent region.

Returns:: Index of the consistent region, or -1 if the operator is not in a consistent region.

SPL::int64 SPL::Functions::Utility::getSequenceId ( )

Gets the current sequence identifier of a consistent region. It indicates the id that a drain or a reset should be associated to. After operator startup, this function returns 1. On operator restart, the function returns -1 until it has reset.

Returns:: The current sequence id of a drain or reset, or -1 if the operator is not in a consistent region or has not yet reset after an operator restart.

SPL::float64 SPL::Functions::Utility::getDrainTimeout ( )

Gets the drain timeout of a consistent region.

Returns:: The drain timeout, or -1 if the operator is not in a consistent region.

SPL::float64 SPL::Functions::Utility::getResetTimeout ( )

Gets the reset timeout of a consistent region.

Returns:: The reset timeout, or -1 if the operator is not in a consistent region.

SPL::int32 SPL::Functions::Utility::getResetAttempt ( )

If the operator is in a consistent region, this function returns the retry attempt of resetting the consistent region to a consistent state. If resetting, returns the current reset attempt. If not, this function returns the retry attempt of the last reset.

Returns:: Reset retry attempt, or -1 if the operator is not in a consistent region or has not yet reset after an operator restart.

void SPL::Functions::Utility::resetConsistentRegion ( )

This function requests the ConsistentRegionControllerMXBean to restore the consistent region to the last established consistent state. This function can be used by operators when detecting an operator-specific transient failure. If the region is already being reset, a new reset attempt is triggered. If the operator is not in a consistent region, this function has no effect.

SPL::boolean SPL::Functions::Utility::evalPredicate ( const SPL::rstring & splExpr,

const Tuple & tuple,

SPL::int32 & error

)

Evaluates the SPL predicate, represented as an rstring, using the given tuple. The predicate has the same limitations as the 'filter' parameter to the Import operator.

Returns:: Value of evaluating the expression.

Parameters:

splExpr SPL predicate expression to evaluate, in rstring form.

tup The tuple to use in the evaluation.

error 0 for success, greater than 0 indicates error parsing and/or evaluating splExpr against tuple.

SPL::rstring SPL::Functions::Utility::getHostName ( )

Get the host name.

Returns:: Full host name (with the domain) of the node running this operator as returned by the system call gethostname().

Exceptions:

SPLRuntimeException If unsuccessful.

SPL::rstring SPL::Functions::Utility::getShortHostName ( )

inline

Get the short host name.

Returns:: Short host name (without the domain) of the node running this operator.

Exceptions:

SPLRuntimeException If unsuccessful.

SPL::rstring SPL::Functions::Utility::getConfiguredHostName ( )

Get the hostname used by the streams instance for this host. This returns the full hostname (with domain) for the interface configured for use by the streams instance for this host. This may differ from the IP address for the name returned from getHostName() if there are multiple network interfaces on this host.

Returns:: The hostname for the configured streams interface for this host representation.

Exceptions:

SPLRuntimeException If unsuccessful.

SPL::rstring SPL::Functions::Utility::getIPAddress ( )

Get the IP address for the current host.

Returns:: IP address in rstring representation.

SPL::int32 SPL::Functions::Utility::getOutputPortExportProperties ( List & properties,

uint32 port

)

Get the export properties for an exported output port.

Parameters:

properties Output list of tuple<rstring name, rstring value, rstring typ> representing the current output properties for this export port. 'name' is the name of the property. 'value' is a literal value of the correct type. 'typ' is one of: int64/float64/rstring/list<int64>/list<float64>/list<rstring>.

port Port number of the export port.

Returns:: Error return code: 0 for success, 1 for invalid or not exported port.

SPL::int32 SPL::Functions::Utility::setOutputPortExportProperties ( const List & properties,

uint32 port

)

Set the export properties for an exported output port.

Parameters:

properties List of tuple<rstring name, rstring value, rstring typ> representing output properties for this export port. 'name' is the name of the property. 'value' is a literal value of the correct type. For string literals, the value must be in double quotes. 'typ' is one of: int64/float64/rstring/list<int64>/list<float64>/list<rstring>.

port Port number to be changed.

Returns:: Error return code: 0 for success, 1 for invalid or not exported port, 2 for invalid properties, 3 for set properties failed.

Note:: Example: setOutputPortExportProperties([{name = "a", value = "\"string value"", typ = "rstring"}], 0u);

SPL::int32 SPL::Functions::Utility::setOutputPortExportProperties ( const Tuple & properties,

uint32 port

)

Set the export properties for an exported output port.

Parameters:

properties Tuple representing output properties for this export port.

port Port number to be changed.

Returns:: Error return code: 0 for success, 1 for invalid or not exported port, 2 for invalid types in properties tuple, 3 for set properties failed.

Note:: Example: setOutputPortExportProperties({a = "hi", b = [ 4l, -8l]}, 0u);

SPL::rstring SPL::Functions::Utility::getInputPortImportSubscription ( uint32 port,

SPL::int32 & error

)

Get the import subscription for an imported input port.

Parameters:

port Port number of the imported port.

error Return code: 0 for success, 1 for invalid or not imported imported by subscription input port.

Returns:: Subscription for imported port, or empty string if error.

SPL::int32 SPL::Functions::Utility::setInputPortImportSubscription ( const SPL::rstring & subscription,

uint32 port

)

Set the import subscription for an imported input port.

Parameters:

subscription String representing import subscription for this import port.

port Port number to be changed.

Returns:: Error return code: 0 for success, 1 for invalid or not imported imported by subscription input port, 2 for invalid subscription expression, 3 for set of subscription failed.

SPL::rstring SPL::Functions::Utility::getInputPortImportFilterExpression ( uint32 port,

SPL::int32 & error

)

Get the filter expression for an imported input port.

Parameters:

port Port number of the imported port.

error Return code: 0 for success, 1 for invalid or not imported imported by subscription input port.

Returns:: Filter expression for imported port, or empty string if the filter expression is empty or on error.

SPL::int32 SPL::Functions::Utility::setInputPortImportFilterExpression ( const SPL::rstring & filter,

uint32 port

)

Set the filter expression for an imported input port.

Parameters:

filter String representing filter expression for this import port. An empty filter string removes the filter.

port Port number to be changed.

Returns:: Error return code: 0 for success, 1 for invalid or not imported imported by subscription input port, 2 for invalid filter expression, 3 for set of filter expression failed.

SPL::rstring SPL::Functions::Utility::loadAndFormatResource ( const SPL::rstring & toolkitName,

const SPL::rstring & bundleName,

const SPL::rstring & resourceID,

const Tuple & substitutionValues

)

Loads and formats a string from a toolkit resource. The execution locale is used.

Parameters:

toolkitName The name of the toolkit that owns the resource.

bundleName The name of the resource bundle within the toolkit.

resourceID The ID of the resource to load.

substitutionValues A tuple containing substitution values. Note that the type and value of the attributes in the tuple are important. The name is used only for error reporting.

Returns:: The formatted string.

Exceptions:

SPLRuntimeUnsupportedSubstitutionTypeException If the type of a substitution variable is not supported.

SPL::rstring SPL::Functions::Utility::loadAndFormatResource ( const SPL::rstring & toolkitName,

const SPL::rstring & bundleName,

const SPL::rstring & resourceID,

const Tuple & substitutionValues,

const SPL::rstring & locale

)

Loads and formats a string from a toolkit resource.

Parameters:

toolkitName The name of the toolkit that owns the resource.

bundleName The name of the resource bundle within the toolkit.

resourceID The ID of the resource to load.

substitutionValues A tuple containing substitution values. Note that the type and value of the attributes in the tuple are important. The name is used only for error reporting.

locale The locale the message should be formatted in. It should be something like en_US.UTF-8.

Returns:: The formatted string.

Exceptions:

SPLRuntimeUnsupportedSubstitutionTypeException If the type of a substitution variable is not supported.

SPL::rstring SPL::Functions::Utility::loadAndFormatResource ( const SPL::rstring & toolkitName,

const SPL::rstring & bundleName,

const SPL::rstring & resourceID

)

Loads a string from a toolkit resource. The execution locale is used.

Parameters:

toolkitName The name of the toolkit that owns the resource.

bundleName The name of the resource bundle within the toolkit.

resourceID The ID of the resource to load.

Returns:: The requested string.

SPL::rstring SPL::Functions::Utility::loadAndFormatResource ( const SPL::rstring & toolkitName,

const SPL::rstring & bundleName,

const SPL::rstring & resourceID,

const SPL::rstring & locale

)

Loads a string from a toolkit resource.

Parameters:

toolkitName The name of the toolkit that owns the resource.

bundleName The name of the resource bundle within the toolkit.

resourceID The ID of the resource to load.

locale The locale the message should be formatted in. It should be something like en_US.UTF-8.

Returns:: The requested string.

SPL::int32 SPL::Functions::Utility::getPEOutputPortConnections ( uint32 port,

SPL::List & connections

)

Return the connection information for an output port that connects to another PE.

Parameters:

port Port number.

connections Output list of information for each output connection.

Returns:: Error return code: 0 for success, -1 for invalid port, -2 for invalid argument.

Note:: Example: mutable Sys.PEConnections conns; int32 ret = getPEOutputPortConnections(0, conns);

SPL::int32 SPL::Functions::Utility::getOutputPortCongestionFactor ( uint32 port )

Return the maximum congestion factor for all connections from an output port that connects to another PE.

Parameters:

port Port number.

Returns:: -1 for invalid port or 0..100 congestion factor.

Note:: Example: int32 maxCongestionFactor = getOutputPortCongestionFactor(0);