Class that represents a processing element. More...

#include <SPL/Runtime/ProcessingElement/ProcessingElement.h>

Classes

class OutputConnection

Public Member Functions

virtual bool hasDataDirectory () const =0

Determines if a data directory was specified at compile or submission time. More...

virtual const std::string & getDataDirectory () const =0

Returns the path to the data directory of the SPL application. More...

virtual const std::string & getCheckpointDirectory () const =0

Returns the path to the checkpointing directory of the PE. More...

virtual const std::string & getApplicationScope () const =0

Returns the application scope for the job the PE is running in. More...

virtual const std::string & getApplicationDirectory () const =0

Returns the path to the SPL application directory. More...

virtual const std::string & getOutputDirectory () const =0

Returns the path to the SPL application output directory. More...

virtual std::string getToolkitDirectory () const =0

Returns the absolute path of the toolkit containing the operator for this PE. More...

virtual std::string getToolkitDirectory (const std::string &toolkitName) const =0

Returns the absolute path of the specified toolkit. More...

virtual uint64_t getPEId () const =0

Returns the runtime identifier for this PE. More...

virtual uint64_t getJobId () const =0

Returns the runtime identifier for the job containing this PE. More...

virtual uint32_t getRelaunchCount () const =0

Returns the number of times this PE has been relaunched. For the first. execution, the value will be 0. More...

virtual uint32_t getNumberOfInputPorts () const =0

Returns the number of inputs for this PE. More...

virtual uint32_t getNumberOfOutputPorts () const =0

Returns the number of outputs for this PE. More...

virtual bool isStandalone () const =0

Checks if the PE is running in standalone mode. More...

virtual bool isOptimized () const =0

Checks if the PE is running under optimized mode. More...

virtual bool isInFusedMode () const =0

Checks if the PE is running under fused mode. More...

virtual bool isInDebugMode () const =0

Checks if the PE is running under debug mode. More...

virtual bool getShutdownRequested () const =0

Checks if shutdown was requested. More...

virtual void blockUntilShutdownRequest () const =0

Blocks until shutdown is requested. More...

virtual bool blockUntilShutdownRequest (const timespec &absTime) const =0

Blocks until shutdown is requested. More...

virtual bool blockUntilShutdownRequest (const double timeInSeconds) const =0

Blocks until shutdown is requested. More...

virtual PEMetrics & getMetrics ()=0

Returns the PE metrics. More...

virtual std::string getInstanceID () const =0

Returns the instance ID for the current processing element. More...

virtual bool getOutputPortConnections (uint32_t port, std::vector< OutputConnection > &connections) const =0

Returns the connection and congestion information for a PE output port. More...

virtual int getOutputPortCongestionFactor (uint32_t port) const =0

Returns the congestion factor for a PE output port. More...

virtual JavaVM * getJavaVM () const =0

Returns the Java virtual machine. More...

virtual ControlPlaneConnectorPtr getControlPlaneConnector () const =0

Returns a connector to the control plane of the current job. More...

virtual std::string getDomainID () const =0

Returns the domain ID for the current processing element. More...

virtual std::string getApplicationName () const =0

Returns the name of the SPL application the PE is running. More...

virtual std::string getJobGroup () const =0

Returns the name of the job group for the job the processing element is running in. More...

virtual std::string getJobName () const =0

Returns the name of the job the processing element is running in. More...

virtual int32_t getApplicationConfiguration (std::string const &configName, std::map< std::string, std::string > &properties)=0

Returns the application configuration for the given name. More...

virtual std::string getApplicationConfigurationProperty (std::string const &configName, std::string const &propertyName, int32_t *errorCode=nullptr)=0

Returns the value associated with the given configuration property propertyName from the configuration identified by configName. More...

virtual int getOperatorRelativeCost (uint32_t index) const =0

Static Public Member Functions

static ProcessingElement & pe ()

Returns the current PE. More...

Detailed Description

Class that represents a processing element.

Member Function Documentation

◆ hasDataDirectory()

virtual bool SPL::ProcessingElement::hasDataDirectory ( ) const

pure virtual

Determines if a data directory was specified at compile or submission time.

Returns: Returns true if a data directory was specified, otherwise false.

◆ getDataDirectory()

virtual const std::string& SPL::ProcessingElement::getDataDirectory ( ) const

pure virtual

Returns the path to the data directory of the SPL application.

