UtilFunctions.h File Reference

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

#include <SPL/Runtime/Type/SPLType.h>
#include <SPL/Runtime/ProcessingElement/ProcessingElement.h>
#include <errno.h>

Namespaces
	SPL::Functions::Utility
	C++ counterparts of SPL native functions that provide general utilities.
	SPL
	C++ classes for writing operators.
	SPL::Functions
	C++ counterparts of SPL native functions.

Functions
void	SPL::Functions::Utility::abort (const std::string &file, uint32_t line)
SPL::boolean	SPL::Functions::Utility::isTraceable (const Enum &traceLevel)
void	SPL::Functions::Utility::appTrc (const Enum &traceLevel, const std::string &message, const std::string &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appTrc (const Enum &traceLevel, const SPL::ustring &message, const SPL::ustring &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appTrc (const Enum &traceLevel, const SPL::BString &message, const SPL::BString &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appTrc (const Enum &traceLevel, const SPL::rstring &message, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appTrc (const Enum &traceLevel, const SPL::ustring &message, const std::string &file, uint32_t line)
SPL::boolean	SPL::Functions::Utility::isLoggable (const Enum &logLevel)
void	SPL::Functions::Utility::appLog (const Enum &logLevel, const std::string &message, const std::string &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appLog (const Enum &logLevel, const SPL::ustring &message, const SPL::ustring &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appLog (const Enum &logLevel, const SPL::BString &message, const SPL::BString &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appLog (const Enum &logLevel, const SPL::rstring &message, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::appLog (const Enum &logLevel, const SPL::ustring &message, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::log (const Enum &logLevel, const std::string &message, const std::string &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::log (const Enum &logLevel, const SPL::ustring &message, const SPL::ustring &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::log (const Enum &logLevel, const SPL::BString &message, const SPL::BString &aspect, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::log (const Enum &logLevel, const SPL::rstring &message, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::log (const Enum &logLevel, const SPL::ustring &message, const std::string &file, uint32_t line)
void	SPL::Functions::Utility::shutdownPE ()
	Shutdown the current processing element (PE). More...
SPL::boolean	SPL::Functions::Utility::isShutdown ()
void	SPL::Functions::Utility::block (double const time)
SPL::int32	SPL::Functions::Utility::getChannel ()
SPL::int32	SPL::Functions::Utility::getLocalChannel ()
SPL::list< SPL::int32 >	SPL::Functions::Utility::getAllChannels ()
SPL::int32	SPL::Functions::Utility::getMaxChannels ()
SPL::int32	SPL::Functions::Utility::getLocalMaxChannels ()
SPL::list< SPL::int32 >	SPL::Functions::Utility::getAllMaxChannels ()
SPL::rstring	SPL::Functions::Utility::getThisOperatorName ()
SPL::rstring	SPL::Functions::Utility::getThisOperatorLogicalName ()
SPL::rstring	SPL::Functions::Utility::getEnvironmentVariable (SPL::rstring const &name)
SPL::rstring	SPL::Functions::Utility::getEnvironmentVariable (SPL::rstring const &name, SPL::rstring const &defaultValue)
SPL::rstring	SPL::Functions::Utility::getEnvironmentVariable (SPL::rstring const &name, SPL::boolean &isSet)
void	SPL::Functions::Utility::getInputPortMetricValue (SPL::uint32 port, int name, SPL::int64 &value)
void	SPL::Functions::Utility::getInputPortMetricValue (SPL::uint32 port, const SPL::Enum &name, SPL::int64 &value)
void	SPL::Functions::Utility::getOutputPortMetricValue (SPL::uint32 port, int name, SPL::int64 &value)
void	SPL::Functions::Utility::getOutputPortMetricValue (SPL::uint32 port, const SPL::Enum &name, SPL::int64 &value)
void	SPL::Functions::Utility::getExceptionPortMetricValue (SPL::uint32 port, int name, SPL::int64 &value)
void	SPL::Functions::Utility::getExceptionPortMetricValue (SPL::uint32 port, const SPL::Enum &name, SPL::int64 &value)
void	SPL::Functions::Utility::getOperatorMetricValue (int name, SPL::int64 &value)
void	SPL::Functions::Utility::getOperatorMetricValue (const SPL::Enum &name, SPL::int64 &value)
void	SPL::Functions::Utility::getCustomMetricValue (SPL::rstring const &name, SPL::int64 &value)
void	SPL::Functions::Utility::getCustomMetricValue (SPL::ustring const &name, SPL::int64 &value)
void	SPL::Functions::Utility::setCustomMetricValue (SPL::rstring const &name, SPL::int64 value)
void	SPL::Functions::Utility::setCustomMetricValue (SPL::ustring const &name, SPL::int64 value)
void	SPL::Functions::Utility::createCustomMetric (SPL::rstring const &name, SPL::rstring const &description, const Enum &kind, SPL::int64 value)
void	SPL::Functions::Utility::createCustomMetric (SPL::ustring const &name, SPL::ustring const &description, const Enum &kind, SPL::int64 value)
bool	SPL::Functions::Utility::hasCustomMetric (SPL::rstring const &name)
bool	SPL::Functions::Utility::hasCustomMetric (SPL::ustring const &name)
SPL::list< SPL::rstring >	SPL::Functions::Utility::getCustomMetricNames ()
SPL::rstring	SPL::Functions::Utility::formatNumber (const SPL::int64 value)
SPL::rstring	SPL::Functions::Utility::formatNumber (const SPL::int64 value, SPL::uint32 width)
SPL::rstring	SPL::Functions::Utility::formatNumber (const SPL::float64 value)
SPL::rstring	SPL::Functions::Utility::formatNumber (const SPL::float64 value, SPL::uint32 width, SPL::uint32 precision, bool scientific)
SPL::int32	SPL::Functions::Utility::parseNumber (SPL::int64 &number, SPL::rstring const &text, SPL::int32 base)
SPL::int32	SPL::Functions::Utility::parseNumber (SPL::int64 &number, SPL::rstring const &text)
SPL::int32	SPL::Functions::Utility::parseNumber (SPL::int64 &number, SPL::ustring const &text)
SPL::int32	SPL::Functions::Utility::parseNumber (SPL::float64 &number, SPL::rstring const &text)
SPL::int32	SPL::Functions::Utility::parseNumber (SPL::float64 &number, SPL::ustring const &text)
SPL::rstring	SPL::Functions::Utility::strerror (const SPL::int32 errnum)
SPL::uint64	SPL::Functions::Utility::strtoull (const SPL::rstring &value, SPL::int32 base)
SPL::uint64	SPL::Functions::Utility::strtoull (const SPL::rstring &value, SPL::int32 base, SPL::int32 &numCharsProcessed)
SPL::int64	SPL::Functions::Utility::strtoll (const SPL::rstring &value, SPL::int32 base)
SPL::int64	SPL::Functions::Utility::strtoll (const SPL::rstring &value, SPL::int32 base, SPL::int32 &numCharsProcessed)
SPL::float64	SPL::Functions::Utility::strtod (const SPL::rstring &value)
SPL::float64	SPL::Functions::Utility::strtod (const SPL::rstring &value, SPL::int32 &numCharsProcessed)
template<class T >
void	SPL::Functions::Utility::print (const T &t)
void	SPL::Functions::Utility::printStringLn (const SPL::rstring &s)
void	SPL::Functions::Utility::printStringLn (const SPL::BString &s)
void	SPL::Functions::Utility::printStringLn (const SPL::ustring &s)
void	SPL::Functions::Utility::printString (const SPL::rstring &s)
void	SPL::Functions::Utility::printString (const SPL::BString &s)
void	SPL::Functions::Utility::printString (const SPL::ustring &s)
template<class T >
void	SPL::Functions::Utility::println (const T &t)
void	SPL::Functions::Utility::flushStdio ()
void	SPL::Functions::Utility::assignFrom (SPL::Tuple &lhs, SPL::Tuple const &rhs)
template<class T >
SPL::uint64	SPL::Functions::Utility::hashCode (const T &v)
template<class T >
SPL::list< SPL::uint64 >	SPL::Functions::Utility::hashCodeForEach (const SPL::list< T > &l)
template<class T , int32_t N>
SPL::list< SPL::uint64 >	SPL::Functions::Utility::hashCodeForEach (const SPL::blist< T, N > &l)
SPL::rstring	SPL::Functions::Utility::dataDirectory ()
	Miscellaneous. More...
template<class T >
void	SPL::Functions::Utility::swap (T &s1, T &s2)
SPL::rstring	SPL::Functions::Utility::mktemp (const SPL::rstring &templat)
SPL::uint64	SPL::Functions::Utility::jobID ()
SPL::rstring	SPL::Functions::Utility::getJobName ()
SPL::rstring	SPL::Functions::Utility::getJobGroup ()
SPL::rstring	SPL::Functions::Utility::getApplicationName ()
SPL::uint64	SPL::Functions::Utility::PEID ()
SPL::rstring	SPL::Functions::Utility::instanceID ()
SPL::rstring	SPL::Functions::Utility::domainID ()
SPL::uint32	SPL::Functions::Utility::getRelaunchCount ()
SPL::boolean	SPL::Functions::Utility::isControlInputPort (uint32 port)
SPL::boolean	SPL::Functions::Utility::isConsistentInputPort (uint32 port)
SPL::boolean	SPL::Functions::Utility::isInConsistentRegion ()
SPL::boolean	SPL::Functions::Utility::isStartOfConsistentRegion ()
SPL::boolean	SPL::Functions::Utility::isEndOfConsistentRegion ()
SPL::boolean	SPL::Functions::Utility::isTriggerOfConsistentRegion ()
SPL::int32	SPL::Functions::Utility::getConsistentRegionIndex ()
SPL::int64	SPL::Functions::Utility::getSequenceId ()
SPL::float64	SPL::Functions::Utility::getDrainTimeout ()
SPL::float64	SPL::Functions::Utility::getResetTimeout ()
SPL::int32	SPL::Functions::Utility::getResetAttempt ()
void	SPL::Functions::Utility::resetConsistentRegion ()
SPL::boolean	SPL::Functions::Utility::evalPredicate (const SPL::rstring &splExpr, const Tuple &tuple, SPL::int32 &error)
SPL::rstring	SPL::Functions::Utility::getHostName ()
SPL::rstring	SPL::Functions::Utility::getShortHostName ()
SPL::rstring	SPL::Functions::Utility::getConfiguredHostName ()
SPL::rstring	SPL::Functions::Utility::getIPAddress ()
SPL::int32	SPL::Functions::Utility::getApplicationConfiguration (SPL::map< SPL::rstring, SPL::rstring > &properties, SPL::rstring const &name)
SPL::rstring	SPL::Functions::Utility::getApplicationConfigurationProperty (SPL::rstring const &configName, SPL::rstring const &propertyName, SPL::rstring const &defaultValue)
SPL::rstring	SPL::Functions::Utility::getApplicationConfigurationProperty (SPL::rstring const &configName, SPL::rstring const &propertyName, SPL::int32 &errorCode)
SPL::int32	SPL::Functions::Utility::getOutputPortExportProperties (List &properties, uint32 port)
SPL::int32	SPL::Functions::Utility::getExceptionPortExportProperties (List &properties, uint32 port)
SPL::int32	SPL::Functions::Utility::setOutputPortExportProperties (const List &properties, uint32 port)
SPL::int32	SPL::Functions::Utility::setExceptionPortExportProperties (const List &properties, uint32 port)
SPL::int32	SPL::Functions::Utility::setOutputPortExportProperties (const Tuple &properties, uint32 port)
SPL::int32	SPL::Functions::Utility::setExceptionPortExportProperties (const Tuple &properties, uint32 port)
SPL::rstring	SPL::Functions::Utility::getInputPortImportSubscription (uint32 port, SPL::int32 &error)
SPL::int32	SPL::Functions::Utility::setInputPortImportSubscription (const SPL::rstring &subscription, uint32 port)
SPL::rstring	SPL::Functions::Utility::getInputPortImportFilterExpression (uint32 port, SPL::int32 &error)
SPL::int32	SPL::Functions::Utility::setInputPortImportFilterExpression (const SPL::rstring &filter, uint32 port)
SPL::rstring	SPL::Functions::Utility::loadAndFormatResource (const SPL::rstring &toolkitName, const SPL::rstring &bundleName, const SPL::rstring &resourceID, const Tuple &substitutionValues)
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)
SPL::rstring	SPL::Functions::Utility::loadAndFormatResource (const SPL::rstring &toolkitName, const SPL::rstring &bundleName, const SPL::rstring &resourceID)
SPL::rstring	SPL::Functions::Utility::loadAndFormatResource (const SPL::rstring &toolkitName, const SPL::rstring &bundleName, const SPL::rstring &resourceID, const SPL::rstring &locale)
SPL::int32	SPL::Functions::Utility::getPEOutputPortConnections (uint32 port, SPL::List &connections)
SPL::int32	SPL::Functions::Utility::getOutputPortCongestionFactor (uint32 port)

Detailed Description

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