Returns: working directory of the PE

◆ getCheckpointDirectory()

virtual const std::string& SPL::ProcessingElement::getCheckpointDirectory ( ) const

pure virtual

Returns the path to the checkpointing directory of the PE.

Returns: checkpointing directory of the PE

: Deprecated:; The new checkpoint API no longer uses this API or the related –checkpoint-directory compiler option.

◆ getApplicationScope()

virtual const std::string& SPL::ProcessingElement::getApplicationScope ( ) const

pure virtual

Returns the application scope for the job the PE is running in.

Returns: application scope

◆ getApplicationDirectory()

virtual const std::string& SPL::ProcessingElement::getApplicationDirectory ( ) const

pure virtual

Returns the path to the SPL application directory.

Returns: application directory

◆ getOutputDirectory()

virtual const std::string& SPL::ProcessingElement::getOutputDirectory ( ) const

pure virtual

Returns the path to the SPL application output directory.

Returns: application output directory

◆ getToolkitDirectory() [1/2]

virtual std::string SPL::ProcessingElement::getToolkitDirectory ( ) const

pure virtual

Returns the absolute path of the toolkit containing the operator for this PE.

Returns: returns the toolkit directory

◆ getToolkitDirectory() [2/2]

virtual std::string SPL::ProcessingElement::getToolkitDirectory ( const std::string & toolkitName ) const

pure virtual

Returns the absolute path of the specified toolkit.

Parameters

toolkitName name of the toolkit to return a path to

Returns: returns the toolkit directory

◆ getPEId()

virtual uint64_t SPL::ProcessingElement::getPEId ( ) const

pure virtual

Returns the runtime identifier for this PE.

Returns: runtime identifier for this PE

◆ getJobId()

virtual uint64_t SPL::ProcessingElement::getJobId ( ) const

pure virtual

Returns the runtime identifier for the job containing this PE.

Returns: runtime identifier for the job containing this PE

◆ getRelaunchCount()

virtual uint32_t SPL::ProcessingElement::getRelaunchCount ( ) const

pure virtual

Returns the number of times this PE has been relaunched. For the first. execution, the value will be 0.

Returns: the relaunch count

◆ getNumberOfInputPorts()

virtual uint32_t SPL::ProcessingElement::getNumberOfInputPorts ( ) const

pure virtual

Returns the number of inputs for this PE.

Returns: the number of inputs for this PE

◆ getNumberOfOutputPorts()

virtual uint32_t SPL::ProcessingElement::getNumberOfOutputPorts ( ) const

pure virtual

Returns the number of outputs for this PE.

Returns: the number of outputs for this PE

◆ isStandalone()

virtual bool SPL::ProcessingElement::isStandalone ( ) const

pure virtual

Checks if the PE is running in standalone mode.

Returns: true if running in standalone mode, false otherwise

◆ isOptimized()

virtual bool SPL::ProcessingElement::isOptimized ( ) const

pure virtual

Checks if the PE is running under optimized mode.

Returns: true if running in optimized mode, false otherwise

◆ isInFusedMode()

virtual bool SPL::ProcessingElement::isInFusedMode ( ) const

pure virtual

Checks if the PE is running under fused mode.

Returns: true if running in fused mode, false otherwise

◆ isInDebugMode()

virtual bool SPL::ProcessingElement::isInDebugMode ( ) const

pure virtual

Checks if the PE is running under debug mode.

Returns: true if running in debug mode, false otherwise

◆ getShutdownRequested()

virtual bool SPL::ProcessingElement::getShutdownRequested ( ) const

pure virtual

Checks if shutdown was requested.

Returns: true if shutdown was requested, false otherwise

◆ blockUntilShutdownRequest() [1/3]

virtual void SPL::ProcessingElement::blockUntilShutdownRequest ( ) const

pure virtual

Blocks until shutdown is requested.

Returns: void

◆ blockUntilShutdownRequest() [2/3]

virtual bool SPL::ProcessingElement::blockUntilShutdownRequest ( const timespec & absTime ) const

pure virtual

Blocks until shutdown is requested.

Parameters

absTime absolute time to wait until if shutdown is not requested

Returns: true if unblocked due to the shutdown request, false otherwise

◆ blockUntilShutdownRequest() [3/3]

virtual bool SPL::ProcessingElement::blockUntilShutdownRequest ( const double timeInSeconds ) const

pure virtual

Blocks until shutdown is requested.

Parameters

timeInSeconds maximum wait time in seconds (could be fractional) if shutdown is not requested

Returns: true if unblocked due to the shutdown request, false otherwise

◆ getMetrics()

virtual PEMetrics& SPL::ProcessingElement::getMetrics ( )

pure virtual

Returns the PE metrics.

Returns: PE metrics

◆ pe()

static ProcessingElement& SPL::ProcessingElement::pe ( )

static

Returns the current PE.

Returns: the ProcessingElement for the current process

◆ getInstanceID()

virtual std::string SPL::ProcessingElement::getInstanceID ( ) const

pure virtual

Returns the instance ID for the current processing element.

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

◆ getOutputPortConnections()

virtual bool SPL::ProcessingElement::getOutputPortConnections ( uint32_t port,

std::vector< OutputConnection > & connections

) const

pure virtual

Returns the connection and congestion information for a PE output port.

Parameters

port the output port number

connections output connection information

Returns: 'true' for success, 'false' for invalid port number

◆ getOutputPortCongestionFactor()

virtual int SPL::ProcessingElement::getOutputPortCongestionFactor ( uint32_t port ) const

pure virtual

Returns the congestion factor for a PE output port.

Parameters

port the output port number

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

◆ getJavaVM()

virtual JavaVM* SPL::ProcessingElement::getJavaVM ( ) const

pure virtual

Returns the Java virtual machine.

Returns: NULL if no JVM, or the pointer to the created JVM

◆ getControlPlaneConnector()

virtual ControlPlaneConnectorPtr SPL::ProcessingElement::getControlPlaneConnector ( ) const

pure virtual

Returns a connector to the control plane of the current job.

Returns: shared pointer to the connector with the Job Control Plane.

◆ getDomainID()

virtual std::string SPL::ProcessingElement::getDomainID ( ) const

pure virtual

Returns the domain ID for the current processing element.

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

◆ getApplicationName()

virtual std::string SPL::ProcessingElement::getApplicationName ( ) const

pure virtual

Returns the name of the SPL application the PE is running.

Returns: application name

Since: InfoSphere® Streams Version 4.1

◆ getJobGroup()

virtual std::string SPL::ProcessingElement::getJobGroup ( ) const

pure virtual

Returns the name of the job group for the job the processing element is running in.

Returns: job group name

Since: InfoSphere® Streams Version 4.1

◆ getJobName()

virtual std::string SPL::ProcessingElement::getJobName ( ) const

pure virtual

Returns the name of the job the processing element is running in.

Returns: name for the job the processing element is running in

Since: InfoSphere® Streams Version 4.0.1

◆ getApplicationConfiguration()

virtual int32_t SPL::ProcessingElement::getApplicationConfiguration ( std::string const & configName,

std::map< std::string, std::string > & properties

)

pure virtual

Returns the application configuration for the given name.

The application configuration is a set of properties where each key and its value in the property set is a string. This method copies all the properties from the specified configuration into the properties output map.

Parameters

configName Application configuration name.

[out] properties Output map where the configuration properties are to be inserted.

Returns: 0 if the configuration specified by name was found, otherwise -1.

Since: IBM Streams Version 4.2.0.

◆ getApplicationConfigurationProperty()

virtual std::string SPL::ProcessingElement::getApplicationConfigurationProperty ( std::string const & configName,

std::string const & propertyName,

int32_t * errorCode = nullptr

)

pure virtual

Returns the value associated with the given configuration property propertyName from the configuration identified by configName.

An empty string is returned if there is no value associated with the propertyName, or if the configuration does not exist.

Parameters

configName Application configuration name.

propertyName Configuration property name.

[out] errorCode Pointer to an output error code value. If the pointer is not null, the value is set to 0 for success, -1 if the configuration could not be found, -2 if the configuration property could not be found.

Returns: The value associated with the property name or an empty string if there is no value associated with the propertyName or if the configuration does not exist.

Since: IBM Streams Version 4.2.0.

◆ getOperatorRelativeCost()

virtual int SPL::ProcessingElement::getOperatorRelativeCost ( uint32_t index ) const

pure virtual

Return the relative operator metric for the current operator

Returns: 0..100 for relative operator metric

Since: IBM Streams Version 4.2.3.0.

The documentation for this class was generated from the following file:

SPL/Runtime/ProcessingElement/ProcessingElement.h